b64228a945
Alembic migrations were introduced to Barbican a while ago but have not been used recently. This CR revisits the migration logic and ensures that time-zero database tables creation is distinguished from Alembic-base schema updates. The associated database migration script is also revived, allowing for schema migrations outside of the Barbican boot process. Change-Id: I3e7fd7ac3f629da18329c22ad11cb9ccc1b7f9f9 Implements: blueprint db-revive-migrations
72 lines
2.1 KiB
Python
72 lines
2.1 KiB
Python
"""
|
|
Interace to the Alembic migration process and environment.
|
|
|
|
Concepts in this file are based on Quantum's Alembic approach.
|
|
|
|
Available Alembic commands are detailed here:
|
|
https://alembic.readthedocs.org/en/latest/api.html#module-alembic.command
|
|
"""
|
|
|
|
import os
|
|
|
|
from alembic import command as alembic_command
|
|
from alembic import config as alembic_config
|
|
from oslo.config import cfg
|
|
from barbican.common import utils
|
|
|
|
LOG = utils.getLogger(__name__)
|
|
|
|
|
|
db_opts = [
|
|
cfg.StrOpt('sql_connection', default=None),
|
|
]
|
|
|
|
CONF = cfg.CONF
|
|
CONF.register_opts(db_opts)
|
|
|
|
|
|
def init_config(sql_url=None):
|
|
"""Initialize and return the Alembic configuration."""
|
|
sqlalchemy_url = sql_url or CONF.sql_connection
|
|
if 'sqlite' in sqlalchemy_url:
|
|
LOG.warn('!!! No support for migrating sqlite databases...'
|
|
'skipping migration processing !!!')
|
|
return None
|
|
|
|
config = alembic_config.Config(
|
|
os.path.join(os.path.dirname(__file__), 'alembic.ini')
|
|
)
|
|
config.barbican_sqlalchemy_url = sqlalchemy_url
|
|
config.set_main_option('script_location',
|
|
'barbican.model.migration:alembic_migrations')
|
|
return config
|
|
|
|
|
|
def upgrade(to_version='head', sql_url=None):
|
|
"""Upgrade to the specified version."""
|
|
alembic_cfg = init_config(sql_url)
|
|
if alembic_cfg:
|
|
alembic_command.upgrade(alembic_cfg, to_version)
|
|
|
|
|
|
def downgrade(to_version, sql_url=None):
|
|
"""Downgrade to the specified version."""
|
|
alembic_cfg = init_config(sql_url)
|
|
if alembic_cfg:
|
|
alembic_command.downgrade(alembic_cfg, to_version)
|
|
|
|
|
|
def stamp(to_version='head', sql_url=None):
|
|
"""Stamp the specified version, with no migration performed."""
|
|
alembic_cfg = init_config(sql_url)
|
|
if alembic_cfg:
|
|
alembic_command.stamp(alembic_cfg, to_version)
|
|
|
|
|
|
def generate(autogenerate=True, message='generate changes', sql_url=None):
|
|
"""Generate a version file."""
|
|
alembic_cfg = init_config(sql_url)
|
|
if alembic_cfg:
|
|
alembic_command.revision(alembic_cfg, message=message,
|
|
autogenerate=autogenerate)
|