如何通过TypeORM装饰器实现Nest.js中Benchmark表的无重叠时间段约束？

在我的Nest.js应用中，需要避免当ValidFrom与ValidUntil时间段重叠时向Benchmark表插入数据。原本通过手动执行PostgreSQL迁移脚本实现了该功能：

ALTER TABLE "Benchmark"
ADD CONSTRAINT no_overlap
EXCLUDE USING GIST (
  tsrange("ValidFrom", "ValidUntil", '[]') WITH &&
);

但该方案未被采纳，因为应用的迁移脚本需要由TypeORM生成。请问能否通过TypeORM实现上述避免记录时间段重叠的约束？具体如何操作？

可以通过TypeORM实现该约束，最可靠的方式是自定义迁移脚本，同时保持迁移流程由TypeORM管理，具体步骤如下：

1. 生成空白迁移脚本 #

执行以下命令创建一个新的迁移文件：

nest g migration AddNoOverlapConstraintToBenchmark

2. 编写迁移逻辑 #

在生成的迁移文件中，补充up（添加约束）和down（回滚约束）的方法，直接复用你验证过的SQL逻辑：

import { MigrationInterface, QueryRunner } from 'typeorm';

export class AddNoOverlapConstraintToBenchmark1699999999999 implements MigrationInterface {
  public async up(queryRunner: QueryRunner): Promise<void> {
    // 先确保依赖的btree_gist扩展存在（GIST索引需要该扩展）
    await queryRunner.query(`CREATE EXTENSION IF NOT EXISTS btree_gist;`);
    
    await queryRunner.query(`
      ALTER TABLE "Benchmark"
      ADD CONSTRAINT no_overlap
      EXCLUDE USING GIST (
        tsrange("ValidFrom", "ValidUntil", '[]') WITH &&
      );
    `);
  }

  public async down(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`
      ALTER TABLE "Benchmark"
      DROP CONSTRAINT IF EXISTS no_overlap;
    `);
  }
}

3. 执行迁移 #

运行TypeORM迁移命令，将约束应用到数据库：

npm run typeorm migration:run

补充说明 #

• TypeORM的自动迁移对PostgreSQL专属的EXCLUDE约束支持有限，因此自定义迁移脚本是最直接且能保证逻辑一致性的方案。
• 迁移脚本中的btree_gist扩展是GIST索引的依赖项，若数据库已提前安装可省略该步骤。

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