From 6490fee44414b20301ca41d546c9d6802c19e24a Mon Sep 17 00:00:00 2001 From: Doug Wiegley Date: Wed, 9 Dec 2015 14:31:13 -0700 Subject: [PATCH] Initial alembic commit Change-Id: I7ea93dd1d97a8cf2b68146748f1c541136c1fc3c --- kosmos/db/migration/alembic.ini | 70 ++++++++++++++++ kosmos/db/migration/alembic_migrations/README | 1 + kosmos/db/migration/alembic_migrations/env.py | 84 +++++++++++++++++++ .../alembic_migrations/script.py.mako | 24 ++++++ .../5a0f38520dc4_create_initial_table.py | 38 +++++++++ requirements.txt | 2 + 6 files changed, 219 insertions(+) create mode 100644 kosmos/db/migration/alembic.ini create mode 100644 kosmos/db/migration/alembic_migrations/README create mode 100644 kosmos/db/migration/alembic_migrations/env.py create mode 100644 kosmos/db/migration/alembic_migrations/script.py.mako create mode 100644 kosmos/db/migration/alembic_migrations/versions/5a0f38520dc4_create_initial_table.py diff --git a/kosmos/db/migration/alembic.ini b/kosmos/db/migration/alembic.ini new file mode 100644 index 0000000..7bc4de4 --- /dev/null +++ b/kosmos/db/migration/alembic.ini @@ -0,0 +1,70 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = %(here)s/alembic_migrations + +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# max length of characters to apply to the +# "slug" field +#truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; this defaults +# to alembic_migrations/versions. When using multiple version +# directories, initial revisions must be specified with --version-path +# version_locations = %(here)s/bar %(here)s/bat alembic_migrations/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +#sqlalchemy.url = driver://user:pass@localhost/dbname +sqlalchemy.url = mysql+pymysql://root:password@localhost/kosmos + + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/kosmos/db/migration/alembic_migrations/README b/kosmos/db/migration/alembic_migrations/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/kosmos/db/migration/alembic_migrations/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/kosmos/db/migration/alembic_migrations/env.py b/kosmos/db/migration/alembic_migrations/env.py new file mode 100644 index 0000000..47a5407 --- /dev/null +++ b/kosmos/db/migration/alembic_migrations/env.py @@ -0,0 +1,84 @@ +# All Rights Reserved. +# +# 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. + +from __future__ import with_statement +from alembic import context +from sqlalchemy import engine_from_config, pool +from logging.config import fileConfig + +# 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. +fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +target_metadata = None + +# 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(): + """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) + + 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. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section), + prefix='sqlalchemy.', + poolclass=pool.NullPool) + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata + ) + + with context.begin_transaction(): + context.run_migrations() + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/kosmos/db/migration/alembic_migrations/script.py.mako b/kosmos/db/migration/alembic_migrations/script.py.mako new file mode 100644 index 0000000..43c0940 --- /dev/null +++ b/kosmos/db/migration/alembic_migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/kosmos/db/migration/alembic_migrations/versions/5a0f38520dc4_create_initial_table.py b/kosmos/db/migration/alembic_migrations/versions/5a0f38520dc4_create_initial_table.py new file mode 100644 index 0000000..e56c176 --- /dev/null +++ b/kosmos/db/migration/alembic_migrations/versions/5a0f38520dc4_create_initial_table.py @@ -0,0 +1,38 @@ +# All Rights Reserved. +# +# 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. + +"""create initial table + +Revision ID: 5a0f38520dc4 +Revises: None +Create Date: 2015-12-09 14:31:37.099747 + +""" + +# revision identifiers, used by Alembic. +revision = '5a0f38520dc4' +down_revision = None +branch_labels = None +depends_on = None + +# from alembic import op +# import sqlalchemy as sa + + +def upgrade(): + pass + + +def downgrade(): + pass diff --git a/requirements.txt b/requirements.txt index 5a1a356..96e8b69 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,4 +5,6 @@ pbr<2.0,>=1.4 Babel>=1.3 +alembic>=0.8.0 +oslo.db>=3.2.0 # Apache-2.0 oslo.i18n>=1.5.0 # Apache-2.0