Kysely 中实现 PostgreSQL ARRAY 子查询的高效方法

背景介绍

Kysely 是一个类型安全的 SQL 查询构建器，用于 TypeScript 和 JavaScript。在处理 PostgreSQL 数据库时，经常需要将子查询结果转换为数组类型。PostgreSQL 提供了两种主要方式来实现这一需求：

1. SELECT ARRAY(SELECT id FROM mytable)
2. SELECT array_agg(id) FROM mytable

第一种方式通常性能更优，但在 Kysely 中需要特殊处理才能实现。

解决方案

基础实现

在 Kysely 中，我们可以使用 sql 模板标签来实现 ARRAY 子查询：

const result = await db
  .selectFrom('userentities')
  .select((eb) => [
    sql<string[]>`array(${eb
      .selectFrom('entitytags')
      .select('tag')
      .whereRef('user_entity', '=', 'userentities.id')})`.as('tags')
  ])
  .execute();

类型安全的辅助函数

为了简化代码并提高类型安全性，可以创建一个辅助函数：

function arraySubquery<T>(subquery: Expression<T>): RawBuilder<T[]> {
  return sql`array(${subquery})`;
}

// 使用示例
const result = await db
  .selectFrom('userentities')
  .select((eb) => [
    arraySubquery(
      eb
        .selectFrom('entitytags')
        .select('tag')
        .whereRef('user_entity', '=', 'userentities.id')
    ).as('tags')
  ])
  .execute();

复杂场景：横向连接与数组过滤

在实际应用中，我们可能需要对生成的数组进行进一步操作，例如过滤：

const query = db
  .selectFrom('userentities')
  .leftJoinLateral(
    (eb) =>
      sql<{ tags: string[] }>`(select array(${eb
        .selectFrom('entitytags')
        .select('tag')
        .whereRef('user_entity', '=', 'userentities.id')}) as "tags")`
        .as<"tags">(sql`tags(tags)`),
    (join) => join.onTrue()
  )
  .where('tags', '&&', ['some', 'tags']);

性能考虑

使用 ARRAY(SELECT...) 而不是 array_agg() 有几个优势：

1. 更早的查询计划：PostgreSQL 可以更早地优化整个查询
2. 内存效率：对于大型结果集，内存使用更高效
3. 并行执行：在某些情况下可以更好地利用并行查询

最佳实践

1. 对于简单的数组聚合，优先使用 arraySubquery 辅助函数
2. 当需要对数组结果进行进一步操作时，考虑使用横向连接
3. 在类型定义上保持精确，确保 TypeScript 能正确推断数组元素类型
4. 对于复杂的数组操作，考虑在数据库层面使用 PostgreSQL 的数组函数

通过以上方法，可以在 Kysely 中高效地实现 PostgreSQL 的数组子查询功能，同时保持代码的类型安全和可维护性。