Drizzle ORM 中复合主键生成SQL的引号问题解析

在使用Drizzle ORM框架时，开发者在定义PostgreSQL表的复合主键时可能会遇到一个常见的SQL语法问题。当表字段使用camelCase命名风格时，自动生成的迁移SQL语句会缺少必要的引号，导致执行失败。

问题现象

当开发者定义如下表结构时：

export const accounts = pgTable(
  'account',
  {
    userId: text('userId'),
    providerAccountId: text('providerAccountId').notNull()
  },
  (account) => ({
    compoundKey: primaryKey({
      columns: [account.provider, account.providerAccountId],
      name: 'compound_pk',
    }),
  })
)

Drizzle Kit生成的迁移SQL会输出：

ALTER TABLE "account" ADD CONSTRAINT compound_pk PRIMARY KEY(provider,providerAccountId);

这个SQL语句在PostgreSQL中执行时会报错，因为PostgreSQL对大小写敏感，providerAccountId字段名需要被引号包裹。

技术背景

PostgreSQL在处理标识符时有以下特点：

1. 不区分大小写的标识符不需要引号
2. 包含大写字母或特殊字符的标识符需要双引号包裹
3. 使用引号可以保留标识符的原始大小写形式

在Drizzle ORM中，当使用camelCase命名字段时，生成的SQL必须正确处理这些命名约定，否则会导致迁移失败。

解决方案

这个问题在Drizzle ORM的新版本中已经得到修复。升级到最新版本后，生成的SQL会正确添加引号：

ALTER TABLE "account" ADD CONSTRAINT compound_pk PRIMARY KEY(provider,"providerAccountId");

最佳实践

1. 保持Drizzle ORM和Drizzle Kit版本同步更新
2. 对于PostgreSQL数据库，考虑使用snake_case命名风格以避免引号问题
3. 在定义复合主键时，检查生成的SQL语句是否符合数据库要求
4. 定期检查项目依赖，确保使用修复了已知问题的版本

总结

数据库迁移工具生成的SQL语句必须严格遵循目标数据库的语法规则。Drizzle ORM团队已经意识到这个问题并在新版本中修复了引号处理逻辑。开发者应该保持工具链的更新，同时了解底层数据库的标识符处理规则，以便在遇到类似问题时能够快速定位和解决。