Tortoise-ORM 外键约束错误分析与解决方案

问题背景

在使用 Tortoise-ORM 进行数据库迁移时，开发者遇到了一个常见的外键约束错误："errno: 150 'Foreign key constraint is incorrectly formed'"。这个错误通常出现在创建包含外键关系的表时，表明外键约束的定义存在问题。

错误场景分析

在案例中，开发者定义了两个模型：User 和 MusicPlaylist。MusicPlaylist 模型通过外键关联到 User 模型，并且设置了 unique_together 约束确保每个用户的播放列表名称唯一。

class User(Model):
    user_id = fields.BigIntField(primary_key=True, unique=True)
    # 其他字段...

class MusicPlaylist(Model):
    user = fields.ForeignKeyField(
        "models.User", related_name="music", on_delete=fields.CASCADE
    )
    name = fields.TextField()
    tracks = fields.JSONField(default=list)

    class Meta:
        unique_together = ("user", "name")

错误原因深度解析

1. 文本字段作为唯一约束的问题：

   • 在 MySQL/MariaDB 中，TEXT 类型的字段不能直接用于唯一约束或索引
   • 需要指定长度限制，改为使用 CharField 并设置 max_length

2. 外键约束的完整性要求：

   • 外键引用的字段必须是主键或具有唯一约束
   • 确保引用的字段类型完全匹配（包括符号属性）

3. Tortoise-ORM 版本兼容性：

   • 旧版本可能存在一些迁移生成逻辑的问题
   • 更新到最新版本可以解决许多已知问题

解决方案

1. 修改字段类型： 将 TextField 改为 CharField 并指定长度限制：

   name = fields.CharField(max_length=255)  # 根据实际需求调整长度
   

2. 检查外键引用：

   • 确保引用的字段是主键或具有唯一约束
   • 检查字段类型是否完全匹配

3. 更新 ORM 版本：

   pip install --upgrade tortoise-orm aerich
   

4. 重建迁移：

   • 删除旧的迁移文件
   • 重新生成并应用迁移

最佳实践建议

1. 字段类型选择：

   • 对于需要索引或唯一约束的字段，优先使用 CharField 而非 TextField
   • 合理设置 max_length 以平衡存储效率和功能需求

2. 外键设计：

   • 明确指定 on_delete 行为
   • 考虑使用 related_name 便于反向查询

3. 版本管理：

   • 保持 Tortoise-ORM 和 Aerich 工具的最新版本
   • 定期检查更新日志了解兼容性变化

4. 数据库兼容性：

   • 不同数据库对约束的支持有差异
   • 在生产环境前充分测试迁移脚本

总结

Tortoise-ORM 中的外键约束错误通常源于模型定义与数据库引擎限制之间的不匹配。通过理解底层数据库的约束规则、合理设计模型字段，并保持 ORM 工具的最新版本，可以有效地避免这类问题。在遇到类似错误时，建议首先检查字段类型是否适合作为约束条件，其次验证外键引用的完整性，最后考虑更新 ORM 版本以获取更好的兼容性支持。