Drizzle ORM 中 PostgreSQL 枚举类型的正确使用方式

在使用 Drizzle ORM 进行 PostgreSQL 数据库开发时，枚举类型是一个非常有用的特性。它可以帮助开发者定义一组固定的值，确保数据库字段只能存储这些预定义的值，从而提高数据的一致性和完整性。

问题现象

许多开发者在使用 Drizzle ORM 时遇到了一个常见问题：在生成数据库迁移文件时，枚举类型没有被正确创建。具体表现为迁移文件中缺少创建枚举类型的语句，而只有引用该枚举类型的表结构定义。

问题原因

经过深入分析，这个问题通常是由于开发者没有正确导出枚举类型定义导致的。Drizzle ORM 的迁移生成器只会处理被显式导出的枚举类型定义。

正确用法

要确保枚举类型被正确生成，必须遵循以下步骤：

1. 使用 pgEnum 函数定义枚举类型
2. 显式导出该枚举类型定义
3. 在表定义中引用该枚举类型

import { pgEnum, pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'

// 必须导出枚举类型定义
export const userType = pgEnum('userType', ['ADMIN', 'EDITOR', 'VIEWER'])

export const users = pgTable('users', {
  id: uuid('id').primaryKey(),
  email: text('email').notNull().unique(),
  userType: userType('tokenType').notNull(), // 引用枚举类型
  createdAt: timestamp('created_at').notNull().defaultNow(),
  updatedAt: timestamp('updated_at').notNull().defaultNow(),
  deletedAt: timestamp('deleted_at'),
})

生成的迁移文件

当正确导出枚举类型后，Drizzle ORM 会生成包含枚举类型创建语句的完整迁移文件：

DO $$ BEGIN
 CREATE TYPE "userType" AS ENUM('ADMIN', 'EDITOR', 'VIEWER');
EXCEPTION
 WHEN duplicate_object THEN null;
END $$;

CREATE TABLE IF NOT EXISTS "users" (
	"id" uuid PRIMARY KEY NOT NULL,
	"email" text NOT NULL,
	"tokenType" "userType" NOT NULL,
	"created_at" timestamp DEFAULT now() NOT NULL,
	"updated_at" timestamp DEFAULT now() NOT NULL,
	"deleted_at" timestamp,
	CONSTRAINT "users_email_unique" UNIQUE("email")
);

最佳实践

1. 显式导出所有枚举类型：确保所有在表定义中使用的枚举类型都被显式导出
2. 命名一致性：保持枚举类型名称与变量名称一致，提高代码可读性
3. 文档注释：为枚举类型添加文档注释，说明每个值的含义
4. 版本控制：将生成的迁移文件纳入版本控制，方便团队协作

通过遵循这些最佳实践，可以确保 Drizzle ORM 的枚举类型功能正常工作，为应用提供更健壮的数据完整性保障。