From cb95a06fa7646a8f87adbf8e12943183ff2f439c Mon Sep 17 00:00:00 2001 From: YehorI Date: Thu, 28 Sep 2023 18:04:47 +0300 Subject: [PATCH 1/4] task/50 storage models migrations --- .../storage/database/migrations/alembic.ini | 114 ++++++++++++++++++ sapphire/storage/database/migrations/env.py | 91 ++++++++++++++ .../database/migrations/script.py.mako | 26 ++++ .../f49b1a9878de_initial_migration.py | 68 +++++++++++ sapphire/storage/database/models.py | 48 ++++++++ 5 files changed, 347 insertions(+) create mode 100644 sapphire/storage/database/migrations/alembic.ini create mode 100644 sapphire/storage/database/migrations/env.py create mode 100644 sapphire/storage/database/migrations/script.py.mako create mode 100644 sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py create mode 100644 sapphire/storage/database/models.py diff --git a/sapphire/storage/database/migrations/alembic.ini b/sapphire/storage/database/migrations/alembic.ini new file mode 100644 index 00000000..0296adf9 --- /dev/null +++ b/sapphire/storage/database/migrations/alembic.ini @@ -0,0 +1,114 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = . + +# 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 migrations/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:migrations/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. + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = postgresql+asyncpg://user:password@localhost:5432/database + + +[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 + +# lint with attempts to fix using "ruff" - use the exec runner, execute a binary +# hooks = ruff +# ruff.type = exec +# ruff.executable = %(here)s/.venv/bin/ruff +# ruff.options = --fix 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/sapphire/storage/database/migrations/env.py b/sapphire/storage/database/migrations/env.py new file mode 100644 index 00000000..522b68f8 --- /dev/null +++ b/sapphire/storage/database/migrations/env.py @@ -0,0 +1,91 @@ +import asyncio +from logging.config import fileConfig + +from sqlalchemy import pool +from sqlalchemy.engine import Connection +from sqlalchemy.ext.asyncio import async_engine_from_config + +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 + +# 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 +from sapphire.storage.database import models + +target_metadata = models.Base.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"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def do_run_migrations(connection: Connection) -> None: + context.configure(connection=connection, target_metadata=target_metadata) + + with context.begin_transaction(): + context.run_migrations() + + +async def run_async_migrations() -> None: + """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, + ) + + async with connectable.connect() as connection: + await connection.run_sync(do_run_migrations) + + await connectable.dispose() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode.""" + + asyncio.run(run_async_migrations()) + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/sapphire/storage/database/migrations/script.py.mako b/sapphire/storage/database/migrations/script.py.mako new file mode 100644 index 00000000..fbc4b07d --- /dev/null +++ b/sapphire/storage/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/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py b/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py new file mode 100644 index 00000000..702379f3 --- /dev/null +++ b/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py @@ -0,0 +1,68 @@ +"""Initial migration + +Revision ID: f49b1a9878de +Revises: +Create Date: 2023-09-28 17:59:38.753868 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = 'f49b1a9878de' +down_revision: Union[str, None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + # ### adjusted ### + op.create_table('skills', + sa.Column('id', sa.String(), nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('migrate_to', sa.String(), nullable=True, default=sa.Null), + sa.Column('created_at', sa.DateTime(), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('id') + ) + op.create_table('specialization_groups', + sa.Column('id', sa.String(), nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('migrate_to', sa.String(), nullable=True, default=sa.Null), + sa.Column('created_at', sa.DateTime(), nullable=False), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('id') + ) + op.create_table('specializations', + sa.Column('id', sa.String(), nullable=False), + sa.Column('name', sa.String(), nullable=True), + sa.Column('is_other', sa.Boolean(), nullable=False, default=sa.False_), + sa.Column('group_id', sa.String(), nullable=True), + sa.Column('migrate_to', sa.String(), nullable=True, default=sa.Null), + sa.Column('created_at', sa.DateTime(), nullable=False), + sa.ForeignKeyConstraint(['group_id'], ['specialization_groups.id'], ), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('id') + ) + op.create_table('specializations_skills', + sa.Column('skill_id', sa.String(), nullable=False), + sa.Column('specialization_id', sa.String(), nullable=False), + sa.Column('created_at', sa.DateTime(), nullable=False), + sa.Column('updated_at', sa.DateTime(), nullable=False), + sa.ForeignKeyConstraint(['skill_id'], ['skills.id'], ), + sa.ForeignKeyConstraint(['specialization_id'], ['specializations.id'], ), + sa.PrimaryKeyConstraint('skill_id', 'specialization_id') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('specializations_skills') + op.drop_table('specializations') + op.drop_table('specialization_groups') + op.drop_table('skills') + # ### end Alembic commands ### diff --git a/sapphire/storage/database/models.py b/sapphire/storage/database/models.py new file mode 100644 index 00000000..2d49fd3f --- /dev/null +++ b/sapphire/storage/database/models.py @@ -0,0 +1,48 @@ +import uuid +from datetime import datetime +from typing import Literal, get_args + +from sqlalchemy import Enum, ForeignKey, False_, Null +from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column + +class Base(DeclarativeBase): + pass + + +class Skill(Base): + __tablename__ = "skills" + + id: Mapped[str] = mapped_column(unique=True, primary_key=True) + name: Mapped[str | None] + migrate_to: Mapped[str | None] = mapped_column(default=Null) + created_at: Mapped[datetime] = mapped_column(default=datetime.now) + + +class Specialization(Base): + __tablename__ = "specializations" + + id: Mapped[str] = mapped_column(unique=True, primary_key=True) + name: Mapped[str | None] + is_other: Mapped[bool] = mapped_column(default=False_) + group_id: Mapped[str | None] = mapped_column(ForeignKey("specialization_groups.id")) + migrate_to: Mapped[str | None] = mapped_column(default=Null) + created_at: Mapped[datetime] = mapped_column(default=datetime.now) + + +class SpecializationsSkills(Base): + __tablename__ = "specializations_skills" + + skill_id: Mapped[str] = mapped_column(ForeignKey("skills.id"), primary_key=True) + specialization_id: Mapped[str] = mapped_column(ForeignKey("specializations.id"), primary_key=True) + created_at: Mapped[datetime] = mapped_column(default=datetime.now) + updated_at: Mapped[datetime] = mapped_column(default=datetime.now, onupdate=datetime.now) + + +class SpecializationGroup(Base): + __tablename__ = "specialization_groups" + + id: Mapped[str] = mapped_column(unique=True, primary_key=True) + name: Mapped[str | None] + migrate_to: Mapped[str | None] = mapped_column(default=Null) + created_at: Mapped[datetime] = mapped_column(default=datetime.now) + From ce618f9f681d10f031393ca9baa3ad340f0af39a Mon Sep 17 00:00:00 2001 From: YehorI Date: Thu, 28 Sep 2023 18:05:30 +0300 Subject: [PATCH 2/4] task/50 isorts --- sapphire/storage/database/migrations/env.py | 3 +-- .../migrations/versions/f49b1a9878de_initial_migration.py | 3 +-- sapphire/storage/database/models.py | 3 ++- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/sapphire/storage/database/migrations/env.py b/sapphire/storage/database/migrations/env.py index 522b68f8..00f8edaa 100644 --- a/sapphire/storage/database/migrations/env.py +++ b/sapphire/storage/database/migrations/env.py @@ -1,12 +1,11 @@ import asyncio from logging.config import fileConfig +from alembic import context from sqlalchemy import pool from sqlalchemy.engine import Connection from sqlalchemy.ext.asyncio import async_engine_from_config -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 diff --git a/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py b/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py index 702379f3..958291f3 100644 --- a/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py +++ b/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py @@ -7,9 +7,8 @@ """ from typing import Sequence, Union -from alembic import op import sqlalchemy as sa - +from alembic import op # revision identifiers, used by Alembic. revision: str = 'f49b1a9878de' diff --git a/sapphire/storage/database/models.py b/sapphire/storage/database/models.py index 2d49fd3f..14221a73 100644 --- a/sapphire/storage/database/models.py +++ b/sapphire/storage/database/models.py @@ -2,9 +2,10 @@ from datetime import datetime from typing import Literal, get_args -from sqlalchemy import Enum, ForeignKey, False_, Null +from sqlalchemy import Enum, False_, ForeignKey, Null from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column + class Base(DeclarativeBase): pass From 9569ca8fc64b28553a1aa6ecb17472f92924a7ea Mon Sep 17 00:00:00 2001 From: YehorI Date: Thu, 28 Sep 2023 18:17:15 +0300 Subject: [PATCH 3/4] task/50 unused imports --- sapphire/storage/database/models.py | 1 - 1 file changed, 1 deletion(-) diff --git a/sapphire/storage/database/models.py b/sapphire/storage/database/models.py index 14221a73..b0c6c182 100644 --- a/sapphire/storage/database/models.py +++ b/sapphire/storage/database/models.py @@ -1,6 +1,5 @@ import uuid from datetime import datetime -from typing import Literal, get_args from sqlalchemy import Enum, False_, ForeignKey, Null from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column From 43142de39b4a848b574f48c9d6421e9137ac9e06 Mon Sep 17 00:00:00 2001 From: YehorI Date: Fri, 29 Sep 2023 11:21:42 +0300 Subject: [PATCH 4/4] task/50 removed sa.False_ sa.Null, unique with PK --- ...n.py => 129f61d28e39_initial_migration.py} | 25 ++++++++----------- sapphire/storage/database/models.py | 16 ++++++------ 2 files changed, 19 insertions(+), 22 deletions(-) rename sapphire/storage/database/migrations/versions/{f49b1a9878de_initial_migration.py => 129f61d28e39_initial_migration.py} (73%) diff --git a/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py b/sapphire/storage/database/migrations/versions/129f61d28e39_initial_migration.py similarity index 73% rename from sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py rename to sapphire/storage/database/migrations/versions/129f61d28e39_initial_migration.py index 958291f3..5e507776 100644 --- a/sapphire/storage/database/migrations/versions/f49b1a9878de_initial_migration.py +++ b/sapphire/storage/database/migrations/versions/129f61d28e39_initial_migration.py @@ -1,8 +1,8 @@ """Initial migration -Revision ID: f49b1a9878de +Revision ID: 129f61d28e39 Revises: -Create Date: 2023-09-28 17:59:38.753868 +Create Date: 2023-09-29 11:18:55.166058 """ from typing import Sequence, Union @@ -11,7 +11,7 @@ from alembic import op # revision identifiers, used by Alembic. -revision: str = 'f49b1a9878de' +revision: str = '129f61d28e39' down_revision: Union[str, None] = None branch_labels: Union[str, Sequence[str], None] = None depends_on: Union[str, Sequence[str], None] = None @@ -22,29 +22,26 @@ def upgrade() -> None: op.create_table('skills', sa.Column('id', sa.String(), nullable=False), sa.Column('name', sa.String(), nullable=True), - sa.Column('migrate_to', sa.String(), nullable=True, default=sa.Null), + sa.Column('migrate_to', sa.String(), nullable=True), sa.Column('created_at', sa.DateTime(), nullable=False), - sa.PrimaryKeyConstraint('id'), - sa.UniqueConstraint('id') + sa.PrimaryKeyConstraint('id') ) op.create_table('specialization_groups', sa.Column('id', sa.String(), nullable=False), sa.Column('name', sa.String(), nullable=True), - sa.Column('migrate_to', sa.String(), nullable=True, default=sa.Null), + sa.Column('migrate_to', sa.String(), nullable=True), sa.Column('created_at', sa.DateTime(), nullable=False), - sa.PrimaryKeyConstraint('id'), - sa.UniqueConstraint('id') + sa.PrimaryKeyConstraint('id') ) op.create_table('specializations', sa.Column('id', sa.String(), nullable=False), sa.Column('name', sa.String(), nullable=True), - sa.Column('is_other', sa.Boolean(), nullable=False, default=sa.False_), + sa.Column('is_other', sa.Boolean(), nullable=False), sa.Column('group_id', sa.String(), nullable=True), - sa.Column('migrate_to', sa.String(), nullable=True, default=sa.Null), + sa.Column('migrate_to', sa.String(), nullable=True), sa.Column('created_at', sa.DateTime(), nullable=False), sa.ForeignKeyConstraint(['group_id'], ['specialization_groups.id'], ), - sa.PrimaryKeyConstraint('id'), - sa.UniqueConstraint('id') + sa.PrimaryKeyConstraint('id') ) op.create_table('specializations_skills', sa.Column('skill_id', sa.String(), nullable=False), @@ -59,7 +56,7 @@ def upgrade() -> None: def downgrade() -> None: - # ### commands auto generated by Alembic - please adjust! ### + # ### adjusted ### op.drop_table('specializations_skills') op.drop_table('specializations') op.drop_table('specialization_groups') diff --git a/sapphire/storage/database/models.py b/sapphire/storage/database/models.py index b0c6c182..d4051b68 100644 --- a/sapphire/storage/database/models.py +++ b/sapphire/storage/database/models.py @@ -1,7 +1,7 @@ import uuid from datetime import datetime -from sqlalchemy import Enum, False_, ForeignKey, Null +from sqlalchemy import Enum, ForeignKey from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column @@ -12,20 +12,20 @@ class Base(DeclarativeBase): class Skill(Base): __tablename__ = "skills" - id: Mapped[str] = mapped_column(unique=True, primary_key=True) + id: Mapped[str] = mapped_column(primary_key=True) name: Mapped[str | None] - migrate_to: Mapped[str | None] = mapped_column(default=Null) + migrate_to: Mapped[str | None] = mapped_column(nullable=True) created_at: Mapped[datetime] = mapped_column(default=datetime.now) class Specialization(Base): __tablename__ = "specializations" - id: Mapped[str] = mapped_column(unique=True, primary_key=True) + id: Mapped[str] = mapped_column(primary_key=True) name: Mapped[str | None] - is_other: Mapped[bool] = mapped_column(default=False_) + is_other: Mapped[bool] = mapped_column(default=False) group_id: Mapped[str | None] = mapped_column(ForeignKey("specialization_groups.id")) - migrate_to: Mapped[str | None] = mapped_column(default=Null) + migrate_to: Mapped[str | None] = mapped_column(nullable=True) created_at: Mapped[datetime] = mapped_column(default=datetime.now) @@ -41,8 +41,8 @@ class SpecializationsSkills(Base): class SpecializationGroup(Base): __tablename__ = "specialization_groups" - id: Mapped[str] = mapped_column(unique=True, primary_key=True) + id: Mapped[str] = mapped_column(primary_key=True) name: Mapped[str | None] - migrate_to: Mapped[str | None] = mapped_column(default=Null) + migrate_to: Mapped[str | None] = mapped_column(nullable=True) created_at: Mapped[datetime] = mapped_column(default=datetime.now)