feat(database): use alembic

DATA_SYNC_GUIDE.md

@@ -4,8 +4,8 @@
 
 ## 文件说明
 
-1. **`migrations/add_missing_fields.sql`** - 创建 Lazer API 专用表结构
+1. **`migrations_old/add_missing_fields.sql`** - 创建 Lazer API 专用表结构
-2. **`migrations/sync_legacy_data.sql`** - 数据同步脚本
+2. **`migrations_old/sync_legacy_data.sql`** - 数据同步脚本
 3. **`sync_data.py`** - 交互式数据同步工具
 4. **`quick_sync.py`** - 快速同步脚本（使用项目配置）
 
@@ -43,10 +43,10 @@ python sync_data.py
 
 ```bash
 # 1. 创建表结构
-mysql -u username -p database_name < migrations/add_missing_fields.sql
+mysql -u username -p database_name < migrations_old/add_missing_fields.sql
 
 # 2. 同步数据
-mysql -u username -p database_name < migrations/sync_legacy_data.sql
+mysql -u username -p database_name < migrations_old/sync_legacy_data.sql
 ```
 
 ## 同步内容

MIGRATE_GUIDE.md

@@ -0,0 +1,42 @@
+# 数据库迁移指南
+
+## 连接
+
+使用默认的环境变量（`DATABASE_URL`）连接，如果不存在会从 `alembic.ini` 里读取 `sqlalchemy.url`。
+
+## 创建迁移
+
+修改数据库模型定义后，使用以下命令创建新的迁移脚本：
+
+```bash
+alembic revision --autogenerate -m "描述你的迁移"
+```
+
+请注意，以下修改操作无法生成自动迁移，请手动修改生成的迁移文件
+
+- 修改表名
+- 修改列名
+- 匿名命名的约束
+
+## 升级/回滚迁移
+
+要应用所有未应用的迁移脚本，请运行：
+
+```bash
+alembic upgrade head
+```
+
+要升级/回滚版本，可以使用以下命令：
+
+```bash 
+# 回滚一个版本
+alembic downgrade -1
+# 升级两个版本
+alembic upgrade +2
+# 回滚到最初版本
+alembic downgrade base
+# 升级到特定版本
+alembic upgrade <revision>
+```
+
+详情参考：[alembic 文档](https://alembic.sqlalchemy.org/en/latest/tutorial.html).

README.md

@@ -205,6 +205,10 @@ curl -X POST http://localhost:8000/oauth/token \
 - 添加管理面板
 - 实现数据导入/导出功能
 
+### 迁移数据库
+
+参考[数据库迁移指南](./MIGRATE_GUIDE.md)
+
 ## 许可证
 
 MIT License

alembic.ini

@@ -0,0 +1,147 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts.
+# this is typically a path given in POSIX (e.g. forward slashes)
+# format, relative to the token %(here)s which refers to the location of this
+# ini file
+script_location = %(here)s/migrations
+
+# 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
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# 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.  for multiple paths, the path separator
+# is defined by "path_separator" below.
+prepend_sys_path = .
+
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library.
+# Any required deps can installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to ZoneInfo()
+# 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 <script_location>/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 "path_separator"
+# below.
+# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
+
+# path_separator; This indicates what character is used to split lists of file
+# paths, including version_locations and prepend_sys_path within configparser
+# files such as alembic.ini.
+# The default rendered in new alembic.ini files is "os", which uses os.pathsep
+# to provide os-dependent path splitting.
+#
+# Note that in order to support legacy alembic.ini files, this default does NOT
+# take place if path_separator is not present in alembic.ini.  If this
+# option is omitted entirely, fallback logic is as follows:
+#
+# 1. Parsing of the version_locations option falls back to using the legacy
+#    "version_path_separator" key, which if absent then falls back to the legacy
+#    behavior of splitting on spaces and/or commas.
+# 2. Parsing of the prepend_sys_path option falls back to the legacy
+#    behavior of splitting on spaces, commas, or colons.
+#
+# Valid values for path_separator are:
+#
+# path_separator = :
+# path_separator = ;
+# path_separator = space
+# path_separator = newline
+#
+# Use os.pathsep. Default configuration used for new projects.
+path_separator = os
+
+# 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
+
+# database URL.  This is consumed by the user-maintained env.py script only.
+# other means of configuring database URLs may be customized within the env.py
+# file.
+sqlalchemy.url = mysql+aiomysql://root:password@127.0.0.1:3306/osu_api
+
+
+[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 module runner, against the "ruff" module
+# hooks = ruff
+# ruff.type = module
+# ruff.module = ruff
+# ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Alternatively, use the exec runner to execute a binary found on your PATH
+hooks = ruff
+ruff.type = exec
+ruff.executable = ruff
+ruff.options = check --fix REVISION_SCRIPT_FILENAME
+
+# Logging configuration.  This is also consumed by the user-maintained
+# env.py script only.
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARNING
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARNING
+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

app/database/user.py

@@ -18,7 +18,7 @@ class User(SQLModel, table=True):
         default=None, sa_column=Column(BigInteger, primary_key=True, index=True)
     )
 
-    # 基本信息（匹配 migrations 中的结构）
+    # 基本信息（匹配 migrations_old 中的结构）
     name: str = Field(max_length=32, unique=True, index=True)  # 用户名
     safe_name: str = Field(max_length=32, unique=True, index=True)  # 安全用户名
     email: str = Field(max_length=254, unique=True, index=True)

main.py

@@ -10,9 +10,6 @@ from app.router import api_router, auth_router, fetcher_router, signalr_router
 
 from fastapi import FastAPI
 
-# 注意: 表结构现在通过 migrations 管理，不再自动创建
-# 如需创建表，请运行: python quick_sync.py
-
 
 @asynccontextmanager
 async def lifespan(app: FastAPI):

migrations/env.py

@@ -0,0 +1,99 @@
+from __future__ import annotations
+
+import asyncio
+from logging.config import fileConfig
+import os
+
+from app.database import *  # noqa: F403
+
+from alembic import context
+from sqlalchemy import pool
+from sqlalchemy.engine import Connection
+from sqlalchemy.ext.asyncio import async_engine_from_config
+from sqlmodel import SQLModel
+
+# 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 = SQLModel.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 = os.environ.get("DATABASE_URL", config.get_main_option("sqlalchemy.url"))
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        compare_type=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, compare_type=True
+    )
+
+    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.
+
+    """
+    sa_config = config.get_section(config.config_ini_section, {})
+    if db_url := os.environ.get("DATABASE_URL"):
+        sa_config["sqlalchemy.url"] = db_url
+    connectable = async_engine_from_config(
+        sa_config,
+        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()

migrations/script.py.mako

@@ -0,0 +1,29 @@
+"""${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
+import sqlmodel
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, Sequence[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:
+    """Upgrade schema."""
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    """Downgrade schema."""
+    ${downgrades if downgrades else "pass"}

quick_sync.py

@@ -94,7 +94,7 @@ def main():
 
     # 获取脚本路径
     script_dir = os.path.dirname(__file__)
-    migrations_dir = os.path.join(script_dir, "migrations")
+    migrations_dir = os.path.join(script_dir, "migrations_old")
 
     # 第一步: 创建表结构
     print("\n步骤 1: 创建 lazer 专用表结构...")

sync_data.py

@@ -183,7 +183,7 @@ def main():
             return
 
         # 执行表结构创建
-        migrations_dir = os.path.join(os.path.dirname(__file__), "migrations")
+        migrations_dir = os.path.join(os.path.dirname(__file__), "migrations_old")
 
         print("\n步骤 1: 创建表结构...")
         add_fields_sql = os.path.join(migrations_dir, "add_missing_fields.sql")

uv.lock

@@ -557,6 +557,7 @@ dev = [
     { name = "pre-commit", specifier = ">=4.2.0" },
     { name = "ruff", specifier = ">=0.12.4" },
 ]
+migration = []
 
 [[package]]
 name = "passlib"