Drizzle ORM 中 PostgreSQL 枚举类型和大小写敏感问题的解决方案

问题背景

在使用 Drizzle ORM 进行 PostgreSQL 数据库迁移时，开发者可能会遇到两类常见问题：大小写敏感导致的列不存在错误，以及枚举类型未正确创建的问题。这些问题通常会在执行 drizzle-kit migrate 命令时显现。

大小写敏感问题分析

PostgreSQL 有一个重要特性：默认情况下会将所有未加引号的标识符转换为小写。这意味着当我们在 Drizzle ORM 中定义表结构时：

export const user = pgTable(
  "user",
  {
    id: serial("id").primaryKey(),
    testId: string("testId"),  // 注意这里的驼峰命名
  },
  (table) => ({
    testIdx: index("testidx").on(table.testId),
  }),
);

PostgreSQL 会尝试查找名为 testid 的列（自动转换为小写），而不是 testId。这就会导致 "column does not exist" 错误。

解决方案

1. 遵循 PostgreSQL 命名规范：使用小写字母和下划线（snake_case）命名列

   test_id: string("test_id")
   

2. 保持代码一致性：虽然数据库中使用 snake_case，但在应用代码中可以保持驼峰命名

   testId: string("test_id")
   

3. 避免特殊字符：不要在列名中使用连字符等特殊字符

枚举类型问题分析

另一个常见问题是枚举类型未正确创建：

export const fileTypeEnum = pgEnum('fileType', ['image/jpeg', 'application/pdf'])

export const files = pgTable('files', {
  // ...
  type: fileTypeEnum('type').notNull(),
})

执行迁移时可能会遇到 "type does not exist" 错误，这是因为枚举类型的创建顺序可能不正确。

解决方案

1. 确保枚举被导出：检查是否在枚举定义前添加了 export 关键字

2. 清理并重新生成迁移：

   rm -rf migrations/
   npx drizzle-kit generate
   npx drizzle-kit migrate
   

3. 检查迁移文件顺序：确保枚举类型的创建迁移在引用它的表迁移之前执行

最佳实践建议

1. 统一命名规范：在整个项目中保持一致的命名规则

2. 迁移前检查：在生成迁移前仔细检查 schema 定义

3. 版本控制：将迁移文件纳入版本控制，方便团队协作

4. 测试环境验证：先在测试环境执行迁移，确认无误后再应用到生产环境

通过遵循这些实践，可以避免大多数与 Drizzle ORM 迁移相关的问题，确保数据库变更顺利执行。