Drizzle ORM 复合主键配置的正确方式

在使用 Drizzle ORM 进行数据库建模时，复合主键(Composite Primary Key)是一个常见的需求。然而，近期有开发者反馈在使用 drizzle-kit 工具推送表结构时遇到了复合主键未被正确创建的问题。

问题现象

开发者在使用最新版本的 drizzle-kit (0.30.2) 时，发现按照文档示例配置的复合主键没有被正确推送到数据库。具体表现为：

1. 使用了类似以下的结构定义表：

export const verificationTokens = pgTable(
  "verificationToken",
  {
    identifier: text("identifier").notNull(),
    token: text("token").notNull(),
    expires: timestamp("expires", { mode: "date" }).notNull(),
  },
  (vt) => [
    {
      compositePk: primaryKey({
        columns: [vt.identifier, vt.token],
      }),
    },
  ],
);

2. 但实际生成的表结构中缺少预期的复合主键约束

问题根源

经过深入分析，发现问题出在 Drizzle ORM 的 API 变更上。最新版本中，配置复合主键的方式已经发生了变化：

1. 旧版本允许在返回的数组中使用对象形式配置约束
2. 新版本要求直接返回主键约束实例，而不是将其包装在对象中

正确配置方式

根据最新版本的 Drizzle ORM，正确的复合主键配置应该是：

export const verificationTokens = pgTable(
  "verificationToken",
  {
    identifier: text("identifier").notNull(),
    token: text("token").notNull(),
    expires: timestamp("expires", { mode: "date" }).notNull(),
  },
  (vt) => [
    primaryKey({
      columns: [vt.identifier, vt.token],
    }),
  ],
);

关键区别在于：

• 直接返回 primaryKey() 函数调用的结果
• 不再需要将主键约束包装在带有自定义名称的对象中

注意事项

1. 文档可能尚未完全同步更新，开发者需要注意 API 变更
2. 使用旧格式时，虽然不会报错，但会导致约束未被正确创建
3. 这种变更属于破坏性变更(breaking change)，升级版本时需要特别注意

最佳实践

对于 Drizzle ORM 的新用户，建议：

1. 始终查阅对应版本的官方文档
2. 在升级版本时，仔细阅读变更日志
3. 对于关键约束，建议在推送后验证数据库结构是否符合预期

通过采用正确的配置方式，开发者可以确保复合主键等约束被正确创建，保证数据完整性和查询性能。