Введение в модели SQLAlchemy

Теперь нам нужно будет импортировать наши модели базы данных, чтобы они были добавлены в объект Base.metadata. Это происходит автоматически, когда модель наследует от Base, но нам нужно импортировать модели, чтобы убедиться, что они импортированы до загрузки конфигурации alembic.

Откроем файл env.py в папке migrations и найдем следующую строку:

target_metadata = None

Изменим ее на следующий код:

from app.backend.db import Base
from app.models.category import Category
from app.models.products import Product

target_metadata = Base.metadata

Мы импортируем класс Base, который мы наследуем от DeclarativeBase, а также наши модели SQLAlchemy.

Теперь мы можем выполнить первую миграцию:

alembic revision --autogenerate -m "Initial migration"

(.venv) permin0ff@Mac fastapi_ecommerce % alembic revision --autogenerate -m "Initial migration"
INFO  [alembic.runtime.migration] Context impl SQLiteImpl.
INFO  [alembic.runtime.migration] Will assume non-transactional DDL.
INFO  [alembic.autogenerate.compare] Detected added table 'categories'
INFO  [alembic.autogenerate.compare] Detected added index ''ix_categories_id'' on '('id',)'
INFO  [alembic.autogenerate.compare] Detected added index ''ix_categories_slug'' on '('slug',)'
INFO  [alembic.autogenerate.compare] Detected added table 'products'
INFO  [alembic.autogenerate.compare] Detected added index ''ix_products_id'' on '('id',)'
INFO  [alembic.autogenerate.compare] Detected added index ''ix_products_slug'' on '('slug',)'
  Generating ~/PycharmProjects/FastAPI_beginners/fastapi_ecommerce/app/migrations/versions/4a7fc2a8d136_initial_migration.py ...  done

Мы видим что наша первая миграция была создана в папке app/migrations/versions/, откроем этот файл и посмотрим его содержание:

"""Initial migration

Revision ID: 4a7fc2a8d136
Revises: 
Create Date: 2024-03-26 09:34:36.593875

"""
from typing import Sequence, Union

from alembic import op
import sqlalchemy as sa


# revision identifiers, used by Alembic.
revision: str = '4a7fc2a8d136'
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:
    # ### commands auto generated by Alembic - please adjust! ###
    op.create_table('categories',
    sa.Column('id', sa.Integer(), nullable=False),
    sa.Column('name', sa.String(), nullable=True),
    sa.Column('slug', sa.String(), nullable=True),
    sa.Column('is_active', sa.Boolean(), nullable=True),
    sa.Column('parent_id', sa.Integer(), nullable=True),
    sa.ForeignKeyConstraint(['parent_id'], ['categories.id'], ),
    sa.PrimaryKeyConstraint('id')
    )
    op.create_index(op.f('ix_categories_id'), 'categories', ['id'], unique=False)
    op.create_index(op.f('ix_categories_slug'), 'categories', ['slug'], unique=True)
    op.create_table('products',
    sa.Column('id', sa.Integer(), nullable=False),
    sa.Column('name', sa.String(), nullable=True),
    sa.Column('slug', sa.String(), nullable=True),
    sa.Column('description', sa.String(), nullable=True),
    sa.Column('price', sa.Integer(), nullable=True),
    sa.Column('image_url', sa.String(), nullable=True),
    sa.Column('stock', sa.Integer(), nullable=True),
    sa.Column('category_id', sa.Integer(), nullable=True),
    sa.Column('rating', sa.Float(), nullable=True),
    sa.Column('is_active', sa.Boolean(), nullable=True),
    sa.ForeignKeyConstraint(['category_id'], ['categories.id'], ),
    sa.PrimaryKeyConstraint('id')
    )
    op.create_index(op.f('ix_products_id'), 'products', ['id'], unique=False)
    op.create_index(op.f('ix_products_slug'), 'products', ['slug'], unique=True)
    # ### end Alembic commands ###


def downgrade() -> None:
    # ### commands auto generated by Alembic - please adjust! ###
    op.drop_index(op.f('ix_products_slug'), table_name='products')
    op.drop_index(op.f('ix_products_id'), table_name='products')
    op.drop_table('products')
    op.drop_index(op.f('ix_categories_slug'), table_name='categories')
    op.drop_index(op.f('ix_categories_id'), table_name='categories')
    op.drop_table('categories')
    # ### end Alembic commands ###

Рассмотрим его основные части:.

revision: Это код идентификации миграции.
Upgrade(): Это функция вызывается при применении изменений миграции.
Downgrade(): Это функция вызывается, когда изменения миграции удаляются.

Можно использовать команду alembic upgrade 4a7fc2a8d136⁣, чтобы выполнить миграцию определенной ревизии. Также рассмотрим основные команды в Alembic

alembic upgrade +2 две версии включая текущую для апгрейда
alembic downgrade -1 на предыдущую для даунгрейда
alembic current получить информацию о текущей версии
alembic history --verbose история миграций, более подробнее можно почитать в документации.
alembic downgrade base даунгрейд в самое начало
alembic upgrade head апгрейд до самого конца

Выполним команду, и посмотрим на результат.

(.venv) permin0ff@Mac fastapi_ecommerce % alembic upgrade head
INFO  [alembic.runtime.migration] Context impl SQLiteImpl.
INFO  [alembic.runtime.migration] Will assume non-transactional DDL.
INFO  [alembic.runtime.migration] Running upgrade  -> 4a7fc2a8d136, Initial migration

Мы видим что миграция была выполнена без ошибок, и у нас появился файл ecommerce.db содержащий базу данных SQLite. Открыв ее мы увидим следующие таблицы:

И если мы построим диаграммы, то увидим все наши поля и связи таблицы.

Далее по курсу, мы еще будем вносить изменения в наши модели SQLAlchemy, добавлять новые. И еще не раз будем выполнять миграции.

А теперь когда наша база данных создана, мы можем переходить к написанию первых запросов в нашем проекте.