NestJS TypeORM生成迁移时不必要重建表索引与约束的解决方法

以下是针对该问题的几种实用解决方式：

• 固定索引与约束的显式名称
  TypeORM默认会自动生成索引、外键等约束的名称，这会导致每次生成迁移时，工具误判这些对象为新创建的。在实体定义中手动指定name属性固定名称，让TypeORM能准确识别现有对象：

  @Entity()
  export class User {
    @PrimaryGeneratedColumn()
    id: number;
  
    @Column()
    @Index({ name: 'idx_user_unique_email', unique: true }) // 固定唯一索引名
    email: string;
  
    @ManyToOne(() => Role, {
      nullable: false,
      onDelete: 'CASCADE',
      name: 'fk_user_role' // 固定外键约束名
    })
    @JoinColumn({ name: 'role_id' })
    role: Role;
  }
  

• 添加--diff参数优化迁移对比逻辑
  生成迁移时加上--diff参数，让TypeORM更精准地对比数据库当前schema与实体定义的差异，减少误判重复对象的情况：

  npm run typeorm migration:generate -- -n <migration name> --diff
  

• 配置TypeORM数据源的元数据读取选项
  在data-source.ts（或ormconfig.ts）中，确保TypeORM能正确读取PostgreSQL的schema元数据，避免因元数据读取不全导致重复生成约束：

  import { DataSource } from 'typeorm';
  
  export const AppDataSource = new DataSource({
    type: 'postgres',
    host: 'localhost',
    port: 5432,
    username: 'your-user',
    password: 'your-pass',
    database: 'your-db',
    entities: [__dirname + '/../**/*.entity{.ts,.js}'],
    migrations: [__dirname + '/../migrations/*{.ts,.js}'],
    // 确保读取public schema的元数据（PostgreSQL默认schema）
    schema: 'public',
    synchronize: false,
    migrationsRun: false,
  });
  

• 手动清理冗余迁移代码
  如果以上方法仍有冗余代码生成，生成迁移后手动删除其中重复创建索引、约束的代码块，只保留本次变更需要的逻辑。比如删除await queryRunner.createIndex(...)或await queryRunner.createForeignKey(...)中对应已有对象的代码。

• 检查数据库用户权限
  确认TypeORM使用的数据库用户拥有SELECT权限访问information_schema和pg_catalog系统表，确保TypeORM能正确获取现有索引、约束的元数据，避免因权限不足导致无法识别已有对象。

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