如何在Drizzle ORM中声明自引用外键并解决TS类型问题

问题场景 #

在TypeScript项目中使用Drizzle ORM定义自引用表时：

const contractsTable = pgTable("contracts", {
    id: serial("id").primaryKey(),
    underlyingId: integer("underlying_id").references(() => contractsTable.id),
    // ...其他字段
})

会触发TypeScript错误：

'contractsTable' implicitly has type 'any' because it does not have a type annotation and is referenced directly or indirectly in its own initializer.

由于架构庞大且频繁变更，维护手动类型不现实，尝试别名或类型转换也无法让TypeScript正确推断类型。同时需要保留数据库层面的外键约束，且已定义如下关系：

const contractsRelations = relations(
    contractsTable,
    ({ one, many }) => ({
        underlying: one(contractsTable, {
            fields: [contractsTable.underlyingId],
            references: [contractsTable.id],
        }),
        // ...其他关系
    })
);

可行解决方案 #

方案1：提前声明类型占位符

通过declare提前告知TypeScript表的类型，避免自引用时的any推断：

// 提前声明表的类型占位符，复用pgTable的返回类型
declare const contractsTable: ReturnType<typeof pgTable>;

const contractsTable = pgTable("contracts", {
  id: serial("id").primaryKey(),
  underlyingId: integer("underlying_id").references(() => contractsTable.id),
  // ...其他字段
});

这个方法无需手动维护复杂类型，完全依赖Drizzle的自动类型推断，适合架构多变的场景。

方案2：拆分字段定义与表创建

将非自引用字段和自引用字段拆分，延迟自引用字段的初始化时机：

// 先定义无自引用的基础字段
const contractBaseFields = {
  id: serial("id").primaryKey(),
  // ...其他非自引用字段
};

// 创建表时合并字段，用箭头函数延迟获取已初始化的表
const contractsTable = pgTable("contracts", {
  ...contractBaseFields,
  underlyingId: integer("underlying_id").references(() => contractsTable.id),
});

通过拆分让TypeScript先推断出基础表的类型，再处理自引用部分，同样不需要手动维护类型。

方案3：手动添加表级外键约束

如果前两种方案仍有类型问题，可以将外键约束移到表的第二个参数中定义，避免字段定义时的自引用：

const contractsTable = pgTable("contracts", {
  id: serial("id").primaryKey(),
  underlyingId: integer("underlying_id"),
  // ...其他字段
}, (table) => ({
  // 手动定义数据库层面的外键约束
  underlyingFk: foreignKey({
    columns: [table.underlyingId],
    foreignColumns: [table.id],
    name: "contracts_underlying_id_fk" // 可选：指定约束名称
  })
}));

// 关系定义保持不变
const contractsRelations = relations(
  contractsTable,
  ({ one }) => ({
    underlying: one(contractsTable, {
      fields: [contractsTable.underlyingId],
      references: [contractsTable.id],
    }),
    // ...其他关系
  })
);

这种方式既保证了数据库层面的外键约束，又能让TypeScript正常推断表的类型，同时关系定义不受影响。

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