Kysely 项目中的 json_agg 函数支持列引用功能解析

Kysely 是一个类型安全的 SQL 查询构建器，最近社区讨论了对 PostgreSQL 的 json_agg 函数更完善的支持。本文将深入分析这一功能的实现意义、当前限制以及开发者可以采用的临时解决方案。

json_agg 函数的基本用法

在 PostgreSQL 中，json_agg 是一个强大的聚合函数，它可以将多行数据聚合成一个 JSON 数组。Kysely 目前已经支持了两种基本用法：

1. 以表名为参数的用法，返回 JSON 对象数组：

eb.fn.jsonAgg('pet').as('pets')

2. 以表达式为参数的用法，同样返回 JSON 对象数组

当前缺失的功能支持

社区发现 Kysely 目前缺少对 json_agg 最基础用法的支持 - 直接引用列名。这种用法在实际开发中非常常见，它应该返回一个基础类型的数组而非对象数组。例如：

eb.fn.jsonAgg('pet.name').as('person_pets')

理想情况下，这应该返回 { person_pets: string[] } 类型的结果，但当前 Kysely 的类型系统无法正确处理这种情况。

技术实现难点分析

实现这一功能面临几个技术挑战：

1. 类型系统限制：Kysely 的类型系统需要区分列引用和表引用的不同返回类型
2. 左连接处理：当前左连接表在类型系统中被表示为所有列可为空，这在 json_agg 场景下会导致类型不准确
3. 子查询聚合：在子查询中使用 json_agg 时，类型推导和实际 SQL 生成存在不一致

开发者临时解决方案

在官方支持完善前，开发者可以采用类型断言作为临时解决方案：

import { RawBuilder, ExtractTypeFromStringReference } from 'kysely'

const result = await db
  .selectFrom("person")
  .select((eb) => [
    eb
      .selectFrom("pet")
      .whereRef("pet.owner_id", "=", "person.id")
      .select(eb => eb.fn.jsonAgg("pet.name" as unknown as "pet") as unknown as RawBuilder<ExtractTypeFromStringReference<DB,"pet","name">[] | null>)
      .as("person_pets"),
  ])
  .executeTakeFirstOrThrow()

对于需要确保非空的场景，可以结合 coalesce 函数：

import { sql, RawBuilder, ExtractTypeFromStringReference } from 'kysely'

const result = await db
  .selectFrom('person')
  .innerJoin('pet', 'pet.owner_id', 'person.id')
  .select((eb) =>
    eb.fn.coalesce(
      (eb.fn.jsonAgg("pet.name" as unknown as "pet") as unknown as RawBuilder<ExtractTypeFromStringReference<Database,"pet","name">[] | null>),
      sql<never[]>`'[]'`,
    ).as('person_pets')
  )
  .groupBy("person.id")
  .executeTakeFirstOrThrow()

未来改进方向

根据社区讨论，Kysely 团队计划从以下几个方向改进：

1. 完全支持列引用形式的 json_agg 调用
2. 重构左连接表的类型表示方式，可能采用 Pet | null 的形式而非所有列可为空
3. 优化子查询聚合场景下的类型推导和 SQL 生成

这些改进将显著提升 Kysely 在处理复杂聚合查询时的类型安全性和开发者体验。

总结

Kysely 作为类型优先的 SQL 查询构建器，对 PostgreSQL 特有功能的支持正在不断完善。json_agg 列引用支持虽然当前存在限制，但开发者可以通过类型断言临时解决。随着未来类型系统的改进，Kysely 将能够更自然地表达各种 SQL 聚合模式，为开发者提供更强大的类型安全保障。