Drizzle ORM 中 Prepared Statement 的 Limit/Offset 占位符类型问题解析

问题背景

在使用 Drizzle ORM (版本 0.30.7) 时，开发者发现当尝试在 prepared statement 中使用 sql.placeholder 作为 limit 和 offset 的参数时，TypeScript 会抛出类型错误。这是一个典型的类型系统与实际使用场景不匹配的问题。

问题表现

具体表现为以下代码会触发 TypeScript 错误：

const prepared = database
    .select()
    .from(product)
    .orderBy(product.name)
    .limit(sql.placeholder('limit'))  // 类型错误
    .offset(sql.placeholder('offset')) // 类型错误
    .prepare();

错误信息明确指出：

Argument of type 'Placeholder<"limit", any>' is not assignable to parameter of type 'number'

技术分析

这个问题源于 Drizzle ORM 的类型定义中，limit() 和 offset() 方法被定义为只接受 number 类型的参数，而没有考虑到 prepared statement 场景下需要使用占位符的情况。

在 SQL 预处理语句中，limit 和 offset 通常也是可以参数化的部分，这允许开发者动态设置这些值而不需要重新编译整个 SQL 语句。Drizzle ORM 的 sql.placeholder 机制正是为了支持这种场景而设计的。

临时解决方案

在问题修复前，开发者可以采用类型断言作为临时解决方案：

.limit(sql.placeholder('limit') as never)
.offset(sql.placeholder('offset') as never)

使用 as never 类型断言可以绕过 TypeScript 的类型检查，但这并不是最理想的解决方案，因为它失去了类型安全性。

官方修复

该问题已在 Drizzle ORM 的 0.36.1 版本中得到修复。新版本中，limit() 和 offset() 方法的类型定义已经更新，能够正确接受 Placeholder 类型的参数。

最佳实践

对于使用较新版本 Drizzle ORM 的开发者，现在可以直接使用：

.limit(sql.placeholder('limit'))
.offset(sql.placeholder('offset'))

而对于仍在使用旧版本的开发者，建议升级到 0.36.1 或更高版本以获得完整的类型支持。如果暂时无法升级，可以使用上述的类型断言方案，但应当尽快安排升级以避免潜在的类型安全问题。

总结

这个问题展示了 ORM 库在平衡类型安全性和灵活性时面临的挑战。Drizzle ORM 团队通过版本迭代不断完善类型系统，为开发者提供了更好的开发体验。这也提醒我们，在使用任何 ORM 工具时，关注其版本更新和类型系统的演进是十分重要的。