D1 (SQLite)
Cloudflare D1 is Void's default SQLite database. Start with a schema; Void manages the database locally and when you deploy.
Local Database
The dev server and local void db commands share the same database. If cloudflare.d1_databases in void.config.ts declares the D1 binding, Void uses its ID. A preview_database_id takes precedence during local development.
To store local data outside .void, set voidPlugin({ persistTo: 'local-state' }) in your Vite config. Start the dev server once to record that directory before running database commands. After changing the Vite config, start it again to refresh it. Frameworks that manage their own Cloudflare runtime use .wrangler/state.
Migrations & Prototyping
Use void db push to apply schema changes locally without creating migration files. Before deploying, generate and commit migrations:
void db generate
void db migrate # apply locally
void deploy # apply remotely and deploySee Database commands for the full workflow.
Batch Operations
D1 supports batching multiple statements into a single round-trip:
import { users, posts } from '@schema';
import { db, eq } from 'void/db';
await db.batch([
db.delete(posts).where(eq(posts.userId, userId)),
db.delete(users).where(eq(users.id, userId)),
]);Read replication
Void enables D1 read replication when it provisions a database. To enable it on an existing database, run void deploy --platform cloudflare --provision. Queries through db from void/db use a D1 session for each Void request, so reads can run near the request and later queries in that request see at least the same data. Framework handlers without Void's request scope start each database operation on the primary. createDb starts a replica-capable session for the binding you pass it.
WARNING
Replicas can lag between requests. Carry a bookmark to preserve previously observed database state, or use a primary-first session when you need the latest primary data.
For raw D1 calls or another query library, use withSession() to read from replicas. A bare D1 binding reads from the primary.
Avoid stale reads with a primary-first session
Authentication checks use the primary so a lagging replica can't accept a revoked session. For other reads that need the latest primary data, create a client inside the request:
import { users } from '@schema';
import { env } from 'cloudflare:workers';
import { defineHandler } from 'void';
import { createDb } from 'void/db';
export const GET = defineHandler(async () => {
const primaryDb = createDb(env.DB, { session: 'first-primary' });
return primaryDb.select().from(users).all();
});With session: 'first-primary', the first query reads from the primary and later queries see at least the same data. The default, 'first-unconstrained', allows the first query to use a replica.
See your writes in subsequent requests
To make a read after a save see that save in a later request, carry a D1 bookmark between requests. A bookmark allows D1 to use a replica that has caught up to at least the previously observed database state.
WARNING
Bookmarks do not affect cached responses. Disable ISR for pages that require fresh reads (export const revalidate = 0 in the page's .server.ts file), and do not serve these requests from shared response caches.
Use middleware to set the default db session before your handlers or Pages loaders run, and return its bookmark after their queries. For a browser app, a cookie carries it through redirects and navigation:
WARNING
Concurrent responses can overwrite this cookie with an older bookmark. The header-based recipe retains the newest bookmark across concurrent API responses. Clearing or expiring bookmark storage starts a new bookmark chain.
NOTE
To use cookies and API headers together, see Supporting both transports.
// middleware/01.database.ts
import { getCookie, setCookie } from 'hono/cookie';
import { defineMiddleware } from 'void';
import { getBookmark, setSession } from 'void/db';
export default defineMiddleware(async (c, next) => {
setSession(getCookie(c, 'db-bookmark') ?? 'first-unconstrained');
await next();
const bookmark = getBookmark();
if (bookmark) {
setCookie(c, 'db-bookmark', bookmark, {
httpOnly: true,
secure: new URL(c.req.url).protocol === 'https:',
sameSite: 'Lax',
path: '/',
});
}
c.header('Cache-Control', 'private, no-store');
});API requests with concurrent clients
For browser API requests, exchange an X-DB-Bookmark header and retain the newest bookmark. D1 bookmarks are lexicographically sortable, so an older response must not replace a newer bookmark from the same database.
For requests made through the browser fetch wrapper below, exchange bookmarks using this middleware:
WARNING
This recipe carries bookmarks only through the fetch wrapper below, not ordinary navigation, form submissions, or Pages requests. It does not share bookmarks with the cookie-based recipe.
NOTE
To use cookies and API headers together, see Supporting both transports.
// middleware/01.database.ts
import { defineMiddleware } from 'void';
import { getBookmark, setSession } from 'void/db';
export default defineMiddleware(async (c, next) => {
if (!c.req.path.startsWith('/api/')) {
await next();
return;
}
setSession(c.req.header('X-DB-Bookmark') ?? 'first-unconstrained');
await next();
const bookmark = getBookmark();
if (bookmark) {
c.header('X-DB-Bookmark', bookmark);
}
c.header('Cache-Control', 'private, no-store');
});On the browser, send the saved bookmark and atomically retain the newest returned value using Web Locks. This requires HTTPS (or localhost), browser storage, and Web Locks support. Use a scope unique to the database and signed-in account; same-origin tabs with the same scope share progress.
// src/bookmark-fetch.ts
export function createBookmarkFetch(scope: string) {
const key = `d1-bookmark:${scope}`;
return async function bookmarkFetch(path: string, init: RequestInit = {}): Promise<Response> {
const url = new URL(path, location.origin);
if (url.origin !== location.origin || !url.pathname.startsWith('/api/')) {
throw new Error('bookmarkFetch requires a same-origin /api/ URL.');
}
const bookmark = localStorage.getItem(key);
const headers = new Headers(init.headers);
headers.delete('X-DB-Bookmark');
if (bookmark) headers.set('X-DB-Bookmark', bookmark);
const response = await fetch(url, {
...init,
headers,
credentials: 'same-origin',
cache: 'no-store',
redirect: 'error',
});
const returned = response.headers.get('X-DB-Bookmark');
if (returned) {
await navigator.locks.request(key, () => {
const current = localStorage.getItem(key);
if (current === null || returned > current) {
localStorage.setItem(key, returned);
}
});
}
return response;
};
}Use the wrapper for each participating API request. For example, with an existing profile API:
import { createBookmarkFetch } from './bookmark-fetch';
export async function saveAndReadProfile(accountId: string, name: string) {
const api = createBookmarkFetch(`app-db:${accountId}`);
const saved = await api('/api/profile', {
method: 'POST',
headers: { 'Content-Type': 'text/plain' },
body: name,
});
if (!saved.ok) throw new Error(`Save failed: ${saved.status}`);
// Sends at least the completed save's bookmark.
const response = await api('/api/profile');
if (!response.ok) throw new Error(`Read failed: ${response.status}`);
return response.json();
}The wrapper saves the newest bookmark before resolving, so subsequent requests inherit its progress even if concurrent responses arrive out of order.
Use API endpoints that return data, not redirects.
Supporting both transports
Use this single middleware with the fetch wrapper above to support API requests alongside browser navigation and forms. It selects the newest incoming bookmark for the same database and returns it through both transports.
WARNING
The fetch wrapper retains the newest bookmark across concurrent responses, but cookies can still be overwritten out of order. For a guaranteed fresh read on a redirect's destination page, use a primary-first session.
// middleware/01.database.ts
import { getCookie, setCookie } from 'hono/cookie';
import { defineMiddleware } from 'void';
import { getBookmark, setSession } from 'void/db';
export default defineMiddleware(async (c, next) => {
const incoming: string[] = [];
// Cookie input: navigation, forms, and same-origin fetch requests.
// Remove for header-only use.
const cookieBookmark = getCookie(c, 'db-bookmark');
if (cookieBookmark) incoming.push(cookieBookmark);
// Header input: the fetch wrapper's saved progress.
// Remove for cookie-only use.
const headerBookmark = c.req.header('X-DB-Bookmark');
if (headerBookmark) incoming.push(headerBookmark);
// Bookmarks from the same database sort oldest to newest.
setSession(incoming.sort().at(-1) ?? 'first-unconstrained');
await next();
const bookmark = getBookmark();
if (bookmark) {
// Cookie output: progress for subsequent navigation and forms.
// Remove for header-only use.
setCookie(c, 'db-bookmark', bookmark, {
httpOnly: true,
secure: new URL(c.req.url).protocol === 'https:',
sameSite: 'Lax',
path: '/',
});
// Header output: progress for the fetch wrapper.
// Remove for cookie-only use.
c.header('X-DB-Bookmark', bookmark);
}
c.header('Cache-Control', 'private, no-store');
});Using createDb
For another D1 binding or a framework-owned endpoint, such as an Astro API route, create a client with the incoming bookmark. After querying, return getBookmark(client) in the response header:
import { users } from '@schema';
import { createDb, getBookmark } from 'void/db';
export async function readUsers(request: Request, binding: D1Database) {
const client = createDb(binding, {
session: request.headers.get('X-DB-Bookmark') ?? 'first-unconstrained',
});
const result = await client.select().from(users).all();
const headers = new Headers({ 'Cache-Control': 'private, no-store' });
const bookmark = getBookmark(client);
if (bookmark) headers.set('X-DB-Bookmark', bookmark);
return Response.json(result, { headers });
}Alternative Query Layers
Use env.DB from cloudflare:workers with another query library or the raw D1 API:
Kysely
import { env } from 'cloudflare:workers';
import { Kysely } from 'kysely';
import { D1Dialect } from 'kysely-d1';
const db = new Kysely<Database>({ dialect: new D1Dialect({ database: env.DB }) });Raw D1
import { env } from 'cloudflare:workers';
const { results } = await env.DB.prepare('SELECT * FROM users WHERE id = ?').bind(userId).all();Void still handles binding inference and deployment regardless of which query layer you use.
⚠️ Meta framework limitation
Nuxt and SvelteKit 2 do not support cloudflare:workers imports during local development. Use void/db or your framework's binding access API. SvelteKit 3 supports these imports.