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

Question

使用SQLModel如何让alembic识别下面的模型？

from sqlmodel import Field, SQLModel

class Hero(SQLModel, table=True):
    id: int = Field(default=None, primary_key=True)
    name: str
    secret_name: str
    age: Optional[int] = None

我一直在研究的一种方法是导入 Alembic 的 SQLalchemy 模型，但查看源代码我找不到如何做到这一点。

如何使 Alembic 与 SQLModel 模型配合使用？

Answer 1

很快就会在高级用户指南中找到相关信息，并提供比我更好的解释，但这是我如何使 Alimbic 迁移工作的。

首先在控制台中运行

alembic init migrations

以生成迁移文件夹。 migrations文件夹内应为空versions子文件夹、env.py文件、script.py.mako文件。 在 script.py.mako 文件中，我们应该在这两行周围添加行

import sqlmodel

#script.py.mako
from alembic import op
import sqlalchemy as sa
import sqlmodel # added

然后我们应该编辑env.py文件

#env.py
from logging.config import fileConfig

from sqlalchemy import engine_from_config
from sqlalchemy import pool

from alembic import context

from app.models import * # necessarily to import something from file where your models are stored

# 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.
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 = None 
# comment line above and instead of that write
target_metadata = SQLModel.metadata

在写作时想到一个想法，您忘记从 models.py （或存储模型的其他任何地方）导入某些内容。这就是主要问题

此外，一个重要的注意事项是通过按 ctrl(CMD) + S 保存模型中的更改 - 这存在一些问题。

终于开始跑步了

 alembic revision --autogenerate -m "your message"

应该在 versions 文件夹中生成一个新的 .py 文件并包含您的更改。 还有

 alembic upgrade head  

将更改应用到数据库。

Answer 2

在这里您可以找到 fastapi-alembic 和 SQLmodel 与异步 PostgreSQL 数据库的集成 https://github.com/jonra1993/fastapi-sqlmodel-alembic