Drizzle ORM 类型推断问题解析与解决方案
2025-05-06 12:58:54作者:蔡丛锟
问题背景
在使用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的情况下,类型推断会出现问题。
解决方案
- 启用strictNullChecks
在项目的tsconfig.json中,确保启用了strictNullChecks选项:
{
"compilerOptions": {
"strictNullChecks": true
}
}
-
代码清理
启用严格模式后,需要对项目中可能存在的"松散"代码进行清理,特别是那些从JavaScript迁移过来的代码,确保所有变量都有明确的类型定义。 -
版本回退
如果暂时无法启用严格模式,可以考虑回退到Drizzle ORM的0.30.10版本,该版本对类型检查的要求较为宽松。
最佳实践建议
-
始终启用严格模式
虽然严格模式会增加开发初期的复杂度,但它能帮助开发者捕获潜在的类型错误,提高代码质量。 -
逐步迁移策略
对于大型项目,可以采用逐步迁移的方式,先在新模块中启用严格模式,再逐步迁移旧代码。 -
类型定义检查
定期检查表结构定义与业务代码中的类型使用是否一致,确保类型系统的完整性。
总结
Drizzle ORM作为类型安全的ORM解决方案,其类型系统在不同版本间有所演进。开发者需要理解并适应这些变化,通过合理配置TypeScript选项和遵循最佳实践,可以充分发挥类型系统的优势,提高开发效率和代码质量。
登录后查看全文
热门项目推荐
相关项目推荐
暂无数据
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
540
3.77 K
Ascend Extension for PyTorch
Python
351
415
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
889
612
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
338
185
openJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力
TSX
987
253
openGauss kernel ~ openGauss is an open source relational database management system
C++
169
233
暂无简介
Dart
778
193
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.35 K
758
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
115
141