valibot

安装依赖

npm

yarn

pnpm

bun

npm i drizzle-orm@rc valibot

yarn add drizzle-orm@rc valibot

pnpm add drizzle-orm@rc valibot

bun add drizzle-orm@rc valibot

选择模式

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

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { createSelectSchema } from 'drizzle-orm/valibot';
import { parse } from 'valibot';

const users = sqliteTable('users', {
  id: integer().primaryKey({ autoIncrement: true }),
  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 } = parse(userSelectSchema, rows[0]); // 错误：上述查询未返回 `age`

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

也支持视图。

import { sqliteView } from 'drizzle-orm/sqlite-core';
import { gt } from 'drizzle-orm';
import { createSelectSchema } from 'drizzle-orm/valibot';
import { parse } from 'valibot';

const usersView = sqliteView('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 } = parse(usersViewSchema, ...);

插入模式

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

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { createInsertSchema } from 'drizzle-orm/valibot';
import { parse } from 'valibot';

const users = sqliteTable('users', {
  id: integer().primaryKey({ autoIncrement: true }),
  name: text().notNull(),
  age: integer().notNull()
});

const userInsertSchema = createInsertSchema(users);

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

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

更新模式

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

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { createUpdateSchema } from 'drizzle-orm/valibot';
import { parse } from 'valibot';

const users = sqliteTable('users', {
  id: integer().primaryKey({ autoIncrement: true }),
  name: text().notNull(),
  age: integer().notNull()
});

const userUpdateSchema = createUpdateSchema(users);

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

细化

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

import { integer, sqliteTable, text } from 'drizzle-orm/sqlite-core';
import { createSelectSchema } from 'drizzle-orm/valibot';
import { parse, pipe, maxLength, object, string } from 'valibot';

const users = sqliteTable('users', {
  id: integer().primaryKey({ autoIncrement: true }),
  name: text().notNull(),
  bio: text(),
  preferences: text({ mode: 'json' })
});

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

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

数据类型参考

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

// 模式
boolean();

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

// 模式
date();

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

// 模式
string();

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

// 模式
pipe(number(), minValue(-9_007_199_254_740_991), maxValue(9_007_199_254_740_991)); // JavaScript 的最小和最大安全整数

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

// 模式
pipe(bigint(), minValue(-9_223_372_036_854_775_808n), maxValue(9_223_372_036_854_775_807n)); // 64 位整数下限和上限

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

// 模式
pipe(string(), maxLength(length));

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

// 模式
enum(enum);

sqlite.real();

// 模式
pipe(number(), minValue(-140_737_488_355_328), maxValue(140_737_488_355_327)); // 48 位整数下限和上限

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

// 模式
pipe(number(), minValue(-9_007_199_254_740_991), maxValue(9_007_199_254_740_991), integer()); // JavaScript 的最小和最大安全整数

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

// 模式
pipe(bigint(), minValue(-9_223_372_036_854_775_808n), maxValue(9_223_372_036_854_775_807n)); // 64 位整数下限和上限

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

// 模式
union([union([string(), number(), boolean(), null_()]), array(any()), record(string(), any())]);

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

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