首页
/ Drizzle ORM 类型推断问题解析与解决方案

Drizzle ORM 类型推断问题解析与解决方案

2025-05-06 15:09:55作者:蔡丛锟

问题背景

在使用Drizzle ORM进行数据库操作时,开发者可能会遇到一个关于类型推断的常见问题。具体表现为在调用update方法后,set方法无法正确识别表结构中定义的所有字段类型,导致TypeScript类型检查报错。

问题复现

以一个简单的表结构定义为例:

export const eligibilityRecord = eligibilitySchema.table(
  'eligibility',
  {
    id: id('uuid').default(sql`uuid_generate_v4()`).primaryKey().notNull(),
    clientId: bigint('clientId', { mode: 'number' }).notNull(),
    modifiedDate: timestamp('modifiedDate', { withTimezone: true, mode: 'string' }),
    modifiedBy: varchar('modifiedBy', { length: 500 }),
    extraData: json('extraData').default({}).notNull(),
    deltaType: bigint('deltaType', { mode: 'number' }),
  },
);

当尝试执行更新操作时:

return this.db
  .update(eligibilityRecord)
  .set({
    deltaType: DeltaTypes.REMOVE, // 这是一个1到4之间的数字
    modifiedBy,
    modifiedDate: sql`now()`,
  })
  .where(and(eq(eligibilityRecord.clientId, clientId), eq(eligibilityRecord.uniqueId, uniqueId)))
  .returning();

会出现类型错误提示,指出deltaType不是已知属性。

问题原因分析

这个问题通常与TypeScript的严格类型检查配置有关。Drizzle ORM在0.35.1版本中对类型系统进行了调整,使得在没有启用strictNullChecks的情况下,类型推断会出现问题。

解决方案

  1. 启用strictNullChecks
    在项目的tsconfig.json中,确保启用了strictNullChecks选项:
{
  "compilerOptions": {
    "strictNullChecks": true
  }
}
  1. 代码清理
    启用严格模式后,需要对项目中可能存在的"松散"代码进行清理,特别是那些从JavaScript迁移过来的代码,确保所有变量都有明确的类型定义。

  2. 版本回退
    如果暂时无法启用严格模式,可以考虑回退到Drizzle ORM的0.30.10版本,该版本对类型检查的要求较为宽松。

最佳实践建议

  1. 始终启用严格模式
    虽然严格模式会增加开发初期的复杂度,但它能帮助开发者捕获潜在的类型错误,提高代码质量。

  2. 逐步迁移策略
    对于大型项目,可以采用逐步迁移的方式,先在新模块中启用严格模式,再逐步迁移旧代码。

  3. 类型定义检查
    定期检查表结构定义与业务代码中的类型使用是否一致,确保类型系统的完整性。

总结

Drizzle ORM作为类型安全的ORM解决方案,其类型系统在不同版本间有所演进。开发者需要理解并适应这些变化,通过合理配置TypeScript选项和遵循最佳实践,可以充分发挥类型系统的优势,提高开发效率和代码质量。

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

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
178
262
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
866
513
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
183
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
261
302
kernelkernel
deepin linux kernel
C
22
5
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
598
57
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
398
371
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
332
1.08 K