如何使用Alembic修改PostgreSQL外键（添加ondelete="CASCADE"）

不需要删除整个表，只需要删除原有外键约束后重新创建带ondelete="CASCADE"的外键即可——PostgreSQL不支持直接修改外键的ondelete属性，所以必须走删重建的流程。

具体操作步骤： #

1. 生成空迁移文件
   运行以下命令创建一个新的迁移脚本：

alembic revision -m "add ondelete cascade to items.user_id"

2. 手动编写迁移逻辑
   打开生成的迁移文件，替换upgrade和downgrade函数内容：

from alembic import op
import sqlalchemy as sa

def upgrade():
    # 删除原有外键约束（PostgreSQL默认外键命名为 items_user_id_fkey，可通过\d items命令确认）
    op.drop_constraint(
        "items_user_id_fkey",
        "items",
        type_="foreignkey"
    )
    # 重建带ON DELETE CASCADE的外键
    op.create_foreign_key(
        "items_user_id_fkey",  # 复用原约束名，也可自定义新名称
        source_table="items",
        referent_table="users",
        local_cols=["user_id"],
        remote_cols=["id"],
        ondelete="CASCADE"
    )

def downgrade():
    # 回滚操作：删除带CASCADE的外键，重建原外键
    op.drop_constraint(
        "items_user_id_fkey",
        "items",
        type_="foreignkey"
    )
    op.create_foreign_key(
        "items_user_id_fkey",
        source_table="items",
        referent_table="users",
        local_cols=["user_id"],
        remote_cols=["id"]
    )

注意事项： #

• 确认外键名称：如果不确定原有外键的准确名称，可登录PostgreSQL数据库，执行\d items命令查看items表的约束列表，找到对应外键的名称。
• 自动生成的局限性：alembic revision --autogenerate通常无法检测到外键ondelete属性的变更，所以手动编写迁移代码是更可靠的方式。
• 数据安全：修改外键约束不会影响现有数据，但建议执行迁移前备份数据库，避免意外问题。

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