如何让Alembic识别SQLModel定义的数据库模型？

前置准备 #

确保你已经安装了对应版本的依赖：

• sqlmodel >= 0.0.8
• alembic >= 1.7.0

配置步骤 #

1. 初始化Alembic项目
   执行命令：
   alembic init alembic

2. 修改 Alembic 基础配置文件
   首先修改项目根目录下的alembic.ini，将其中的sqlalchemy.url参数替换为你实际使用的数据库连接地址，和SQLModel连接数据库时使用的地址保持完全一致。

3. 修改 Alembic 环境运行文件
   打开alembic/env.py，按如下规则修改：

• 开头添加项目路径导入逻辑，避免后续导入模型时报路径错误：

import sys
from pathlib import Path
# 此处路径可根据你实际的项目结构调整，确保可以导入到定义模型的模块即可
sys.path.append(str(Path(__file__).parent.parent))

• 导入你项目中继承的SQLModel基类，以及所有定义好的表模型：

# 替换your_models为你存放Hero模型的Python文件名
from your_models import SQLModel, Hero

• 找到文件中原有的target_metadata变量定义，直接替换为：

target_metadata = SQLModel.metadata

配置验证 #

执行自动生成迁移脚本命令，验证是否可以正常识别Hero模型：
alembic revision --autogenerate -m "add hero table"
如果生成的迁移脚本中包含创建Hero对应表的逻辑，说明配置已经生效，之后执行alembic upgrade head即可将表结构同步到数据库。

问题说明 #

之前导入SQLAlchemy原生模型不生效的核心原因是，SQLModel定义的表结构会统一注册到SQLModel自带的metadata中，必须将Alembic的目标metadata指定为该实例，才能正确识别所有标记了table=True的模型。

内容的提问来源于stack exchange，提问作者Greg