dingdanquanliucheng/backend/migrations/env.py
taiyi 9b32afdbb4 为后端全部 86 个 Python 文件添加中文注释
覆盖所有模块:
- api 层:17 个路由文件,每个接口标注用途、参数、返回值、权限
- services 层:18 个服务文件,每个方法标注作用、参数、返回值、调用方
- repositories 层:13 个仓储文件,每个方法标注查询逻辑和被调用方
- schemas 层:11 个请求/响应体文件,每个字段标注业务含义
- core 层:config、security、exceptions、responses、error_codes
- models 层:19 个 ORM 模型类,每个表标注业务含义和关联关系
- scripts:bootstrap_data、smoke_check
- migrations:env.py 和版本迁移文件

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 07:23:33 +08:00

60 lines
1.8 KiB
Python

"""Alembic 数据库迁移环境配置。
配置迁移工具的数据库连接、元数据目标和迁移执行方式。
支持在线迁移(连接数据库执行)和离线迁移(生成 SQL 脚本)。
"""
from logging.config import fileConfig
from pathlib import Path
import sys
from alembic import context
from sqlalchemy import engine_from_config, pool
# 确保项目根目录在 sys.path 中,使 backend 包可被导入
PROJECT_ROOT = Path(__file__).resolve().parents[2]
if str(PROJECT_ROOT) not in sys.path:
sys.path.insert(0, str(PROJECT_ROOT))
from backend.app.db import Base, build_database_url
from backend.app.models import * # noqa: F401,F403
config = context.config
config.set_main_option("sqlalchemy.url", build_database_url())
if config.config_file_name is not None:
fileConfig(config.config_file_name)
# 元数据用于 autogenerate 模式自动检测模型变更
target_metadata = Base.metadata
def run_migrations_offline() -> None:
"""离线模式执行迁移,生成 SQL 脚本而不连接数据库。"""
url = config.get_main_option("sqlalchemy.url")
context.configure(url=url, target_metadata=target_metadata, literal_binds=True)
with context.begin_transaction():
context.run_migrations()
def run_migrations_online() -> None:
"""在线模式执行迁移,直接连接数据库执行 DDL 变更。"""
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)
with context.begin_transaction():
context.run_migrations()
if context.is_offline_mode():
run_migrations_offline()
else:
run_migrations_online()