env.py 2.7 KB

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