在NestJS中使用TypeORM迁移修改PostgreSQL表关联报错排查

问题背景 #

现有file_entity和product_entity两张表，原关联为一对多，需修改为多对一。使用NestJS的TypeORM迁移工具编写迁移代码时，执行出现SQL语法错误，提示syntax error at or near "."。

原迁移代码 #

import type { MigrationInterface, QueryRunner } from 'typeorm';

export class RelationshipInImageCategory1671354171023 implements MigrationInterface {

  public async up(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query('ALTER TABLE file_entity DROP CONSTRAINT ' +
    'public.categories_entity.FK_23cf240bcad452131ad38135723');
    await queryRunner.query('ALTER TABLE product_entity ADD CONSTRAINT ' +
    'FK.file_entity FOREIGN KEY (file_entity.id) REFERENCES file_entity (id)');
  }

  public async down(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query('ALTER TABLE file_entity ADD CONSTRAINT ' +
    'public.categories_entity.FK_23cf240bcad452131ad38135723 ' +
    'FOREIGN KEY (product_entity.id) REFERENCES categories_entity (id)');
    await queryRunner.query('ALTER TABLE product_entity DROP CONSTRAINT ' +
    'FK.file_entity');
  }

}

错误详情 #

{
  "query": "ALTER TABLE file_entity DROP CONSTRAINT public.product_entity.FK_23cf240bcad452131ad38135723",
  "parameters": undefined,
  "driverError": "error: syntax error at or near \".\""
}

错误原因分析 #

1. 约束名称格式错误：PostgreSQL中约束名称不能包含.，原代码里public.categories_entity.FK_xxx的写法违反SQL语法，正确的约束引用应为schema.constraint_name或直接constraint_name，无需在约束名前拼接表名。
2. 外键字段定义错误：添加外键时，(file_entity.id)是错误的——外键字段必须属于当前操作的表（product_entity），而非关联表。
3. 笔误问题：代码中出现未提及的categories_entity，与实际涉及的file_entity、product_entity不符。

修复后的迁移代码 #

import type { MigrationInterface, QueryRunner } from 'typeorm';

export class RelationshipInImageCategory1671354171023 implements MigrationInterface {

  public async up(queryRunner: QueryRunner): Promise<void> {
    // 删除原一对多约束（替换为实际存在的约束名，可通过数据库查询获取）
    await queryRunner.query('ALTER TABLE file_entity DROP CONSTRAINT IF EXISTS "FK_23cf240bcad452131ad38135723"');
    
    // 为product_entity添加关联字段（若不存在则创建）
    await queryRunner.query('ALTER TABLE product_entity ADD COLUMN IF NOT EXISTS file_id uuid');
    
    // 添加多对一外键约束，使用合法的下划线命名
    await queryRunner.query('ALTER TABLE product_entity ADD CONSTRAINT "FK_product_file" FOREIGN KEY (file_id) REFERENCES file_entity (id)');
  }

  public async down(queryRunner: QueryRunner): Promise<void> {
    // 回滚：删除product_entity上的外键约束
    await queryRunner.query('ALTER TABLE product_entity DROP CONSTRAINT IF EXISTS "FK_product_file"');
    
    // 回滚：删除新增的关联字段
    await queryRunner.query('ALTER TABLE product_entity DROP COLUMN IF EXISTS file_id');
    
    // 恢复原一对多约束（修正笔误，替换为正确的字段和表名）
    await queryRunner.query('ALTER TABLE file_entity ADD CONSTRAINT "FK_23cf240bcad452131ad38135723" FOREIGN KEY (product_id) REFERENCES product_entity (id)');
  }

}

关键修复点说明 #

• 约束名称使用下划线替代点号，符合PostgreSQL标识符规范；
• 使用IF NOT EXISTS避免因约束/字段不存在导致的报错；
• 确保外键字段属于当前操作表，修正关联字段的错误指向；
• 修正原代码中的表名笔误，保证逻辑与实际表结构一致；
• 回滚操作与正向操作一一对应，保证迁移的可逆性。

内容的提问来源于stack exchange，提问作者Вадим Иващенко