首页
/ Kysely 项目中的 UpdateQueryBuilder.returningAll 方法增强解析

Kysely 项目中的 UpdateQueryBuilder.returningAll 方法增强解析

2025-05-19 11:34:35作者:仰钰奇

Kysely 是一个类型安全的 SQL 查询构建器,最近在其 UpdateQueryBuilder 中增强了对 returningAll 方法的支持,使其能够处理带有表名的复杂查询场景。这一改进显著提升了复杂更新操作的类型安全性和开发体验。

问题背景

在 SQL 操作中,UPDATE 语句经常需要返回更新后的数据行。Kysely 提供了 returningAll 方法来实现这一功能,但在处理带有表别名的复杂查询时存在局限性。特别是在使用子查询作为数据源时,开发者无法精确指定要返回哪些表的全部列。

技术实现

Kysely 通过扩展 UpdateQueryBuilder 的 returningAll 方法,使其能够接受表名或别名作为参数。这一改进的核心在于:

  1. 类型系统增强:更新了类型定义以支持表名参数
  2. 查询构建逻辑调整:确保生成的 SQL 正确处理表名前缀
  3. 结果类型推断:基于输入表名精确推断返回结果的类型

使用场景

这一改进特别适用于以下场景:

db.updateTable('Queues')
  .set('status', 'processing')
  .from((eb) =>
    eb
      .selectFrom('Queues')
      .innerJoin('Messages', 'Queues.messageId', 'Messages.id')
      .selectAll('Queues')
      .select([
        'Messages.event',
        'Messages.payload',
        'Messages.id as messageId',
        'Messages.createdAt'
      ])
      .where('Queues.status', '=', 'pending')
      .forUpdate()
      .skipLocked()
      .as('query')
  )
  .where('Queues.id', '=', 'query.id')
  .returningAll('query') // 现在可以正常工作
  .execute()

在这个例子中,我们:

  1. 从 Queues 和 Messages 表联合查询创建了一个子查询
  2. 使用该子查询作为更新源
  3. 明确指定返回子查询中的所有列

技术价值

这一改进带来了多重好处:

  1. 类型安全性增强:TypeScript 能更准确地推断返回结果的类型
  2. 代码可读性提升:明确指定返回的表使代码意图更清晰
  3. 复杂查询支持:为涉及多表操作的更新场景提供了更好的支持
  4. 一致性改进:使 UpdateQueryBuilder 的 API 与其他查询构建器保持一致

底层原理

在实现层面,Kysely 需要:

  1. 解析表名/别名参数
  2. 验证该表确实存在于查询中
  3. 生成正确的 RETURNING 子句
  4. 确保类型系统能正确反映返回的数据结构

这一改进体现了 Kysely 对开发者体验的持续关注,通过精细的类型系统支持使复杂 SQL 操作更加安全和直观。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
197
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
59
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
974
574
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
549
81
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133