首页
/ Drizzle ORM 中 drizzle-kit 工具对日期类型默认值处理的修复

Drizzle ORM 中 drizzle-kit 工具对日期类型默认值处理的修复

2025-05-06 06:34:44作者:胡易黎Nicole

在 Drizzle ORM 生态系统中,drizzle-kit 是一个重要的工具链组件,用于数据库模式的内省和迁移。近期发现并修复了一个关于日期类型默认值处理的 bug,这个修复对于使用 PostgreSQL 数据库和 Drizzle ORM 的开发者具有重要意义。

问题背景

当开发者使用 drizzle-kit 的 introspect 功能从现有数据库生成 TypeScript 模式定义时,对于 date 类型的列,如果设置了 CURRENT_TIMESTAMP 作为默认值,生成的代码会出现问题。具体表现为生成的代码中 CURRENT_TIMESTAMP 没有被正确包装在 sql 模板标签中。

错误生成的代码示例:

export const metrics = pgTable("metrics", {
    date: date("date").default(CURRENT_TIMESTAMP).notNull(),
})

而正确的生成方式应该是:

export const metrics = pgTable("metrics", {
    date: date("date").default(sql`CURRENT_TIMESTAMP`).notNull(),
})

技术影响

这个 bug 特别值得注意的地方在于它只影响 date 类型的列,而不影响 timestamp 类型的列。这种不一致性可能导致开发者在迁移或重构数据库模式时遇到难以察觉的问题。

在 Drizzle ORM 中,sql 模板标签用于标识原始 SQL 片段,确保它们被正确转义和处理。缺少这个包装会导致以下问题:

  1. 运行时错误,因为 CURRENT_TIMESTAMP 会被当作变量而不是 SQL 表达式
  2. 类型安全性降低,因为 TypeScript 无法正确推断原始 SQL 表达式的类型
  3. 潜在的 SQL 注入风险,虽然在这个特定情况下风险较低

修复情况

该问题已在 drizzle-kit 的 0.28.0 版本中得到修复。对于使用较新版本的开发者来说,这个问题已经不存在。但对于仍在使用旧版本的开发者,需要注意以下几点:

  1. 手动检查生成的模式定义中所有 date 类型的默认值
  2. 确保 CURRENT_TIMESTAMP 被正确包装在 sql 模板标签中
  3. 考虑升级到最新版本以获得更稳定的体验

最佳实践

为了避免类似问题,建议开发者:

  1. 定期更新 drizzle-kit 到最新版本
  2. 在 CI/CD 流程中加入对生成模式的验证步骤
  3. 对于关键的时间类型字段,进行额外的测试验证
  4. 了解不同数据库类型(date vs timestamp)在 Drizzle ORM 中的行为差异

这个修复体现了 Drizzle ORM 团队对细节的关注和对开发者体验的重视,也提醒我们在使用 ORM 工具时需要理解其底层机制。

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