Drizzle ORM 中表约束数组语法使用注意事项

前言

在使用Drizzle ORM进行PostgreSQL数据库开发时，表约束和索引的配置是一个重要环节。近期版本中，Drizzle ORM引入了新的数组语法来定义表约束，但许多开发者在使用过程中遇到了配置不生效的问题。本文将深入分析这一现象，帮助开发者正确使用新语法。

新旧语法对比

旧语法（对象语法）

在早期版本中，Drizzle ORM使用对象语法来定义表约束：

export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  email: text('email')
}, (table) => ({
  emailIdx: index('email_idx').on(table.email)
}));

这种语法直观明了，每个约束都作为对象的属性存在。

新语法（数组语法）

新版本推荐使用数组语法：

export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  email: text('email')
}, (table) => [
  index('email_idx').on(table.email)
]);

关键区别在于：

1. 使用数组[]替代了对象{}
2. 直接返回约束实例数组，而非属性对象

常见错误模式

许多开发者容易犯的错误是混合使用两种语法：

// 错误示例：在数组中仍使用对象属性形式
export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  email: text('email')
}, (table) => [{
  emailIdx: index('email_idx').on(table.email)
}]);

这种写法会导致约束无法被正确识别，因为Drizzle ORM期望的是约束实例数组，而非包含约束的对象数组。

正确使用指南

基本索引定义

export const products = pgTable('products', {
  id: serial('id').primaryKey(),
  sku: text('sku'),
  price: integer('price')
}, (table) => [
  index('sku_idx').on(table.sku),
  index('price_idx').on(table.price.desc())
]);

唯一约束

export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  username: text('username'),
  email: text('email')
}, (table) => [
  unique('username_unique').on(table.username),
  unique('email_unique').on(table.email)
]);

复合索引

export const orders = pgTable('orders', {
  id: serial('id').primaryKey(),
  customerId: integer('customer_id'),
  orderDate: timestamp('order_date')
}, (table) => [
  index('customer_order_idx').on(table.customerId, table.orderDate.desc())
]);

迁移建议

对于现有项目从旧语法迁移到新语法：

1. 将对象语法中的属性值提取为数组元素
2. 移除自定义的属性名称
3. 确保每个约束都是直接调用的结果

例如，将：

(table) => ({
  idx1: index('a').on(table.x),
  idx2: index('b').on(table.y)
})

迁移为：

(table) => [
  index('a').on(table.x),
  index('b').on(table.y)
]

总结

Drizzle ORM的新数组语法为表约束定义提供了更简洁的表达方式，但需要开发者注意语法结构的改变。正确使用数组语法可以确保所有约束和索引被ORM正确识别和处理。对于从旧版本迁移的项目，建议仔细检查所有表定义，确保约束配置符合新语法的要求。