Drizzle ORM 中枚举类型查询的注意事项

在使用 Drizzle ORM 进行 PostgreSQL 数据库操作时，开发者可能会遇到一个看似简单但容易忽略的问题：当使用枚举类型进行查询时，查询结果不符合预期。本文将通过一个实际案例，深入分析这个问题及其解决方案。

问题现象

在 Drizzle ORM 0.32.0 版本中，开发者定义了一个包含枚举类型的用户表：

export const userRoleEnum = pgEnum("role", ["user", "admin"])

export const users = pgTable("user", {
  id: text("id").primaryKey().$defaultFn(() => crypto.randomUUID()),
  name: text("name"),
  email: text("email").notNull(),
  phone: text("phone"),
  role: userRoleEnum("role"),
  emailVerified: timestamp("emailVerified", { mode: "date" }),
  image: text("image"),
})

当尝试使用 findFirst 方法查询具有特定角色的用户时：

const user = await db.query.users.findFirst({
  where: eq(users.role, "admin"),
})

尽管数据库中确实存在符合条件的记录，但查询结果却返回了 undefined。

问题分析

经过仔细排查，发现问题根源在于表名定义与实际查询时的不一致：

1. 在表定义中，表名被指定为 "user"（单数形式）
2. 但在查询时，开发者使用了 db.query.users（复数形式）

这种命名不一致导致了查询无法正确执行。Drizzle ORM 对表名是区分大小写和单复数形式的，必须严格匹配才能正常工作。

解决方案

要解决这个问题，有两种方法：

1. 统一使用单数形式： 修改查询代码，使其与表定义一致：

   const user = await db.query.user.findFirst({
     where: eq(users.role, "admin"),
   })
   

2. 修改表定义使用复数形式： 如果项目约定使用复数形式，可以修改表定义：

   export const users = pgTable("users", {
     // 字段定义保持不变
   })
   

最佳实践建议

1. 保持命名一致性：在整个项目中统一表名的单复数形式，避免混淆
2. 使用类型检查：TypeScript 的类型系统可以帮助捕获这类错误，确保开发时就能发现问题
3. 注意枚举类型使用：虽然本案例的主要问题是表名，但枚举类型在 Drizzle ORM 中的使用也需要特别注意，确保传入的值与枚举定义完全匹配

总结

这个案例展示了在使用 ORM 工具时，细节的重要性。即使是简单的命名不一致，也可能导致难以察觉的问题。通过这个例子，我们了解到 Drizzle ORM 对表名的严格处理方式，以及保持代码一致性的重要性。

对于使用 Drizzle ORM 的开发者来说，理解这些细节可以帮助避免类似的陷阱，提高开发效率和代码质量。