Drizzle ORM 复合主键迁移生成问题解析

问题背景

在使用Drizzle ORM进行数据库迁移时，开发者发现当使用复合主键(Composite Primary Key)定义表结构时，生成的迁移SQL文件没有包含预期的复合主键约束。这个问题主要出现在PostgreSQL数据库环境中。

问题表现

开发者最初尝试使用以下方式定义表结构：

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

期望生成的SQL应该包含复合主键约束，类似这样：

CREATE TABLE "verificationToken" (
    "identifier" text NOT NULL,
    "token" text NOT NULL,
    "expires" timestamp NOT NULL,
    CONSTRAINT "verificationToken_pkey" PRIMARY KEY ("identifier", "token")
);

但实际生成的迁移文件只包含表创建语句，没有主键约束：

CREATE TABLE "verificationToken" (
  "identifier" text NOT NULL,
  "token" text NOT NULL,
  "expires" timestamp NOT NULL
);

解决方案

经过社区讨论，发现正确的定义方式应该是直接返回primaryKey数组，而不是将其包装在对象中：

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

这种写法会正确生成包含复合主键的SQL语句：

CREATE TABLE "verificationToken" (
    "identifier" text NOT NULL,
    "token" text NOT NULL,
    "expires" timestamp NOT NULL,
    CONSTRAINT "verificationToken_identifier_token_pk" PRIMARY KEY("identifier","token")
);

技术细节

Drizzle ORM的表定义语法中，第三个参数是一个返回约束数组的函数。当返回的是直接包含primaryKey的数组时，迁移工具能够正确识别并生成相应的SQL约束。但如果将primaryKey包装在对象中（如示例中的compositePk属性），迁移工具就无法正确解析这个约束。

最佳实践

1. 定义复合主键时，直接返回primaryKey数组
2. 避免将约束包装在额外的对象结构中
3. 迁移生成后，检查SQL文件确认约束是否正确生成
4. 对于复杂的约束关系，考虑分步验证迁移结果

总结

这个问题揭示了Drizzle ORM在约束定义语法解析上的一个特定行为。开发者需要注意约束定义的直接性，避免不必要的嵌套结构。虽然官方文档中展示了嵌套的写法，但实际使用中直接返回约束数组才是正确的方式。这也提醒我们在使用ORM工具时，当遇到不符合预期的行为时，可以尝试简化定义方式或查阅社区讨论来寻找解决方案。