zod

安装依赖项

npm

yarn

pnpm

bun

npm i drizzle-orm@rc zod

yarn add drizzle-orm@rc zod

pnpm add drizzle-orm@rc zod

bun add drizzle-orm@rc zod

选择模式

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

import { int, mysqlTable, text } from 'drizzle-orm/mysql-core';
import { createSelectSchema } from 'drizzle-orm/zod';

const users = mysqlTable('users', {
  id: int().primaryKey().autoincrement(),
  name: text().notNull(),
  age: int().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 { mysqlView } from 'drizzle-orm/mysql-core';
import { gt } from 'drizzle-orm';
import { createSelectSchema } from 'drizzle-orm/zod';

const usersView = mysqlView('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(...);

插入 schema

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

import { int, mysqlTable, text } from 'drizzle-orm/mysql-core';
import { createInsertSchema } from 'drizzle-orm/zod';

const users = mysqlTable('users', {
  id: int().primaryKey().autoincrement(),
  name: text().notNull(),
  age: int().notNull()
});

const userInsertSchema = createInsertSchema(users);

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

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

更新模式

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

import { int, mysqlTable, text } from 'drizzle-orm/mysql-core';
import { createUpdateSchema } from 'drizzle-orm/zod';
import { eq } from "drizzle-orm";

const users = mysqlTable('users', {
  id: int().primaryKey().autoincrement(),
  name: text().notNull(),
  age: int().notNull()
});

const userUpdateSchema = createUpdateSchema(users);

const user = { age: 35 };
const parsed: 
	{ 
		id?: number | undefined; 
		name?: string | undefined; 
		age?: number | undefined 
	} = userUpdateSchema.parse(user); // 将成功解析

await db.update(users).set(parsed).where(eq(users.name, 'Jane'));

优化

每个 create schema 函数都接受一个额外的可选参数，你可以用它来扩展、修改或完全覆盖某个字段的 schema。提供一个回调函数会进行扩展或修改，而提供一个 Zod schema 则会覆盖它。

import { int, json, mysqlTable, text } from 'drizzle-orm/mysql-core';
import { createSelectSchema } from 'drizzle-orm/zod';
import { z } from 'zod/v4';

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

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

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

工厂函数

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

用例：使用扩展的 Zod 实例

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

const users = mysqlTable('users', {
  id: int().primaryKey().autoincrement(),
  name: text().notNull(),
  age: int().notNull()
});

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

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

用例：类型强制转换

import { mysqlTable, timestamp } from 'drizzle-orm/mysql-core';
import { createSchemaFactory } from 'drizzle-orm/zod';
import { z } from 'zod/v4';

const users = mysqlTable('users', {
  ...,
  createdAt: timestamp().notNull()
});

const { createInsertSchema } = createSchemaFactory({
  // 此配置只会强制转换日期。将 `coerce` 设置为 `true` 可强制转换所有数据类型，或指定其他类型
  coerce: {
    date: true
  }
});

const userInsertSchema = createInsertSchema(users);
// 上述内容等同于：
const userInsertSchema = z.object({
  ...,
  createdAt: z.coerce.date()
});

数据类型参考

mysql.boolean();

// Schema
z.boolean();

mysql.mysqlEnum('name', ['val1', 'val2']);

// Schema
z.enum(['val1', 'val2']);

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

// Schema
z.date();

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

// Schema
z.string();

mysql.tinyblob({ mode: 'string' });
mysql.tinyblob();

z.string().max(255)

mysql.blob({ mode: 'string' });
mysql.blob();

z.string().max(65_535)

mysql.mediumblob({ mode: 'string' });
mysql.mediumblob();

z.string().max(16_777_215)

mysql.longblob({ mode: 'string' });
mysql.longblob();

z.string().max(4_294_967_295)

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

// Schema
z.string().length(length);

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

// Schema
z.string().max(length);

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

// Schema
schema.regex(/^[01]*$/).max(length);

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

// Schema
schema.regex(/^[01]*$/).max(length);

mysql.tinytext();

// Schema
z.string().max(255);

mysql.text();

// Schema
z.string().max(65_535);

mysql.mediumtext();

// Schema
z.string().max(16_777_215);

mysql.longtext();

// Schema
z.string().max(4_294_967_295);

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

// Schema
z.enum(enum);

mysql.tinyint();

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

mysql.tinyint({ unsigned: true });

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

mysql.smallint();

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

mysql.smallint({ unsigned: true });

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

mysql.float();

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

mysql.mediumint();

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

mysql.float({ unsigned: true });

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

mysql.mediumint({ unsigned: true });

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

mysql.int();

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

mysql.int({ unsigned: true });

// Schema
z.number().min(0).max(4_294_967_295).int(); // 未签名 32 位整数的下限和上限

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

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

mysql.double({ unsigned: true });

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

mysql.decimal({ mode: 'number' });

// Schema
z.number().min(-9_007_199_254_740_991).max(9_007_199_254_740_991);

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

// Schema
z.bigint().min(-9_223_372_036_854_775_808n).max(9_223_372_036_854_775_807n);

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

// Schema
z.number().min(0).max(9_007_199_254_740_991);

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

// Schema
z.bigint().min(0).max(18_446_744_073_709_551_615n);

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

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

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

// Schema
z.number().min(0).max(9_007_199_254_740_991).int(); // JavaScript 最大安全整数

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

// Schema
z.string().regex(/^-?\d+$/).transform(BigInt).pipe(
	zod.bigint().gte(-9_223_372_036_854_775_808n).lte(9_223_372_036_854_775_807n),
).transform(String)

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

// Schema
z.string().regex(/^\d+$/).transform(BigInt).pipe(
	zod.bigint().gte(0n).lte(9_223_372_036_854_775_807n),
).transform(String)

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

// Schema
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 });

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

mysql.serial();

// Schema
z.number().min(0).max(9_007_199_254_740_991).int(); // JavaScript 最大安全整数

mysql.year();

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

mysql.json();

// Schema
z.union([z.union([z.string(), z.number(), z.boolean(), z.null()]), z.record(z.any()), z.array(z.any())]);