Database
Define your tables in TypeScript, then query them with db from void/db. Void includes Drizzle ORM and configures the connection, so you can use the same schema and query workflow with D1, PostgreSQL, or MySQL.
- db/
- schema.tsTable definitions (source of truth)
- schema/Split schema files (optional)
- users.ts
- posts.ts
- migrations/Generated SQL migration files
- 20260410161500_create_users.sql
- 20260410161501_add_posts.sql
- seed.tsProgrammatic seed script (optional)
- seed.sqlRaw SQL seed file (optional alternative)
Choosing a Dialect
Choose a database during void init, or set database in void.config.ts:
| D1 (SQLite) | PostgreSQL | MySQL | |
|---|---|---|---|
| Config | Default | "database": "pg" | "database": "mysql" |
| Managed by | Void | Bring your own database | Bring your own database |
| Connection | Automatic D1 binding | Hyperdrive | Hyperdrive |
A Void platform keeps Hyperdrive query caching off for your database connection, so reads reflect completed writes. An existing connection is updated on the project's next deploy.
Schema Definition
Define your tables in db/schema.ts using column helpers from void/schema-d1, void/schema-pg, or void/schema-mysql.
import { sql } from 'void/db';
// db/schema.ts
import { sqliteTable, text, integer } from 'void/schema-d1';
export const users = sqliteTable('users', {
id: integer('id').primaryKey({ autoIncrement: true }),
name: text('name').notNull(),
email: text('email').notNull().unique(),
role: text('role').notNull().default('user'),
createdAt: text('created_at')
.notNull()
.default(sql`(datetime('now'))`),
});// db/schema.ts
import { pgTable, serial, text, timestamp } from 'void/schema-pg';
export const users = pgTable('users', {
id: serial('id').primaryKey(),
name: text('name').notNull(),
email: text('email').notNull().unique(),
role: text('role').notNull().default('user'),
createdAt: timestamp('created_at').notNull().defaultNow(),
});// db/schema.ts
import { int, mysqlTable, text, timestamp } from 'void/schema-mysql';
export const users = mysqlTable('users', {
id: int('id').autoincrement().primaryKey(),
name: text('name').notNull(),
email: text('email').notNull(),
createdAt: timestamp('created_at').notNull().defaultNow(),
});The schema helpers are included in void. You can write tables yourself or generate a starting point with void gen model.
You can also split your schema across multiple files under db/schema/ and re-export from a barrel file:
// db/schema/users.ts
export const users = ...;
// db/schema/posts.ts
export const posts = ...;
// db/schema.ts (barrel)
export * from "./schema/users";
export * from "./schema/posts";Querying
Void re-exports all common Drizzle query operators from void/db so you don't need to install drizzle-orm separately. Import db from void/db and your tables from @schema:
import { users } from '@schema';
import { db } from 'void/db';What is @schema?
@schema is a Vite path alias that the Void plugin configures automatically. It points to your db/schema.ts file, or db/schema/ if you split tables across files. You can just use it to import table definitions.
List rows
const allUsers = await db.select().from(users);Filter with where
import { users } from '@schema';
import { db, eq, and, or } from 'void/db';
// Single condition
const user = await db.select().from(users).where(eq(users.id, 1));
// Multiple conditions
const admins = await db
.select()
.from(users)
.where(and(eq(users.role, 'admin'), eq(users.name, 'Alice')));
// OR conditions
const result = await db
.select()
.from(users)
.where(or(eq(users.role, 'admin'), eq(users.role, 'editor')));Insert
// Single row
await db.insert(users).values({
name: 'Alice',
email: 'alice@example.com',
});
// Insert and return the created row
const [created] = await db
.insert(users)
.values({ name: 'Bob', email: 'bob@example.com' })
.returning();
// Multiple rows
await db.insert(users).values([
{ name: 'Alice', email: 'alice@example.com' },
{ name: 'Bob', email: 'bob@example.com' },
]);Update
await db.update(users).set({ role: 'admin' }).where(eq(users.id, 1));
// Update and return the modified row
const [updated] = await db.update(users).set({ role: 'admin' }).where(eq(users.id, 1)).returning();Delete
await db.delete(users).where(eq(users.id, 1));Column selection
const names = await db.select({ name: users.name, email: users.email }).from(users);
// names: { name: string; email: string }[]Ordering and pagination
import { users } from '@schema';
import { db, desc } from 'void/db';
const page = await db.select().from(users).orderBy(desc(users.createdAt)).limit(10).offset(20);Joins
import { users, posts } from '@schema';
import { db, eq } from 'void/db';
const results = await db
.select({
id: posts.id,
title: posts.title,
author: users.name,
})
.from(posts)
.innerJoin(users, eq(posts.userId, users.id));Relational queries
If your schema defines relations, you can use Drizzle's relational query API:
const usersWithPosts = await db.query.users.findMany({
with: { posts: true },
});Seeding
Use void db seed to reset your local database, re-apply migrations, and then run a seed file.
Use db/seed.ts for a programmatic seed or db/seed.sql for SQL. JavaScript and .mts / .mjs files also work. If more than one seed file exists, choose one with --file <path>.
Programmatic seeding
Use db/seed.ts when you want to generate seed data in code. Export a default function or a named seed function.
// db/seed.ts
import { defineSeed } from 'void/seed';
export default defineSeed<typeof import('./schema')>(async ({ db, schema }) => {
const rows = Array.from({ length: 100 }, (_, i) => ({
text: `Seed message ${i + 1}`,
}));
await db.insert(schema.messages).values(rows);
});The seed context includes:
dialect:"sqlite","postgresql", or"mysql"db: a Drizzle instance for the local databaseschema: the exports from yourdb/schema.tsordb/schema/modules
SQL seeding
If you prefer raw SQL, keep using db/seed.sql:
INSERT INTO messages (text) VALUES ('Hello from SQL');Schema-Derived Validators
Derive request validators from your tables with void/drizzle-zod, void/drizzle-valibot, or void/drizzle-arktype. Add the validator after your table definition:
// db/schema.ts
import { createInsertSchema } from 'void/drizzle-zod';
export const insertUserSchema = createInsertSchema(users, {
name: (schema) => schema.min(1),
email: (schema) => schema.email(),
});import { pipe, minLength, email } from 'valibot';
// db/schema.ts
import { createInsertSchema } from 'void/drizzle-valibot';
export const insertUserSchema = createInsertSchema(users, {
name: (schema) => pipe(schema, minLength(1)),
email: (schema) => pipe(schema, email()),
});import { type } from 'arktype';
// db/schema.ts
import { createInsertSchema } from 'void/drizzle-arktype';
export const insertUserSchema = createInsertSchema(users, {
name: type('string > 0'),
email: type('string.email'),
});createInsertSchema generates a validator that matches $inferInsert. Columns with defaults or auto-increments become optional, while NOT NULL columns stay required. The optional second argument lets you refine individual columns, either with a callback that receives the generated schema or by passing a type directly to override a field.
Use the derived schema in your route handlers with withValidator():
import { users, insertUserSchema } from '@schema';
// routes/api/users/index.ts
import { defineHandler } from 'void';
import { db } from 'void/db';
export const POST = defineHandler.withValidator({
body: insertUserSchema,
})(async (c, { body }) => {
const [created] = await db.insert(users).values(body).returning();
return created;
});Three functions are available:
| Function | Purpose |
|---|---|
createInsertSchema | Validates insert data, excluding auto-generated columns and applying defaults |
createSelectSchema | Matches the shape of selected rows |
createUpdateSchema | Like insert but all fields are optional (partial update) |
Void already bundles the Drizzle adapters. Install the validator library itself if you use its direct APIs in your schema file:
npm install zod
# or
npm install valibot
# or
npm install arktypeCLI Commands
| Command | Purpose |
|---|---|
void db push | Apply schema changes locally without migration files |
void db generate | Generate SQL migrations |
void db migrate | Apply pending migrations locally |
void db status | Check schema drift and pending migrations |
void db seed | Reset the local database and run a seed file |
See the CLI reference for connection setup, SQL execution, Studio, exports, and other commands.
Hand-written migrations
Deploy compares your Drizzle schema with the snapshots in db/migrations/meta/. If you have SQL migrations without this metadata, running void db generate would create another migration for the same tables.
To keep an existing migration history:
- Make your Drizzle schema match the tables your SQL migrations create.
- In a scratch copy of the project, remove
db/migrations/and runvoid db generate. - Copy the generated
meta/folder into your original migration directory. In_journal.json, replaceentrieswith an entry for each existing SQL file in order. Use consecutiveidxvalues starting at0, the file name without.sqlastag, increasing timestamps aswhen, and the generated entry'sversion. Setbreakpointsto whether the file uses--> statement-breakpointlines. - Rename the generated snapshot to
<prefix>_snapshot.json, where<prefix>is the part of the last migration tag before its first_. For001_create_users.sql, use001_snapshot.json.
Review and commit the metadata, then run void deploy again. If no database has applied the SQL yet, you can instead replace it with migrations from void db generate.
For D1 migrations containing triggers, and MySQL migrations containing triggers, procedures, functions or events, add a --> statement-breakpoint line after each complete SQL statement, including the trigger's closing END;. Keep the trigger body together.
Scaffolding
The void gen model command generates dialect-appropriate sqliteTable, pgTable, or mysqlTable definitions.
void gen model posts title:string body:text published:booleanThis creates:
db/schema/posts.ts: a Drizzle table definition withid,createdAt,updatedAt, and your columns- Updates
db/schema.tswithexport * from "./schema/posts" routes/api/posts/index.ts:GETfor list andPOSTfor insert with validationroutes/api/posts/[id].ts:GETby id with404handling
See the CLI reference for the full list of generators.