Kysely中使用eb.fn()函数构建空间查询条件的最佳实践

在使用Kysely进行数据库查询构建时，开发者经常需要处理复杂的条件组合，特别是当涉及到空间函数等特殊SQL函数时。本文将通过一个典型的空间查询案例，介绍如何在Kysely中正确使用eb.fn()函数构建查询条件。

空间查询场景分析

假设我们需要构建一个包含空间查询的LEFT JOIN条件，原始SQL如下：

LEFT JOIN departements d 
  ON values.gps IS NOT NULL
  AND ST_Contains(d.shape, values.gps)

这个查询包含两个关键条件：

1. 检查gps字段是否为NULL
2. 使用PostGIS的ST_Contains函数判断空间包含关系

Kysely实现方案

在Kysely中，我们通常会使用查询构建器的eb.and()方法来组合多个条件。初始实现可能会这样写：

.leftJoin("public_department_region", (join) =>
  join.on((eb) =>
    eb.and([
      eb("values.gps", "is not", null),
      eb.fn("ST_Contains", [
        "public_department_region.shape",
        "values.gps",
      ]),
    ]),
  ),
)

类型系统问题与解决方案

上述代码会遇到TypeScript类型错误，这是因为eb.and()方法期望接收的是布尔类型的表达式(Expression)，而eb.fn()默认返回的是Expression类型。

正确的解决方案是为eb.fn()显式指定返回类型：

.leftJoin("public_department_region", (join) =>
  join.on((eb) =>
    eb.and([
      eb("values.gps", "is not", null),
      eb.fn<SqlBool>("ST_Contains", [  // 显式指定返回类型
        "public_department_region.shape",
        "values.gps",
      ]),
    ]),
  ),
)

或者也可以使用boolean类型：

eb.fn<boolean>("ST_Contains", [...])

替代方案

如果不需要组合多个条件，也可以直接使用eb.fn()作为单独的连接条件：

.leftJoin("public_department_region", (join) =>
  join.on((eb) =>
    eb.fn("ST_Contains", [
      "public_department_region.shape",
      "values.gps",
    ]),
  ),
)

总结

在Kysely中构建包含SQL函数的复杂查询条件时，需要注意：

1. 组合多个条件时使用eb.and()/eb.or()等方法
2. 使用eb.fn()调用SQL函数时，需要显式指定返回类型
3. 对于返回布尔值的函数，应指定为SqlBool或boolean类型
4. 简单的单条件查询可以直接使用eb.fn()

掌握这些技巧后，开发者可以更灵活地在Kysely中构建各种复杂的SQL查询条件，包括空间查询等高级功能。