Kysely 中处理数组类型列查询的最佳实践

数组类型列查询的常见问题

在使用 Kysely 进行数据库查询时，处理数组类型的列经常会遇到类型匹配问题。特别是在 PostgreSQL 中，我们经常需要使用 ANY 操作符来检查某个值是否存在于数组中。

问题背景

当我们需要查询一个值是否存在于数组类型的列中时，通常会遇到两种主要情况：

1. 数组列被定义为非空（NOT NULL）
2. 数组列允许为空（NULLABLE）

对于第一种情况，查询相对简单，因为我们可以直接使用 ANY 操作符。但对于第二种情况，由于列可能为 NULL，直接使用 ANY 会导致类型错误。

解决方案比较

方案一：使用 COALESCE 处理 NULL 值

最稳健的解决方案是使用 COALESCE 函数为可能为 NULL 的数组列提供默认值：

import { sql } from "kysely";

await db
  .selectFrom("recipients as r")
  .leftJoin("category_groups as cg", "cg.name", "r.name")
  .where(({ eb, fn }) =>
    eb(
      "cg.pid",
      "=",
      fn.any(fn.coalesce("r.serviceGroups", sql<[]>`'{}'`)),
    ),
  )
  .select(["r.name"])
  .execute();

这种方法明确处理了 NULL 情况，将 NULL 转换为空数组，确保 ANY 操作符始终接收一个数组。

方案二：使用原始 SQL 片段

另一种方法是直接使用原始 SQL 片段：

.where((e) => sql`${e.ref('c.category_group_pid')} = ANY(${e.ref('r.service_groups')})`)

这种方法更加灵活，但牺牲了一些类型安全性，因为 TypeScript 无法完全验证 SQL 片段的正确性。

类型系统注意事项

Kysely 的类型系统会严格检查 ANY 操作符的参数是否为数组类型。当列被定义为 string[] | null 时，直接使用会导致类型错误，因为 TypeScript 无法保证运行时值不为 NULL。

最佳实践建议

1. 优先使用 COALESCE：对于可能为 NULL 的数组列，始终使用 COALESCE 提供默认值
2. 考虑数据库模式设计：如果业务允许，将数组列设为 NOT NULL 可以简化查询
3. 类型定义一致性：确保 ORM 定义（如 Drizzle）与 Kysely 生成的类型一致
4. 避免过度使用原始 SQL：虽然灵活，但会降低类型安全性

总结

处理 Kysely 中的数组类型列查询时，理解 TypeScript 类型系统与 PostgreSQL 类型系统的交互至关重要。通过合理使用 COALESCE 或原始 SQL 片段，可以构建既类型安全又功能强大的查询。选择哪种方案取决于项目对类型安全性和灵活性的具体需求。