Source code for glare.db.migration.migration

# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.

import os

import alembic
from alembic import config as alembic_config
from alembic import migration as alembic_migration

from glare.db.sqlalchemy import api as db_api


[docs]def get_alembic_config(): path = os.path.join(os.path.dirname(__file__), 'alembic.ini') config = alembic_config.Config(path) config.set_main_option('script_location', 'glare.db.migration:alembic_migrations') return config
[docs]def version(engine=None): """Returns current database version.""" engine = engine or db_api.get_engine() with engine.connect() as conn: context = alembic_migration.MigrationContext.configure(conn) return context.get_current_revision()
[docs]def upgrade(revision, config=None): """Used for upgrading database. :param revision: Desired database version :type revision: string """ revision = revision or 'head' config = config or get_alembic_config() alembic.command.upgrade(config, revision or 'head')
[docs]def downgrade(revision, config=None): """Used for downgrading database. :param revision: Desired database version7 :type revision: string """ revision = revision or 'base' config = config or get_alembic_config() return alembic.command.downgrade(config, revision)
[docs]def stamp(revision, config=None): """Stamps database with provided revision. Don't run any migrations. :param revision: Should match one from repository or head - to stamp database with most recent revision :type revision: string """ config = config or get_alembic_config() return alembic.command.stamp(config, revision=revision)
[docs]def revision(message=None, autogenerate=False, config=None): """Creates template for migration. :param message: Text that will be used for migration title :type message: string :param autogenerate: If True - generates diff based on current database state :type autogenerate: bool """ config = config or get_alembic_config() return alembic.command.revision(config, message=message, autogenerate=autogenerate)