如何在TypeORM中添加AUTO_ID_CACHE选项（无需修改迁移代码）

不想修改迁移代码的话，可以试试下面几种方式：

1. 在实体类中配置数据库特定表选项 #

如果你的数据库支持在CREATE TABLE语句末尾附加AUTO_ID_CACHE参数（比如TiDB），可以直接在实体的@Entity装饰器里通过options字段指定。这种方式会让TypeORM在生成表结构（不管是同步模式还是自动生成迁移）时自动带上该参数。

示例代码：

import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";

@Entity({
  options: {
    AUTO_ID_CACHE: 200 // 设置你需要的缓存值
  }
})
export class YourEntity {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;
}

注意：不同数据库的参数格式可能有差异，部分数据库需要写成字符串形式的SQL片段，比如options: "AUTO_ID_CACHE = 200"，需对应数据库语法调整。

2. 自定义主键列定义注入选项 #

如果AUTO_ID_CACHE和主键自增逻辑绑定，可以通过@PrimaryGeneratedColumn的columnDefinition参数，直接指定包含该选项的完整列SQL，覆盖TypeORM默认生成的列语句。

示例代码：

import { Entity, PrimaryGeneratedColumn, Column } from "typeorm";

@Entity()
export class YourEntity {
  @PrimaryGeneratedColumn({
    type: "int",
    columnDefinition: "INT AUTO_INCREMENT AUTO_ID_CACHE = 200 PRIMARY KEY"
  })
  id: number;

  @Column()
  name: string;
}

3. 用订阅者拦截表创建事件动态修改SQL #

通过TypeORM订阅者监听Schema创建事件，在SQL执行前手动给CREATE TABLE语句追加AUTO_ID_CACHE选项，适合全局给所有表统一配置的场景。

示例代码：

import { EventSubscriber, SchemaCreateEvent, Connection } from "typeorm";

@EventSubscriber()
export class TableAutoIdCacheSubscriber {
  constructor(connection: Connection) {
    connection.subscribers.push(this);
  }

  async beforeSchemaCreate(event: SchemaCreateEvent) {
    event.queries.forEach(query => {
      if (query.sql.startsWith("CREATE TABLE")) {
        // 适配数据库语法，在语句末尾添加参数
        query.sql += " AUTO_ID_CACHE = 200;";
      }
    });
  }
}

将订阅者放在TypeORM能自动扫描到的目录，或在连接配置中手动注册即可生效。

注意事项 #

• 方案有效性取决于目标数据库是否支持AUTO_ID_CACHE参数，需根据数据库语法调整配置细节。
• 前两种方案会让自动生成的迁移代码包含该选项；第三种方案仅在执行迁移时动态修改SQL，不会改变迁移文件本身。

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