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

选择 schema

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

import { int4, cockroachTable, text } from 'drizzle-orm/cockroach-core';
import { createSelectSchema } from 'drizzle-orm/zod';

const users = cockroachTable('users', {
  id: int4().primaryKey().generatedAlwaysAsIdentity(),
  name: text().notNull(),
  age: int4().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 { cockroachEnum } from 'drizzle-orm/cockroach-core';
import { createSelectSchema } from 'drizzle-orm/zod';

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

插入 schema

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

import { int4, cockroachTable, text } from 'drizzle-orm/cockroach-core';
import { createInsertSchema } from 'drizzle-orm/zod';

const users = cockroachTable('users', {
  id: int4().primaryKey().generatedAlwaysAsIdentity(),
  name: text().notNull(),
  age: int4().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);

更新 schema

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

import { int4, cockroachTable, text } from 'drizzle-orm/cockroach-core';
import { createUpdateSchema } from 'drizzle-orm/zod';

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

const userUpdateSchema = createUpdateSchema(users);

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'));

精细调整

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

import { int4, jsonb, cockroachTable, text } from 'drizzle-orm/cockroach-core';
import { createSelectSchema } from 'drizzle-orm/zod';
import { z } from 'zod/v4';

const users = cockroachTable('users', {
  id: int4().primaryKey(),
  name: text().notNull(),
  bio: text(),
  preferences: jsonb()
});

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

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

工厂函数

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

使用场景：使用扩展的 Zod 实例

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

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

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

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

使用场景：类型强制转换

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

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

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

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

数据类型参考

CockroachDB 数据类型映射遵循 CockroachDB 列构建器。请参阅 CockroachDB 数据类型页面以获取完整的列参考。