drizzle-zod

drizzle-zod 是一个 Drizzle ORM 的插件，允许你从 Drizzle ORM 生成 Zod 模式。

安装依赖

npm

yarn

pnpm

bun

npm i drizzle-zod

yarn add drizzle-zod

pnpm add drizzle-zod

bun add drizzle-zod

IMPORTANT

该文档适用于 drizzle-zod@0.6.0 及更高版本

你还必须安装 Drizzle ORM v0.36.0 或更高版本以及 Zod v3.0.0 或更高版本。

选择模式

定义从数据库查询的数据形状 - 可用于验证 API 响应。

import { pgTable, text, integer } from 'drizzle-orm/pg-core';
import { createSelectSchema } from 'drizzle-zod';

const users = pgTable('users', {
  id: integer().generatedAlwaysAsIdentity().primaryKey(),
  name: text().notNull(),
  age: integer().notNull()
});

const userSelectSchema = createSelectSchema(users);

const rows = await db.select({ id: users.id, name: users.name }).from(users).limit(1);
const parsed: { id: number; name: string; age: number } = userSelectSchema.parse(rows[0]); // 错误：`age` 在上面的查询中未返回

const rows = await db.select().from(users).limit(1);
const parsed: { id: number; name: string; age: number } = userSelectSchema.parse(rows[0]); // 将成功解析

视图和枚举也受到支持。

import { pgEnum } from 'drizzle-orm/pg-core';
import { createSelectSchema } from 'drizzle-zod';

const roles = pgEnum('roles', ['admin', 'basic']);
const rolesSchema = createSelectSchema(roles);
const parsed: 'admin' | 'basic' = rolesSchema.parse(...);

const usersView = pgView('users_view').as((qb) => qb.select().from(users).where(gt(users.age, 18)));
const usersViewSchema = createSelectSchema(usersView);
const parsed: { id: number; name: string; age: number } = usersViewSchema.parse(...);

插入模式

定义要插入到数据库中的数据形状 - 可用于验证 API 请求。

import { pgTable, text, integer } from 'drizzle-orm/pg-core';
import { createInsertSchema } from 'drizzle-zod';

const users = pgTable('users', {
  id: integer().generatedAlwaysAsIdentity().primaryKey(),
  name: text().notNull(),
  age: integer().notNull()
});

const userInsertSchema = createInsertSchema(users);

const user = { name: 'John' };
const parsed: { name: string, age: number } = userInsertSchema.parse(user); // 错误：`age` 未定义

const user = { name: 'Jane', age: 30 };
const parsed: { name: string, age: number } = userInsertSchema.parse(user); // 将成功解析
await db.insert(users).values(parsed);

更新模式

定义要更新的数据库中的数据形状 - 可用于验证 API 请求。

import { pgTable, text, integer } from 'drizzle-orm/pg-core';
import { createUpdateSchema } from 'drizzle-zod';

const users = pgTable('users', {
  id: integer().generatedAlwaysAsIdentity().primaryKey(),
  name: text().notNull(),
  age: integer().notNull()
});

const userUpdateSchema = createUpdateSchema(users);

const user = { id: 5, name: 'John' };
const parsed: { name?: string | undefined, age?: number | undefined } = userUpdateSchema.parse(user); // 错误：`id` 是一个生成列，无法更新

const user = { age: 35 };
const parsed: { name?: string | undefined, age?: number | undefined } = userUpdateSchema.parse(user); // 将成功解析
await db.update(users).set(parsed).where(eq(users.name, 'Jane'));

精细化

每个创建模式函数接受一个额外的可选参数，你可以用来扩展、修改或完全覆盖字段的模式。定义一个回调函数将扩展或修改，提供一个 Zod 模式将覆盖它。

import { pgTable, text, integer, json } from 'drizzle-orm/pg-core';
import { createSelectSchema } from 'drizzle-zod';
import { z } from 'zod';

const users = pgTable('users', {
  id: integer().generatedAlwaysAsIdentity().primaryKey(),
  name: text().notNull(),
  bio: text(),
  preferences: json()
});

const userSelectSchema = createSelectSchema(users, {
  name: (schema) => schema.max(20), // 扩展模式
  bio: (schema) => schema.max(1000), // 扩展模式，使其可为空/可选
  preferences: z.object({ theme: z.string() }) // 覆盖字段，包括其可空性
});

const parsed: {
  id: number;
  name: string,
  bio?: string | undefined;
  preferences: {
    theme: string;
  };
} = userSelectSchema.parse(...);

工厂函数

对于更高级的用例，你可以使用 createSchemaFactory 函数。

用例：使用扩展的 Zod 实例

import { pgTable, text, integer } from 'drizzle-orm/pg-core';
import { createSchemaFactory } from 'drizzle-zod';
import { z } from '@hono/zod-openapi'; // 扩展的 Zod 实例

const users = pgTable('users', {
  id: integer().generatedAlwaysAsIdentity().primaryKey(),
  name: text().notNull(),
  age: integer().notNull()
});

const { createInsertSchema } = createSchemaFactory({ zodInstance: z });

const userInsertSchema = createInsertSchema(users, {
  // 现在我们可以使用扩展的实例
  name: (schema) => schema.openapi({ example: 'John' })
});

数据类型参考

pg.boolean();

mysql.boolean();

sqlite.integer({ mode: 'boolean' });

// 模式
z.boolean();

pg.date({ mode: 'date' });
pg.timestamp({ mode: 'date' });

mysql.date({ mode: 'date' });
mysql.datetime({ mode: 'date' });
mysql.timestamp({ mode: 'date' });

sqlite.integer({ mode: 'timestamp' });
sqlite.integer({ mode: 'timestamp_ms' });

// 模式
z.date();

pg.date({ mode: 'string' });
pg.timestamp({ mode: 'string' });
pg.cidr();
pg.inet();
pg.interval();
pg.macaddr();
pg.macaddr8();
pg.numeric();
pg.text();
pg.sparsevec();
pg.time();

mysql.binary();
mysql.date({ mode: 'string' });
mysql.datetime({ mode: 'string' });
mysql.decimal();
mysql.time();
mysql.timestamp({ mode: 'string' });
mysql.varbinary();

sqlite.numeric();
sqlite.text({ mode: 'text' });

// 模式
z.string();

pg.bit({ dimensions: ... });

// 模式
z.string().regex(/^[01]+$/).max(dimensions);

pg.uuid();

// 模式
z.string().uuid();

pg.char({ length: ... });

mysql.char({ length: ... });

// 模式
z.string().length(length);

pg.varchar({ length: ... });

mysql.varchar({ length: ... });

sqlite.text({ mode: 'text', length: ... });

// 模式
z.string().max(length);

mysql.tinytext();

// 模式
z.string().max(255); // 无符号 8 位整数限制

mysql.text();

// 模式
z.string().max(65_535); // 无符号 16 位整数限制

mysql.mediumtext();

// 模式
z.string().max(16_777_215); // 无符号 24 位整数限制

mysql.longtext();

// 模式
z.string().max(4_294_967_295); // 无符号 32 位整数限制

pg.text({ enum: ... });
pg.char({ enum: ... });
pg.varchar({ enum: ... });

mysql.tinytext({ enum: ... });
mysql.mediumtext({ enum: ... });
mysql.text({ enum: ... });
mysql.longtext({ enum: ... });
mysql.char({ enum: ... });
mysql.varchar({ enum: ... });
mysql.mysqlEnum(..., ...);

sqlite.text({ mode: 'text', enum: ... });

// 模式
z.enum(enum);

mysql.tinyint();

// 模式
z.number().min(-128).max(127).int(); // 8 位整数下限和上限

mysql.tinyint({ unsigned: true });

// 模式
z.number().min(0).max(255).int(); // 无符号 8 位整数下限和上限

pg.smallint();
pg.smallserial();

mysql.smallint();

// 模式
z.number().min(-32_768).max(32_767).int(); // 16 位整数下限和上限

mysql.smallint({ unsigned: true });

// 模式
z.number().min(0).max(65_535).int(); // 无符号 16 位整数下限和上限

pg.real();

mysql.float();

// 模式
z.number().min(-8_388_608).max(8_388_607); // 24 位整数下限和上限

mysql.mediumint();

// 模式
z.number().min(-8_388_608).max(8_388_607).int(); // 24 位整数下限和上限

mysql.float({ unsigned: true });

// 模式
z.number().min(0).max(16_777_215); // 无符号 24 位整数下限和上限

mysql.mediumint({ unsigned: true });

// 模式
z.number().min(0).max(16_777_215).int(); // 无符号 24 位整数下限和上限

pg.integer();
pg.serial();

mysql.int();

// 模式
z.number().min(-2_147_483_648).max(2_147_483_647).int(); // 32 位整数下限和上限

mysql.int({ unsigned: true });

// 模式
z.number().min(0).max(4_294_967_295).int(); // 无符号 32 位整数下限和上限

pg.doublePrecision();

mysql.double();
mysql.real();

sqlite.real();

// 模式
z.number().min(-140_737_488_355_328).max(140_737_488_355_327); // 48 位整数下限和上限

mysql.double({ unsigned: true });

// 模式
z.number().min(0).max(281_474_976_710_655); // 无符号 48 位整数下限和上限

pg.bigint({ mode: 'number' });
pg.bigserial({ mode: 'number' });

mysql.bigint({ mode: 'number' });
mysql.bigserial({ mode: 'number' });

sqlite.integer({ mode: 'number' });

// 模式
z.number().min(-9_007_199_254_740_991).max(9_007_199_254_740_991).int(); // Javascript 最小和最大安全整数

mysql.serial();

// 模式
z.number().min(0).max(9_007_199_254_740_991).int(); // Javascript 最大安全整数

pg.bigint({ mode: 'bigint' });
pg.bigserial({ mode: 'bigint' });

mysql.bigint({ mode: 'bigint' });

sqlite.blob({ mode: 'bigint' });

// 模式
z.bigint().min(-9_223_372_036_854_775_808n).max(9_223_372_036_854_775_807n); // 64 位整数下限和上限

mysql.bigint({ mode: 'bigint', unsigned: true });

// 模式
z.bigint().min(0).max(18_446_744_073_709_551_615n); // 无符号 64 位整数下限和上限

mysql.year();

// 模式
z.number().min(1_901).max(2_155).int();

pg.geometry({ type: 'point', mode: 'tuple' });
pg.point({ mode: 'tuple' });

// 模式
z.tuple([z.number(), z.number()]);

pg.geometry({ type: 'point', mode: 'xy' });
pg.point({ mode: 'xy' });

// 模式
z.object({ x: z.number(), y: z.number() });

pg.halfvec({ dimensions: ... });
pg.vector({ dimensions: ... });

// 模式
z.array(z.number()).length(dimensions);

pg.line({ mode: 'abc' });

// 模式
z.object({ a: z.number(), b: z.number(), c: z.number() });

pg.line({ mode: 'tuple' });

// 模式
z.tuple([z.number(), z.number(), z.number()]);

pg.json();
pg.jsonb();

mysql.json();

sqlite.blob({ mode: 'json' });
sqlite.text({ mode: 'json' });

// 模式
const self = z.lazy(() => z.union([z.union([z.string(), z.number(), z.boolean(), z.null()]), z.array(self), z.record(self)]));

sqlite.blob({ mode: 'buffer' });

// 模式
z.custom<Buffer>((v) => v instanceof Buffer);

pg.dataType().array(...);

// 模式
z.array(baseDataTypeSchema).length(size);