summaryrefslogtreecommitdiff
path: root/designate/storage/impl_sqlalchemy/alembic/env.py
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2022-08-30 05:11:25 +0000
committerGerrit Code Review <review@openstack.org>2022-08-30 05:11:25 +0000
commit218e11ea204ee948a7aa3dcda0febff379ef0ec2 (patch)
tree611370a1c00ceb9f539fbf06df6545daeb3dd552 /designate/storage/impl_sqlalchemy/alembic/env.py
parent71c7542a892d76a6631e919fdd7ecf636f834eaa (diff)
parent60c378763aa37246762ff210f024e2af019f6397 (diff)
downloaddesignate-218e11ea204ee948a7aa3dcda0febff379ef0ec2.tar.gz
Merge "Switch Designate to Alembic database migrations"
Diffstat (limited to 'designate/storage/impl_sqlalchemy/alembic/env.py')
-rw-r--r--designate/storage/impl_sqlalchemy/alembic/env.py83
1 files changed, 83 insertions, 0 deletions
diff --git a/designate/storage/impl_sqlalchemy/alembic/env.py b/designate/storage/impl_sqlalchemy/alembic/env.py
new file mode 100644
index 00000000..0d23c33e
--- /dev/null
+++ b/designate/storage/impl_sqlalchemy/alembic/env.py
@@ -0,0 +1,83 @@
+# 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.mport threading
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# 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() -> 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.
+
+ """
+ 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,
+ transactional_ddl=True, transaction_per_migration=True
+ )
+
+ with context.begin_transaction():
+ context.run_migrations()
+
+
+if context.is_offline_mode():
+ run_migrations_offline()
+else:
+ run_migrations_online()