在Peewee中安全更新MySQL外键约束以添加ON DELETE CASCADE

在Peewee ORM项目中，当我们需要为已有外键关系添加ON DELETE CASCADE约束时，直接使用迁移工具可能会导致数据丢失。本文将详细介绍如何安全地实现这一需求。

问题背景

在数据库设计中，外键约束的级联删除(ON DELETE CASCADE)是一个重要特性，它确保当父表记录被删除时，相关的子表记录也会自动删除。然而，在Peewee项目中，如果初期没有设置这一约束，后期想要添加时可能会遇到挑战。

常见错误做法

许多开发者会尝试使用Peewee的迁移工具直接删除并重新添加外键列：

migrator.drop_column('child_table', 'foreign_key_column')
migrator.add_column('child_table', 'foreign_key_column', 
                   ForeignKeyField(model=Parent, on_delete='CASCADE'))

这种做法会导致两个问题：

1. 数据丢失：删除列会永久删除该列的所有数据
2. MySQL的事务限制：MySQL不支持DDL语句的事务性操作

正确解决方案

正确的方法是直接修改现有外键约束，而不是删除并重建列。这需要执行以下SQL操作：

-- 第一步：删除现有外键约束
ALTER TABLE child_table DROP FOREIGN KEY existing_constraint_name;

-- 第二步：添加带CASCADE选项的新约束
ALTER TABLE child_table ADD CONSTRAINT new_constraint_name
    FOREIGN KEY (foreign_key_column)
    REFERENCES parent_table(id) 
    ON DELETE CASCADE;

Peewee中的实现

我们可以将这些操作封装为可重用的函数：

def get_foreign_key_constraint_name(model_class, field_name):
    """获取外键约束名称"""
    query = """
        SELECT constraint_name 
        FROM information_schema.key_column_usage 
        WHERE table_name=%s AND column_name=%s
    """
    cursor = db.execute_sql(query, (model_class._meta.table_name, field_name))
    return cursor.fetchone()[0]

def add_cascade_delete_constraint(model_class, field_name):
    """为指定字段添加ON DELETE CASCADE约束"""
    field = getattr(model_class, field_name)
    constraint_name = get_foreign_key_constraint_name(model_class, field_name)
    
    drop_sql = 'ALTER TABLE `%s` DROP FOREIGN KEY `%s`' % (
        model_class._meta.table_name, constraint_name)
    
    add_sql = 'ALTER TABLE `%s` ADD CONSTRAINT `%s` ' \
              'FOREIGN KEY (`%s`) REFERENCES `%s`(`%s`) ' \
              'ON DELETE CASCADE' % (
                  model_class._meta.table_name,
                  constraint_name,
                  field.column_name,
                  field.rel_model._meta.table_name,
                  field.rel_field.column_name)
    
    db.execute_sql(drop_sql)
    db.execute_sql(add_sql)

使用示例

# 为ServiceExecutionPartition表的execution字段添加CASCADE约束
add_cascade_delete_constraint(ServiceExecutionPartition, 'execution')

# 为ServiceExecution表的query_service字段添加CASCADE约束
add_cascade_delete_constraint(ServiceExecution, 'query_service')

注意事项

1. 执行前务必备份数据库
2. 在生产环境执行前先在测试环境验证
3. 大型表可能需要较长时间执行
4. 确保应用在修改期间没有活跃的写操作

通过这种方法，我们可以安全地为现有外键关系添加ON DELETE CASCADE约束，而不会丢失任何数据。