Drizzle ORM 复合主键配置问题解析

Drizzle ORM 是一个新兴的 TypeScript ORM 框架，近期在复合主键配置方面出现了一个值得开发者注意的问题。本文将深入分析该问题的表现、原因以及解决方案。

问题现象

在使用 Drizzle ORM 0.38.4 版本时，开发者按照官方文档配置复合主键时发现生成的数据库表结构中缺少预期的复合主键约束。具体表现为：

1. 在定义多对多关系表时，虽然按照文档示例配置了复合主键
2. 执行迁移命令后，生成的表结构中只有普通列，没有主键约束
3. 检查生成的 SQL 文件，发现缺少 PRIMARY KEY 和 ALTER TABLE 等约束语句

问题根源

经过技术社区的分析，这个问题源于文档中的示例代码使用了不正确的语法格式。文档示例中返回的是一个包含主键配置对象的数组，而实际上应该返回一个包含约束配置的对象。

正确配置方式

正确的复合主键配置应该采用以下形式：

export const booksToAuthors = pgTable("books_to_authors", {
  authorId: integer("author_id"),
  bookId: integer("book_id"),
}, (table) => ({
  pk: primaryKey({ columns: [table.bookId, table.authorId] }),
  pkWithCustomName: primaryKey({ name: 'custom_name', columns: [table.bookId, table.authorId] }),
}));

关键区别在于：

1. 回调函数返回的是一个对象而非数组
2. 每个约束配置作为对象的属性存在

最佳实践建议

1. 关系完整性：虽然复合主键已经能够确保记录唯一性，但建议同时添加外键约束以确保数据完整性
2. 命名规范：为复合主键指定有意义的名称，便于后期维护
3. 版本兼容性：注意不同版本间的语法差异，及时查阅最新文档
4. 测试验证：执行迁移后应实际检查数据库结构，确认约束是否生效

总结

Drizzle ORM 作为新兴的 ORM 解决方案，在快速发展过程中难免会出现文档与实现不完全同步的情况。开发者在使用时应当保持警惕，遇到问题时可以查阅社区讨论或直接检查生成的 SQL 语句。复合主键作为数据库设计中的重要概念，正确配置对于保证数据完整性至关重要。