diff --git a/geant_service_orchestrator/migrations/env.py b/geant_service_orchestrator/migrations/env.py new file mode 100644 index 0000000000000000000000000000000000000000..1b039d7fe43ce29e53e06791acf246d39c1ad88e --- /dev/null +++ b/geant_service_orchestrator/migrations/env.py @@ -0,0 +1,92 @@ +import logging +import os +from alembic import context +from sqlalchemy import engine_from_config, pool + +import orchestrator +from orchestrator.db.database import BaseModel +from orchestrator.settings import app_settings + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +logger = logging.getLogger("alembic.env") + +config.set_main_option("sqlalchemy.url", app_settings.DATABASE_URI) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +target_metadata = BaseModel.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline() -> None: + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, target_metadata=target_metadata, literal_binds=True, dialect_opts={"paramstyle": "named"} + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): # type: ignore + if getattr(config.cmd_opts, "autogenerate", False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info("No changes in schema detected.") + + engine = engine_from_config( + config.get_section(config.config_ini_section), prefix="sqlalchemy.", poolclass=pool.NullPool + ) + + connection = engine.connect() + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + compare_type=True, + ) + try: + with context.begin_transaction(): + context.run_migrations() + finally: + connection.close() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/geant_service_orchestrator/migrations/helpers.py b/geant_service_orchestrator/migrations/helpers.py new file mode 100644 index 0000000000000000000000000000000000000000..c563452661eb495c4ef96d02869714fa4c4e107a --- /dev/null +++ b/geant_service_orchestrator/migrations/helpers.py @@ -0,0 +1,3 @@ +from orchestrator.migrations.helpers import * + +# Write your own helper functions below this line. diff --git a/geant_service_orchestrator/migrations/script.py.mako b/geant_service_orchestrator/migrations/script.py.mako new file mode 100644 index 0000000000000000000000000000000000000000..e1fbdb8f5bae117c3ea2041e7d318b09f312616e --- /dev/null +++ b/geant_service_orchestrator/migrations/script.py.mako @@ -0,0 +1,23 @@ +"""${message}. + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +import sqlalchemy as sa +from alembic import op +${imports if imports else ""} +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"}