如何在SQLAlchemy中关联Django ORM管理的表创建外键？

我尝试在SQLAlchemy ORM模型中创建外键关联Django ORM管理的users_customuser表，但执行alembic revision --autogenerate时，SQLAlchemy报错找不到该表。

相关模型代码 #

class SomeSAModel(DeclarativeBase):
    user_id: Mapped[int] = mapped_column(
        sa.ForeignKey("users_customuser.id")  # 关联Django的表
    )  

报错信息 #

sqlalchemy.exc.NoReferencedTableError: Foreign key associated with column 'incidents__incident.ack_by' could not find table 'users_customuser' with which to generate a foreign key to target column 'id'

解决方法 #

1. 为Django表创建SQLAlchemy"影子模型" #

SQLAlchemy需要在元数据中存在目标表的定义才能解析外键，你可以创建一个仅包含主键的简化模型，让SQLAlchemy识别该表的存在：

from sqlalchemy import Integer
from sqlalchemy.orm import DeclarativeBase, mapped_column

class DjangoCustomUser(DeclarativeBase):
    __tablename__ = "users_customuser"  # 必须和Django生成的表名完全一致
    id: Mapped[int] = mapped_column(Integer, primary_key=True)
    # 无需添加其他字段，仅主键即可让SQLAlchemy识别表结构

将这个模型加入Alembic的env.py加载逻辑中，确保自动生成迁移时SQLAlchemy能读取到该表的元数据。

2. 使用ForeignKeyConstraint直接定义约束 #

如果你不想创建影子模型，可以用ForeignKeyConstraint替代ForeignKey，让SQLAlchemy直接生成数据库层面的外键约束，不依赖模型元数据的解析：

from sqlalchemy import Integer, ForeignKeyConstraint
from sqlalchemy.orm import DeclarativeBase, mapped_column

class SomeSAModel(DeclarativeBase):
    __tablename__ = "some_sa_model"
    user_id: Mapped[int] = mapped_column(Integer)
    
    # 在类的__table_args__中定义外键约束
    __table_args__ = (
        ForeignKeyConstraint(
            ["user_id"],
            ["users_customuser.id"],
            # 若使用PostgreSQL，添加此参数确保直接引用数据库中的表
            postgresql_ignore_search_path=True
        ),
    )

3. 临时禁用Alembic的表排序检查（不推荐） #

仅适用于临时场景，在Alembic的env.py中禁用外键依赖排序，可能导致迁移脚本的表创建顺序错误：

# 在env.py的run_migrations_online函数中修改配置
context.configure(
    # 保留原有配置...
    compare_type=True,
    compare_server_default=True,
    # 禁用外键驱动的表排序
    sort_tables=False
)

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