env.py 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. from __future__ import with_statement
  2. from alembic import context
  3. from sqlalchemy import engine_from_config, pool
  4. from logging.config import fileConfig
  5. import logging
  6. # this is the Alembic Config object, which provides
  7. # access to the values within the .ini file in use.
  8. config = context.config
  9. # Interpret the config file for Python logging.
  10. # This line sets up loggers basically.
  11. fileConfig(config.config_file_name)
  12. logger = logging.getLogger('alembic.env')
  13. # add your model's MetaData object here
  14. # for 'autogenerate' support
  15. # from myapp import mymodel
  16. # target_metadata = mymodel.Base.metadata
  17. from flask import current_app
  18. config.set_main_option('sqlalchemy.url',
  19. current_app.config.get('SQLALCHEMY_DATABASE_URI'))
  20. target_metadata = current_app.extensions['migrate'].db.metadata
  21. # other values from the config, defined by the needs of env.py,
  22. # can be acquired:
  23. # my_important_option = config.get_main_option("my_important_option")
  24. # ... etc.
  25. def run_migrations_offline():
  26. """Run migrations in 'offline' mode.
  27. This configures the context with just a URL
  28. and not an Engine, though an Engine is acceptable
  29. here as well. By skipping the Engine creation
  30. we don't even need a DBAPI to be available.
  31. Calls to context.execute() here emit the given string to the
  32. script output.
  33. """
  34. url = config.get_main_option("sqlalchemy.url")
  35. context.configure(url=url)
  36. with context.begin_transaction():
  37. context.run_migrations()
  38. def run_migrations_online():
  39. """Run migrations in 'online' mode.
  40. In this scenario we need to create an Engine
  41. and associate a connection with the context.
  42. """
  43. # this callback is used to prevent an auto-migration from being generated
  44. # when there are no changes to the schema
  45. # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
  46. def process_revision_directives(context, revision, directives):
  47. if getattr(config.cmd_opts, 'autogenerate', False):
  48. script = directives[0]
  49. if script.upgrade_ops.is_empty():
  50. directives[:] = []
  51. logger.info('No changes in schema detected.')
  52. engine = engine_from_config(config.get_section(config.config_ini_section),
  53. prefix='sqlalchemy.',
  54. poolclass=pool.NullPool)
  55. connection = engine.connect()
  56. context.configure(connection=connection,
  57. target_metadata=target_metadata,
  58. process_revision_directives=process_revision_directives,
  59. compare_type=True,
  60. **current_app.extensions['migrate'].configure_args)
  61. try:
  62. with context.begin_transaction():
  63. context.run_migrations()
  64. except Exception as exception:
  65. logger.error(exception)
  66. raise exception
  67. finally:
  68. connection.close()
  69. if context.is_offline_mode():
  70. run_migrations_offline()
  71. else:
  72. run_migrations_online()