drizzle-zod

drizzle-zod는 Drizzle ORM 스키마로부터 Zod 스키마를 생성할 수 있게 해주는 Drizzle ORM 플러그인입니다.

의존성 설치

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.25.1 이상이 설치되어 있어야 합니다.

Select 스키마

데이터베이스에서 조회한 데이터의 형태를 정의합니다 - 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(...);

Insert 스키마

데이터베이스에 삽입할 데이터의 형태를 정의합니다 - 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);

Update 스키마

데이터베이스에서 업데이트할 데이터의 형태를 정의합니다 - 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/v4';

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

const userSelectSchema = createSelectSchema(users, {
  name: (schema) => schema.max(20), // 스키마 확장
  bio: (schema) => schema.max(1000), // nullable/optional이 되기 전에 스키마 확장
  preferences: z.object({ theme: z.string() }) // nullability를 포함하여 필드 덮어쓰기
});

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'; // Extended Zod instance

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

사용 사례: 타입 강제 변환

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

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

const { createInsertSchema } = createSchemaFactory({
  // 이 설정은 날짜만 강제 변환합니다. 모든 데이터 타입을 강제 변환하려면 `coerce`를 `true`로 설정하거나 다른 타입을 지정하세요
  coerce: {
    date: true
  }
});

const userInsertSchema = createInsertSchema(users);
// 위 코드는 아래와 동일합니다:
const userInsertSchema = z.object({
  ...,
  createdAt: z.coerce.date()
});

데이터 타입 레퍼런스

pg.boolean();

mysql.boolean();

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

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

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

// Schema
z.string();

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

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

pg.uuid();

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

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

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

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

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

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

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

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

mysql.tinytext();

// Schema
z.string().max(255); // unsigned 8비트 정수 제한

mysql.text();

// Schema
z.string().max(65_535); // unsigned 16비트 정수 제한

mysql.mediumtext();

// Schema
z.string().max(16_777_215); // unsigned 24비트 정수 제한

mysql.longtext();

// Schema
z.string().max(4_294_967_295); // unsigned 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: ... });

// 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(); // unsigned 8비트 정수 하한 및 상한

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

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(); // unsigned 16비트 정수 하한 및 상한

pg.real();

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); // unsigned 24비트 정수 하한 및 상한

mysql.mediumint({ unsigned: true });

// Schema
z.number().min(0).max(16_777_215).int(); // unsigned 24비트 정수 하한 및 상한

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

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(); // unsigned 32비트 정수 하한 및 상한

pg.doublePrecision();

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

sqlite.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); // unsigned 48비트 정수 하한 및 상한

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

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

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

// Schema
z.number().min(-9_007_199_254_740_991).max(9_007_199_254_740_991).int(); // 자바스크립트 최소 및 최대 안전 정수

mysql.serial();

// Schema
z.number().min(0).max(9_007_199_254_740_991).int(); // 자바스크립트 최대 안전 정수

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

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

sqlite.blob({ 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); // unsigned 64비트 정수 하한 및 상한

mysql.year();

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

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

// Schema
z.tuple([z.number(), z.number()]);

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

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

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

// Schema
z.array(z.number()).length(dimensions);

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

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

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

// Schema
z.tuple([z.number(), z.number(), z.number()]);

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

mysql.json();

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

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

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

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

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

// Schema
z.array(baseDataTypeSchema).length(size);