Drizzle ORM 中 Postgres 表名含连字符导致的主键约束问题解析

在使用 Drizzle ORM 和 Drizzle Kit 进行数据库迁移时，开发者可能会遇到一个与 Postgres 表命名规范相关的特殊问题。当表名中包含连字符("-")并且该表使用了复合主键时，执行 drizzle-kit push 命令会出现语法错误。

问题背景

PostgreSQL 数据库对标识符(如表名、列名、约束名等)有严格的命名规则。默认情况下，PostgreSQL 会将未加引号的标识符转换为小写，并且不允许标识符中包含特殊字符如连字符("-")。然而，当使用双引号包裹标识符时，PostgreSQL 允许使用这些特殊字符并保留大小写。

问题表现

在 Drizzle ORM 中，如果开发者定义了一个包含连字符的表名并为其设置了复合主键，例如名为"example-table"的表，Drizzle Kit 生成的迁移语句会尝试创建名为"example-table_userId_credentialID_pk"的主键约束。由于这个约束名包含连字符且未被引号包裹，PostgreSQL 会拒绝执行这条语句，抛出"syntax error at or near "-""的错误。

技术原理

PostgreSQL 的约束命名遵循与表名相同的规则。当 Drizzle Kit 自动生成约束名时，它会将表名与相关列名拼接起来形成约束名。对于包含特殊字符的表名，这种拼接方式会产生无效的标识符，除非整个约束名被双引号包裹。

解决方案

该问题已在 Drizzle Kit 的 0.28.0 版本中得到修复。新版本会正确处理包含特殊字符的表名，确保生成的约束名被适当引用。开发者只需将 Drizzle Kit 升级到 0.28.0 或更高版本即可解决此问题。

最佳实践

1. 升级工具链：始终使用最新稳定版的 Drizzle ORM 和 Drizzle Kit 以避免已知问题
2. 命名规范：虽然 PostgreSQL 支持特殊字符表名，但建议尽量使用下划线(_)代替连字符(-)以避免潜在问题
3. 显式命名：对于重要约束，考虑显式指定约束名而非依赖自动生成
4. 测试验证：在开发环境中充分测试迁移脚本，特别是当使用非标准命名时

总结

数据库迁移工具需要特别注意不同数据库系统的标识符处理规则。Drizzle ORM 团队通过及时修复此问题，展示了他们对跨数据库兼容性的重视。作为开发者，理解底层数据库的规则有助于更好地使用 ORM 工具，并在遇到问题时能够快速定位原因。