drizzle-zod

If you know SQL, you know Drizzle ORM

---

drizzle-zod is a plugin for Drizzle ORM that allows you to generate Zod schemas from Drizzle ORM schemas.

Features

• Create a select schema for tables, views and enums.
• Create insert and update schemas for tables.
• Supports all dialects: PostgreSQL, MySQL and SQLite.

Usage

1import { pgEnum, pgTable, serial, text, timestamp } from 'drizzle-orm/pg-core';
2import { createInsertSchema, createSelectSchema } from 'drizzle-zod';
3import { z } from 'zod';
4
5const users = pgTable('users', {
6  id: serial('id').primaryKey(),
7  name: text('name').notNull(),
8  email: text('email').notNull(),
9  role: text('role', { enum: ['admin', 'user'] }).notNull(),
10  createdAt: timestamp('created_at').notNull().defaultNow(),
11});
12
13// Schema for inserting a user - can be used to validate API requests
14const insertUserSchema = createInsertSchema(users);
15
16// Schema for updating a user - can be used to validate API requests
17const updateUserSchema = createUpdateSchema(users);
18
19// Schema for selecting a user - can be used to validate API responses
20const selectUserSchema = createSelectSchema(users);
21
22// Overriding the fields
23const insertUserSchema = createInsertSchema(users, {
24  role: z.string(),
25});
26
27// Refining the fields - useful if you want to change the fields before they become nullable/optional in the final schema
28const insertUserSchema = createInsertSchema(users, {
29  id: (schema) => schema.positive(),
30  email: (schema) => schema.email(),
31  role: z.string(),
32});
33
34// Usage
35
36const user = insertUserSchema.parse({
37  name: 'John Doe',
38  email: 'johndoe@test.com',
39  role: 'admin',
40});
41
42// Zod schema type is also inferred from the table schema, so you have full type safety
43const requestSchema = insertUserSchema.pick({ name: true, email: true });