删除含OneToMany关联的实体时FOREIGN KEY约束失败求助

尝试删除包含OneToMany关联的TaskGroupEntity实体时，控制台抛出如下错误：

query failed:  DELETE FROM "task_group_entity" WHERE "id" = ? -- PARAMETERS: ["63361153-83cc-49b8-ba12-19f54e0519a2"]
error:  Error: Run: RunSQL: run: FOREIGN KEY constraint failed

实体代码 #

关联拥有方（TaskGroupEntity） #

@Entity()
export class TaskGroupEntity {

    @PrimaryGeneratedColumn("uuid")
    id: string;

    @Column('datetime', { nullable: true })
    dayTaskDate: Date | null;

    @Column('text', { nullable: true })
    name: string | null;

    @Column('text', { nullable: true })
    description: string | null;

    @OneToMany(() => TaskEntity, task => task.taskGroup, { nullable: true, cascade: true, onDelete: "CASCADE" })
    tasks: (TaskEntity | null)[];

    @Column('text', { nullable: true })
    color: string | null;

    @Column('text', { nullable: true })
    icon: string | null;

    // 已在关联另一方添加cascade: true，该字段似乎与问题无关
    @ManyToMany(() => TagEntity, tag => tag.taskGroups, { nullable: true, onDelete: "CASCADE" })
    @JoinTable()
    tags: (TagEntity | null)[];

    @CreateDateColumn()
    createDate: Date;

    @DeleteDateColumn()
    deleteDate: Date;

    @Column('datetime', { nullable: true })
    deadLineDate: Date | null;

    @Column('text')
    repeatMode: RepeatMode;

    @Column('simple-json', { nullable: true })
    repeatCustom: RepeatCustom | null;

}

关联另一方（TaskEntity） #

@Entity()
export class TaskEntity {

    @PrimaryGeneratedColumn("uuid")
    id: string;

    // ...

    @ManyToOne(() => TaskGroupEntity, taskGroup => taskGroup.tasks, { nullable: true })
    taskGroup: TaskGroupEntity | null;

    @ManyToOne(() => TaskEntity, task => task.childTasks, { nullable: true })
    parentTask: TaskEntity | null;

    @OneToMany(() => TaskEntity, task => task.parentTask, { nullable: true })
    childTasks: TaskEntity[] | null[];

}

已尝试的解决方法 #

• 在OneToMany注解中添加onDelete: "CASCADE"，仍报错；
• 将onDelete设为SET NULL，依旧报错；
• 使用softDelete可成功删除，但hardDelete时错误重现；
• 删除无关联的实体时无报错。

正确的解决步骤 #

1. 调整外键约束的配置位置 #

外键约束实际存在于**多的一方（TaskEntity）**的taskGroup字段对应的数据库列上，所以需要在TaskEntity的@ManyToOne注解中添加onDelete: "CASCADE"，而不是仅在TaskGroupEntity的@OneToMany里设置。修改后的TaskEntity代码如下：

@ManyToOne(() => TaskGroupEntity, taskGroup => taskGroup.tasks, { nullable: true, onDelete: "CASCADE" })
taskGroup: TaskGroupEntity | null;

2. 更新数据库表结构 #

之前的表结构可能没有生成带ON DELETE CASCADE规则的外键，需要同步数据库：

• 开发环境可直接在TypeORM配置中开启synchronize: true，重启服务后会自动更新表结构；
• 生产环境建议生成迁移文件并执行：

  # 生成迁移文件
  typeorm migration:generate -n AddOnDeleteCascadeToTaskGroup
  # 执行迁移
  typeorm migration:run
  

3. 可选：手动级联删除（临时 workaround） #

如果暂时无法更新表结构，可以先查询并删除当前TaskGroup关联的所有Task，再删除TaskGroup：

const taskGroup = await taskGroupRepository.findOne({ where: { id: "xxx" }, relations: ["tasks"] });
if (taskGroup) {
  await taskRepository.remove(taskGroup.tasks);
  await taskGroupRepository.remove(taskGroup);
}

关键原理说明 #

• TypeORM中OneToMany上的onDelete配置不会影响数据库层面的外键约束，只有ManyToOne一侧的onDelete才会生成对应的数据库外键规则；
• CASCADE规则会让数据库在删除TaskGroup时，自动删除所有关联的Task实体，避免触发外键约束错误；
• softDelete之所以成功，是因为它只是标记deleteDate字段，并没有实际删除数据库中的记录，所以不会触发外键检查。

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