From 113e0229672c33954324815cf67c17167dc04728 Mon Sep 17 00:00:00 2001 From: 283375 Date: Sat, 31 May 2025 10:26:41 +0800 Subject: [PATCH] feat(db): alembic init --- .../database/migrations/README.md | 1 + .../database/migrations/__init__.py | 0 src/arcaea_offline/database/migrations/env.py | 82 +++++++++++++++++++ .../database/migrations/script.py.mako | 26 ++++++ .../database/migrations/versions/__init__.py | 0 5 files changed, 109 insertions(+) create mode 100644 src/arcaea_offline/database/migrations/README.md create mode 100644 src/arcaea_offline/database/migrations/__init__.py create mode 100644 src/arcaea_offline/database/migrations/env.py create mode 100644 src/arcaea_offline/database/migrations/script.py.mako create mode 100644 src/arcaea_offline/database/migrations/versions/__init__.py diff --git a/src/arcaea_offline/database/migrations/README.md b/src/arcaea_offline/database/migrations/README.md new file mode 100644 index 0000000..2500aa1 --- /dev/null +++ b/src/arcaea_offline/database/migrations/README.md @@ -0,0 +1 @@ +Generic single-database configuration. diff --git a/src/arcaea_offline/database/migrations/__init__.py b/src/arcaea_offline/database/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/arcaea_offline/database/migrations/env.py b/src/arcaea_offline/database/migrations/env.py new file mode 100644 index 0000000..2138691 --- /dev/null +++ b/src/arcaea_offline/database/migrations/env.py @@ -0,0 +1,82 @@ +from logging.config import fileConfig + +from alembic import context +from sqlalchemy import engine_from_config, pool + +from arcaea_offline.database.models.base import ModelsV5Base + +# 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. +if config.config_file_name is not None: + 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 = [ModelsV5Base.metadata] + +# 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"}, + render_as_batch=True, + ) + + 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, + render_as_batch=True, + transaction_per_migration=True, + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/src/arcaea_offline/database/migrations/script.py.mako b/src/arcaea_offline/database/migrations/script.py.mako new file mode 100644 index 0000000..fbc4b07 --- /dev/null +++ b/src/arcaea_offline/database/migrations/script.py.mako @@ -0,0 +1,26 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/src/arcaea_offline/database/migrations/versions/__init__.py b/src/arcaea_offline/database/migrations/versions/__init__.py new file mode 100644 index 0000000..e69de29