From 4d5034204e73660e3cedc7d9ea5cf54e60366d20 Mon Sep 17 00:00:00 2001 From: LoRiot Date: Mon, 17 Oct 2022 12:35:26 +0300 Subject: [PATCH] Use alembic for migrations --- alembic.ini | 103 ++++++++++++++++++ alembic/README | 1 + alembic/env.py | 98 +++++++++++++++++ alembic/script.py.mako | 24 ++++ .../versions/9b42b5289e30_init_tables.py | 46 +++++--- bot.py | 11 +- db/migrations/__init__.py | 0 requirements.txt | 3 +- 8 files changed, 266 insertions(+), 20 deletions(-) create mode 100644 alembic.ini create mode 100644 alembic/README create mode 100644 alembic/env.py create mode 100644 alembic/script.py.mako rename db/migrations/init_tables.py => alembic/versions/9b42b5289e30_init_tables.py (54%) delete mode 100644 db/migrations/__init__.py diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..6652c60 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,103 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python-dateutil library that can be +# installed by adding `alembic[tz]` to the pip requirements +# string value is passed to dateutil.tz.gettz() +# leave blank for localtime +# timezone = + +# 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/versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = driver://user:pass@localhost/dbname + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# 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/alembic/README b/alembic/README new file mode 100644 index 0000000..e0d0858 --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration with an async dbapi. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..d83c986 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,98 @@ +import asyncio +import os +from logging.config import fileConfig + +from sqlalchemy.ext.asyncio import async_engine_from_config +from sqlalchemy.ext.asyncio import AsyncConnection +from sqlalchemy import pool +# from sqlalchemy.engine import Connection +from sqlalchemy.ext.asyncio import AsyncEngine + +from alembic import context + + +DB_HOST = os.getenv("DB_HOST") +DB_USER = os.getenv("DB_USER") +DB_PASS = os.getenv("DB_PASS") +DB_NAME = os.getenv("DB_NAME") + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config +config.set_main_option( + "sqlalchemy.url", + f"postgresql+asyncpg://{DB_USER}:{DB_PASS}@{DB_HOST}/{DB_NAME}" +) + +# 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 = 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 do_run_migrations(connection: AsyncConnection) -> None: + context.configure(connection=connection, target_metadata=target_metadata) + + with context.begin_transaction(): + context.run_migrations() + + +async 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 = async_engine_from_config( + config.get_section(config.config_ini_section), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + future=True, + ) + + async with connectable.connect() as connection: + await connection.run_sync(do_run_migrations) + + await connectable.dispose() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + asyncio.run(run_migrations_online()) diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..55df286 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/db/migrations/init_tables.py b/alembic/versions/9b42b5289e30_init_tables.py similarity index 54% rename from db/migrations/init_tables.py rename to alembic/versions/9b42b5289e30_init_tables.py index e079fc9..7319c43 100644 --- a/db/migrations/init_tables.py +++ b/alembic/versions/9b42b5289e30_init_tables.py @@ -1,17 +1,32 @@ -import asyncio -import asyncpg -import os -from asyncpg.connection import Connection +"""init tables + +Revision ID: 9b42b5289e30 +Revises: +Create Date: 2022-10-17 11:43:07.452838 + +""" +from alembic import op +import sqlalchemy as sa +from sqlalchemy.sql import text -async def init_tables(connection: Connection): +# revision identifiers, used by Alembic. +revision = '9b42b5289e30' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + conn = op.get_bind() + init_users_query = """ CREATE TABLE users ( user_id bigint PRIMARY KEY, chat_id bigint ); """ - await connection.execute(init_users_query) + conn.execute(text(init_users_query)) init_tags_query = """ CREATE TABLE tags ( @@ -19,7 +34,7 @@ async def init_tables(connection: Connection): name varchar(100) ); """ - await connection.execute(init_tags_query) + conn.execute(text(init_tags_query)) init_categories_query = """ CREATE TABLE categories ( @@ -27,7 +42,7 @@ async def init_tables(connection: Connection): name varchar(20) ); """ - await connection.execute(init_categories_query) + conn.execute(text(init_categories_query)) init_projects_query = """ CREATE TABLE projects ( @@ -42,15 +57,12 @@ async def init_tables(connection: Connection): creation_date date DEFAULT CURRENT_DATE ); """ - await connection.execute(init_projects_query) + conn.execute(text(init_projects_query)) -async def main(): - DB_URL = os.getenv("DB_URL") - connection = await asyncpg.connect(DB_URL) - await init_tables(connection) - await connection.close() +def downgrade() -> None: + conn = op.get_bind() - -if __name__ == "__main__": - asyncio.run(main()) + conn.execute(text( + "DROP TABLE users, tags, categories, projects CASCADE" + )) diff --git a/bot.py b/bot.py index ab83e5b..ad72ed5 100644 --- a/bot.py +++ b/bot.py @@ -15,10 +15,17 @@ from handlers.projects import register_projects_handlers async def main(): """Configures and runs the bot, connects to the db""" logging.basicConfig(level=logging.INFO) - DB_URL = os.getenv("DB_URL") + API_TOKEN = os.getenv("API_TOKEN") - pool = await asyncpg.create_pool(DB_URL) + DB_HOST = os.getenv("DB_HOST") + DB_USER = os.getenv("DB_USER") + DB_PASS = os.getenv("DB_PASS") + DB_NAME = os.getenv("DB_NAME") + + pool = await asyncpg.create_pool( + f"postgresql://{DB_USER}:{DB_PASS}@{DB_HOST}/{DB_NAME}" + ) bot = Bot(API_TOKEN) dp = Dispatcher(bot, storage=MemoryStorage()) diff --git a/db/migrations/__init__.py b/db/migrations/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/requirements.txt b/requirements.txt index 45e6eb9..3fcf5b1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ loguru aiogram -asyncpg \ No newline at end of file +asyncpg +sqlalchemy \ No newline at end of file