Loading...
Loading...
Build type-safe D1 databases with Drizzle ORM for Cloudflare Workers. Includes schema definition, migrations with Drizzle Kit, relations, and D1 batch API patterns. Prevents 12 errors including SQL BEGIN failures. Use when: defining D1 schemas, managing migrations, writing type-safe queries, implementing relations or prepared statements, using batch API for transactions, or troubleshooting D1_ERROR, BEGIN TRANSACTION, foreign keys, migration apply, or schema inference errors. Prevents 12 documented issues: D1 transaction errors (SQL BEGIN not supported), foreign key constraint failures during migrations, module import errors with Wrangler, D1 binding not found, migration apply failures, schema TypeScript inference errors, prepared statement caching issues, transaction rollback patterns, TypeScript strict mode errors, drizzle.config.ts not found, remote vs local database confusion, and wrangler.toml vs wrangler.jsonc mixing. Keywords: drizzle orm, drizzle d1, type-safe sql, drizzle schema, drizzle migrations, drizzle kit, orm cloudflare, d1 orm, drizzle typescript, drizzle relations, drizzle transactions, drizzle query builder, schema definition, prepared statements, drizzle batch, migration management, relational queries, drizzle joins, D1_ERROR, BEGIN TRANSACTION d1, foreign key constraint, migration failed, schema not found, d1 binding error
npx skill4agent add ovachiever/droid-tings drizzle-orm-d1npm install drizzle-orm
npm install -D drizzle-kit
# Or with pnpm
pnpm add drizzle-orm
pnpm add -D drizzle-kitdrizzle.config.tsimport { defineConfig } from 'drizzle-kit';
export default defineConfig({
schema: './src/db/schema.ts',
out: './migrations',
dialect: 'sqlite',
driver: 'd1-http',
dbCredentials: {
accountId: process.env.CLOUDFLARE_ACCOUNT_ID!,
databaseId: process.env.CLOUDFLARE_DATABASE_ID!,
token: process.env.CLOUDFLARE_D1_TOKEN!,
},
});dialect: 'sqlite'driver: 'd1-http'wrangler.jsonc{
"name": "my-worker",
"main": "src/index.ts",
"compatibility_date": "2025-10-11",
"d1_databases": [
{
"binding": "DB",
"database_name": "my-database",
"database_id": "your-database-id",
"preview_database_id": "local-db",
"migrations_dir": "./migrations" // ← Points to Drizzle migrations!
}
]
}migrations_dir./migrationsoutwrangler d1 migrations applysrc/db/schema.tsimport { sqliteTable, text, integer } from 'drizzle-orm/sqlite-core';
import { relations } from 'drizzle-orm';
export const users = sqliteTable('users', {
id: integer('id').primaryKey({ autoIncrement: true }),
email: text('email').notNull().unique(),
name: text('name').notNull(),
createdAt: integer('created_at', { mode: 'timestamp' }).$defaultFn(() => new Date()),
});
export const posts = sqliteTable('posts', {
id: integer('id').primaryKey({ autoIncrement: true }),
title: text('title').notNull(),
content: text('content').notNull(),
authorId: integer('author_id')
.notNull()
.references(() => users.id, { onDelete: 'cascade' }),
createdAt: integer('created_at', { mode: 'timestamp' }).$defaultFn(() => new Date()),
});
// Define relations for type-safe joins
export const usersRelations = relations(users, ({ many }) => ({
posts: many(posts),
}));
export const postsRelations = relations(posts, ({ one }) => ({
author: one(users, { fields: [posts.authorId], references: [users.id] }),
}));integerintegermode: 'timestamp'.$defaultFn().default()# Step 1: Generate SQL migration from schema
npx drizzle-kit generate
# Step 2: Apply to local database (for testing)
npx wrangler d1 migrations apply my-database --local
# Step 3: Apply to production database
npx wrangler d1 migrations apply my-database --remotedrizzle-kit generate./migrations--localsrc/index.tsimport { drizzle } from 'drizzle-orm/d1';
import { users, posts } from './db/schema';
import { eq } from 'drizzle-orm';
export interface Env {
DB: D1Database;
}
export default {
async fetch(request: Request, env: Env): Promise<Response> {
const db = drizzle(env.DB);
// Type-safe select with full inference
const allUsers = await db.select().from(users);
// Select with where clause
const user = await db
.select()
.from(users)
.where(eq(users.email, 'test@example.com'))
.get(); // .get() returns first result or undefined
// Insert with returning
const [newUser] = await db
.insert(users)
.values({ email: 'new@example.com', name: 'New User' })
.returning();
// Update
await db
.update(users)
.set({ name: 'Updated Name' })
.where(eq(users.id, 1));
// Delete
await db
.delete(users)
.where(eq(users.id, 1));
return Response.json({ allUsers, user, newUser });
},
};.get().all()drizzle-ormeqgtltandor.returning()# Core dependencies
npm install drizzle-orm
# Dev dependencies
npm install -D drizzle-kit @cloudflare/workers-types
# Optional: For local development with SQLite
npm install -D better-sqlite3.env# Get these from Cloudflare dashboard
CLOUDFLARE_ACCOUNT_ID=your-account-id
CLOUDFLARE_DATABASE_ID=your-database-id
CLOUDFLARE_D1_TOKEN=your-api-tokenwrangler d1 create my-databasemy-project/
├── drizzle.config.ts # Drizzle Kit configuration
├── wrangler.jsonc # Wrangler configuration
├── src/
│ ├── index.ts # Worker entry point
│ └── db/
│ └── schema.ts # Database schema
├── migrations/ # Generated by drizzle-kit
│ ├── meta/
│ │ └── _journal.json
│ └── 0001_initial_schema.sql
└── package.jsontsconfig.json{
"compilerOptions": {
"target": "ES2022",
"module": "ESNext",
"lib": ["ES2022"],
"types": ["@cloudflare/workers-types"],
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"moduleResolution": "bundler",
"resolveJsonModule": true,
"isolatedModules": true
}
}drizzle-kit generate--local--remote.get()db.batch()integermode: 'timestamp'.$defaultFn().default()migrations_dir./migrationseqgtandorBEGIN TRANSACTIONwrangler d1 migrations applydrizzle-kit migratedrizzle-kit pushgenerateapply--localdrizzle.config.ts.default().$defaultFn()D1_ERROR: Cannot use BEGIN TRANSACTIONBEGIN TRANSACTIONstate.storage.transaction()BEGIN TRANSACTION// ❌ DON'T: Use traditional transactions
await db.transaction(async (tx) => {
await tx.insert(users).values({ email: 'test@example.com', name: 'Test' });
await tx.insert(posts).values({ title: 'Post', content: 'Content', authorId: 1 });
});
// ✅ DO: Use D1 batch API
await db.batch([
db.insert(users).values({ email: 'test@example.com', name: 'Test' }),
db.insert(posts).values({ title: 'Post', content: 'Content', authorId: 1 }),
]);templates/transactions.tsFOREIGN KEY constraint failed: SQLITE_CONSTRAINTPRAGMA foreign_keys = OFF;export const posts = sqliteTable('posts', {
id: integer('id').primaryKey({ autoIncrement: true }),
authorId: integer('author_id')
.notNull()
.references(() => users.id, { onDelete: 'cascade' }), // ← Cascading deletes
});templates/schema.tsError: No such module "wrangler"wranglerimport { drizzle } from 'drizzle-orm/d1'templates/cloudflare-worker-integration.tsTypeError: Cannot read property 'prepare' of undefinedenv.DB is undefinedwrangler.jsonc// wrangler.jsonc
{
"d1_databases": [
{
"binding": "DB", // ← Must match env.DB in code
"database_name": "my-database",
"database_id": "your-db-id"
}
]
}// src/index.ts
export interface Env {
DB: D1Database; // ← Must match binding name
}
export default {
async fetch(request: Request, env: Env) {
const db = drizzle(env.DB); // ← Accessing the binding
// ...
},
};references/wrangler-setup.mdMigration failed to apply: near "...": syntax errornpx wrangler d1 migrations apply my-database --local./migrationsrm -rf migrations/
npx drizzle-kit generatereferences/migration-workflow.mdType instantiation is excessively deep and possibly infiniteimport { InferSelectModel } from 'drizzle-orm';
// Define types explicitly
export type User = InferSelectModel<typeof users>;
export type Post = InferSelectModel<typeof posts>;
// Use explicit types in relations
export const usersRelations = relations(users, ({ many }) => ({
posts: many(posts),
}));references/schema-patterns.md.all().get().run()// ✅ Correct: Use .all() for arrays
const users = await db.select().from(users).all();
// ✅ Correct: Use .get() for single result
const user = await db.select().from(users).where(eq(users.id, 1)).get();
// ❌ Wrong: Don't rely on caching behavior
const stmt = db.select().from(users); // Don't reuse across requeststemplates/prepared-statements.tstry {
const results = await db.batch([
db.insert(users).values({ email: 'test@example.com', name: 'Test' }),
db.insert(posts).values({ title: 'Post', content: 'Content', authorId: 1 }),
]);
// Both succeeded
} catch (error) {
// Manual cleanup if needed
console.error('Batch failed:', error);
// Potentially delete partially created records
}templates/transactions.tsstrict: true// ✅ Explicit return type
async function getUser(id: number): Promise<User | undefined> {
return await db.select().from(users).where(eq(users.id, id)).get();
}
// ✅ Type assertion when needed
const user = await db.select().from(users).where(eq(users.id, 1)).get() as User;Cannot find drizzle.config.tsdrizzle.config.tsdrizzle.config.tsdrizzle.config.jsdrizzle-config.tssrc/--confignpx drizzle-kit generate --config=custom.config.ts--local# Development: Always use --local
npx wrangler d1 migrations apply my-database --local
npx wrangler dev # Uses local database
# Production: Use --remote
npx wrangler d1 migrations apply my-database --remote
npx wrangler deploy # Uses remote databasereferences/migration-workflow.mdwrangler.jsonc// wrangler.jsonc (supports comments!)
{
"name": "my-worker",
// This is a comment
"d1_databases": [
{
"binding": "DB",
"database_name": "my-database"
}
]
}# wrangler.toml (old format)
name = "my-worker"references/wrangler-setup.mdimport { defineConfig } from 'drizzle-kit';
export default defineConfig({
// Schema location (can be file or directory)
schema: './src/db/schema.ts',
// Output directory for migrations
out: './migrations',
// Database dialect
dialect: 'sqlite',
// D1 HTTP driver (for remote access)
driver: 'd1-http',
// Cloudflare credentials
dbCredentials: {
accountId: process.env.CLOUDFLARE_ACCOUNT_ID!,
databaseId: process.env.CLOUDFLARE_DATABASE_ID!,
token: process.env.CLOUDFLARE_D1_TOKEN!,
},
// Verbose output
verbose: true,
// Strict mode
strict: true,
});{
"name": "my-worker",
"main": "src/index.ts",
"compatibility_date": "2025-10-11",
// D1 database bindings
"d1_databases": [
{
"binding": "DB",
"database_name": "my-database",
"database_id": "your-production-db-id",
"preview_database_id": "local-db",
"migrations_dir": "./migrations" // Points to Drizzle migrations
}
],
// Node.js compatibility for Drizzle
"compatibility_flags": ["nodejs_compat"]
}{
"scripts": {
"dev": "wrangler dev",
"deploy": "wrangler deploy",
"db:generate": "drizzle-kit generate",
"db:push": "drizzle-kit push",
"db:studio": "drizzle-kit studio",
"db:migrate:local": "wrangler d1 migrations apply my-database --local",
"db:migrate:remote": "wrangler d1 migrations apply my-database --remote"
}
}import { drizzle } from 'drizzle-orm/d1';
import { users } from './db/schema';
import { eq, and, or, gt, lt, like } from 'drizzle-orm';
const db = drizzle(env.DB);
// Create
const [newUser] = await db
.insert(users)
.values({ email: 'new@example.com', name: 'New User' })
.returning();
// Read (all)
const allUsers = await db.select().from(users).all();
// Read (single)
const user = await db
.select()
.from(users)
.where(eq(users.id, 1))
.get();
// Read (with conditions)
const activeUsers = await db
.select()
.from(users)
.where(and(
gt(users.createdAt, new Date('2024-01-01')),
like(users.email, '%@example.com')
))
.all();
// Update
await db
.update(users)
.set({ name: 'Updated Name' })
.where(eq(users.id, 1));
// Delete
await db
.delete(users)
.where(eq(users.id, 1));templates/basic-queries.tsimport { drizzle } from 'drizzle-orm/d1';
import { users, posts } from './db/schema';
import { eq } from 'drizzle-orm';
const db = drizzle(env.DB, { schema: { users, posts, usersRelations, postsRelations } });
// Nested query (requires relations defined)
const usersWithPosts = await db.query.users.findMany({
with: {
posts: true,
},
});
// Manual join
const usersWithPosts2 = await db
.select({
user: users,
post: posts,
})
.from(users)
.leftJoin(posts, eq(posts.authorId, users.id))
.all();
// Filter nested queries
const userWithRecentPosts = await db.query.users.findFirst({
where: eq(users.id, 1),
with: {
posts: {
where: gt(posts.createdAt, new Date('2024-01-01')),
orderBy: [desc(posts.createdAt)],
limit: 10,
},
},
});templates/relations-queries.tsimport { drizzle } from 'drizzle-orm/d1';
import { users, posts } from './db/schema';
const db = drizzle(env.DB);
// Batch insert
const results = await db.batch([
db.insert(users).values({ email: 'user1@example.com', name: 'User 1' }),
db.insert(users).values({ email: 'user2@example.com', name: 'User 2' }),
db.insert(users).values({ email: 'user3@example.com', name: 'User 3' }),
]);
// Batch with error handling
try {
const results = await db.batch([
db.insert(users).values({ email: 'test@example.com', name: 'Test' }),
db.insert(posts).values({ title: 'Post', content: 'Content', authorId: 1 }),
]);
console.log('All operations succeeded');
} catch (error) {
console.error('Batch failed:', error);
// Manual cleanup if needed
}templates/transactions.tsimport { drizzle } from 'drizzle-orm/d1';
import { users } from './db/schema';
import { eq } from 'drizzle-orm';
const db = drizzle(env.DB);
// Prepared statement (reusable query)
const getUserById = db
.select()
.from(users)
.where(eq(users.id, sql.placeholder('id')))
.prepare();
// Execute with different parameters
const user1 = await getUserById.get({ id: 1 });
const user2 = await getUserById.get({ id: 2 });templates/prepared-statements.ts./scripts/check-versions.shChecking Drizzle ORM versions...
✓ drizzle-orm: 0.44.7 (latest)
✓ drizzle-kit: 0.31.5 (latest)import { InferSelectModel, InferInsertModel } from 'drizzle-orm';
import { users } from './db/schema';
// Infer types from schema
export type User = InferSelectModel<typeof users>;
export type NewUser = InferInsertModel<typeof users>;
// Usage
const user: User = await db.select().from(users).where(eq(users.id, 1)).get();
const newUser: NewUser = {
email: 'test@example.com',
name: 'Test User',
// createdAt is optional (has default)
};src/db/schema.tsnpm run db:generate./migrationsnpm run db:migrate:localnpm run devnpm run deploynpm run db:migrate:remotereferences/migration-workflow.mdexport const events = sqliteTable('events', {
id: integer('id').primaryKey({ autoIncrement: true }),
// ✅ Use integer with timestamp mode
createdAt: integer('created_at', { mode: 'timestamp' }).$defaultFn(() => new Date()),
// ❌ Don't use text for dates
// createdAt: text('created_at'),
});
// Query with date comparisons
const recentEvents = await db
.select()
.from(events)
.where(gt(events.createdAt, new Date('2024-01-01')))
.all();drizzle-orm@0.44.7drizzle-kit@0.31.5better-sqlite3@12.4.1@cloudflare/workers-types@4.20251014.0/drizzle-team/drizzle-orm-docs{
"dependencies": {
"drizzle-orm": "^0.44.7"
},
"devDependencies": {
"drizzle-kit": "^0.31.5",
"@cloudflare/workers-types": "^4.20251014.0",
"better-sqlite3": "^12.4.1"
}
}D1_ERROR: Cannot use BEGIN TRANSACTIONdb.batch()db.transaction()--localInferSelectModeldrizzle-kit generatewrangler d1 migrations apply --local--remotewrangler deployreferences/common-errors.md