diff options
| author | Barry Warsaw | 2014-09-27 18:16:22 -0400 |
|---|---|---|
| committer | Barry Warsaw | 2014-09-27 18:16:22 -0400 |
| commit | b3500aefb15c63ccf60ab4508868f770ffd2d309 (patch) | |
| tree | 049e083e3ce28e7e504c1945f0dd8e2cf09dd40b /src/mailman/database/alembic/env.py | |
| parent | eef73255db608785a55c055cbbfb800603671ff6 (diff) | |
| parent | 03647b16eb75cc841bb15c3c48ac5f18f77118b8 (diff) | |
| download | mailman-b3500aefb15c63ccf60ab4508868f770ffd2d309.tar.gz mailman-b3500aefb15c63ccf60ab4508868f770ffd2d309.tar.zst mailman-b3500aefb15c63ccf60ab4508868f770ffd2d309.zip | |
Diffstat (limited to 'src/mailman/database/alembic/env.py')
| -rw-r--r-- | src/mailman/database/alembic/env.py | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/src/mailman/database/alembic/env.py b/src/mailman/database/alembic/env.py new file mode 100644 index 000000000..ee6d8293f --- /dev/null +++ b/src/mailman/database/alembic/env.py @@ -0,0 +1,80 @@ +# Copyright (C) 2014 by the Free Software Foundation, Inc. +# +# This file is part of GNU Mailman. +# +# GNU Mailman is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# GNU Mailman. If not, see <http://www.gnu.org/licenses/>. + +"""Alembic migration environment.""" + +from __future__ import absolute_import, print_function, unicode_literals + +__metaclass__ = type +__all__ = [ + 'run_migrations_offline', + 'run_migrations_online', + ] + + +from alembic import context +from alembic.config import Config +from contextlib import closing +from sqlalchemy import create_engine + +from mailman.config import config +from mailman.database.model import Model +from mailman.utilities.modules import expand_path +from mailman.utilities.string import expand + + + +def run_migrations_offline(): + """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 = expand(config.database.url, config.paths) + context.configure(url=url, target_metadata=Model.metadata) + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine and associate a + connection with the context. + """ + alembic_cfg = Config() + alembic_cfg.set_main_option( + 'script_location', expand_path(config.database['alembic_scripts'])) + url = expand(config.database.url, config.paths) + engine = create_engine(url) + + connection = engine.connect() + with closing(connection): + context.configure( + connection=connection, target_metadata=Model.metadata) + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() |
