Drizzle ORM 中复合主键的正确声明方式

在 Drizzle ORM 的最新版本中，声明复合主键的语法发生了变化，这导致了一些开发者在使用过程中遇到了困惑。本文将详细介绍新旧语法的区别以及正确的使用方法。

问题背景

许多开发者在使用 Drizzle ORM 创建关联表时，习惯使用对象语法来声明复合主键。例如：

export const expiredWarrantyToWarrantor = pgTable(
  "warrantor_to_expired_warranty",
  {
    warrantorId: uuid("warrantorId")
      .references(() => warrantors.id)
      .notNull(),
    expiredWarrantyId: uuid("expiredWarrantyId")
      .references(() => expiredWarranties.id)
      .notNull(),
  },
  (table) => {
    return {
      pk: primaryKey({ columns: [table.warrantorId, table.expiredWarrantyId] })
    };
  }
);

这种写法在较新版本的 Drizzle ORM 中会被标记为已弃用(deprecated)，尽管文档中可能还未完全更新。

新语法规范

Drizzle ORM 现在推荐使用数组语法来声明约束，包括复合主键。正确的写法应该是：

export const expiredWarrantyToWarrantor = pgTable(
  "warrantor_to_expired_warranty",
  {
    warrantorId: uuid("warrantorId")
      .references(() => warrantors.id)
      .notNull(),
    expiredWarrantyId: uuid("expiredWarrantyId")
      .references(() => expiredWarranties.id)
      .notNull(),
  },
  (table) => {
    return [
      primaryKey({ columns: [table.warrantorId, table.expiredWarrantyId] })
    ];
  }
);

新旧语法对比

为了更清楚地展示区别，我们来看一个完整的对比示例：

// 旧语法（已弃用）
export const booksToAuthorsOld = pgTable(
  "books_to_authors_old",
  {
    authorId: integer("author_id"),
    bookId: integer("book_id")
  },
  (table) => {
    return {
      pk: primaryKey({ columns: [table.bookId, table.authorId] }),
      pkWithCustomName: primaryKey({
        name: "custom_name",
        columns: [table.bookId, table.authorId]
      })
    };
  }
);

// 新语法（推荐）
export const booksToAuthorsNew = pgTable(
  "books_to_authors_new",
  {
    authorId: integer("author_id"),
    bookId: integer("book_id")
  },
  (table) => {
    return [
      {
        pk: primaryKey({ columns: [table.bookId, table.authorId] }),
        pkWithCustomName: primaryKey({
          name: "custom_name",
          columns: [table.bookId, table.authorId]
        })
      }
    ];
  }
);

迁移注意事项

1. 语法结构变化：从返回对象改为返回数组
2. 迁移生成影响：确保使用新语法生成的迁移文件包含正确的约束
3. 文档参考：虽然官方文档可能尚未完全更新，但建议遵循新语法规范

常见问题解决

如果发现即使使用了新语法，复合主键约束仍未正确生成，可以尝试以下步骤：

1. 检查 Drizzle ORM 和 Drizzle Kit 的版本是否匹配
2. 确保所有相关依赖都已更新到最新版本
3. 清理并重新生成迁移文件

通过遵循这些新的语法规范，开发者可以避免弃用警告，并确保数据库约束被正确生成和应用。