set up durable object

tknkaa · tknkaa · commit b55b0bb317fb · 2025-12-26T20:04:52.000+09:00
diff --git a/README.md b/README.md
@@ -6,3 +6,5 @@ cp .env.example .env
 docker compose up
 bun dev
 ```
+
+After running `bunx drizzle-kit generate --config=drizzle-do.config.ts`, you need to add `?raw` to SQL file names in drizzle-do/migraions.js`.
diff --git a/app/lib/db/schema-do.ts b/app/lib/db/schema-do.ts
@@ -0,0 +1,9 @@
+import { int, sqliteTable, text } from "drizzle-orm/sqlite-core";
+
+export const usersTable = sqliteTable("users_table", {
+	id: int().primaryKey({ autoIncrement: true }),
+	name: text().notNull(),
+	age: int().notNull(),
+	email: text().notNull().unique(),
+	gender: text().notNull(),
+});
diff --git a/app/routes/api.do.ts b/app/routes/api.do.ts
@@ -0,0 +1,17 @@
+import type { Route } from "./+types/api.do";
+
+export async function loader({ context }: Route.LoaderArgs) {
+	const { env } = context.cloudflare;
+	const id = env.DO.idFromName("user-id-999");
+	const stub = env.DO.get(id);
+	const userAll = await stub.insertAndList({
+		name: "John",
+		age: 30,
+		email: "john@example.com",
+		gender: "male",
+	});
+	console.log(
+		"New user created. Getting all usersfrom the database: ",
+		userAll,
+	);
+}
diff --git a/drizzle-do.config.ts b/drizzle-do.config.ts
@@ -0,0 +1,8 @@
+import { defineConfig } from "drizzle-kit";
+
+export default defineConfig({
+	out: "./drizzle-do",
+	schema: "./app/lib/db/schema-do.ts",
+	dialect: "sqlite",
+	driver: "durable-sqlite",
+});
diff --git a/drizzle-do/0000_bright_dark_phoenix.sql b/drizzle-do/0000_bright_dark_phoenix.sql
@@ -0,0 +1,8 @@
+CREATE TABLE `users_table` (
+	`id` integer PRIMARY KEY AUTOINCREMENT NOT NULL,
+	`name` text NOT NULL,
+	`age` integer NOT NULL,
+	`email` text NOT NULL
+);
+--> statement-breakpoint
+CREATE UNIQUE INDEX `users_table_email_unique` ON `users_table` (`email`);
diff --git a/drizzle-do/0001_awesome_brood.sql b/drizzle-do/0001_awesome_brood.sql
@@ -0,0 +1 @@
+ALTER TABLE `users_table` ADD `gender` text NOT NULL;
diff --git a/drizzle-do/meta/0000_snapshot.json b/drizzle-do/meta/0000_snapshot.json
@@ -0,0 +1,62 @@
+{
+	"version": "6",
+	"dialect": "sqlite",
+	"id": "d58425e2-8b31-424e-88a2-0a69d601dda8",
+	"prevId": "00000000-0000-0000-0000-000000000000",
+	"tables": {
+		"users_table": {
+			"name": "users_table",
+			"columns": {
+				"id": {
+					"name": "id",
+					"type": "integer",
+					"primaryKey": true,
+					"notNull": true,
+					"autoincrement": true
+				},
+				"name": {
+					"name": "name",
+					"type": "text",
+					"primaryKey": false,
+					"notNull": true,
+					"autoincrement": false
+				},
+				"age": {
+					"name": "age",
+					"type": "integer",
+					"primaryKey": false,
+					"notNull": true,
+					"autoincrement": false
+				},
+				"email": {
+					"name": "email",
+					"type": "text",
+					"primaryKey": false,
+					"notNull": true,
+					"autoincrement": false
+				}
+			},
+			"indexes": {
+				"users_table_email_unique": {
+					"name": "users_table_email_unique",
+					"columns": ["email"],
+					"isUnique": true
+				}
+			},
+			"foreignKeys": {},
+			"compositePrimaryKeys": {},
+			"uniqueConstraints": {},
+			"checkConstraints": {}
+		}
+	},
+	"views": {},
+	"enums": {},
+	"_meta": {
+		"schemas": {},
+		"tables": {},
+		"columns": {}
+	},
+	"internal": {
+		"indexes": {}
+	}
+}
diff --git a/drizzle-do/meta/0001_snapshot.json b/drizzle-do/meta/0001_snapshot.json
@@ -0,0 +1,69 @@
+{
+	"version": "6",
+	"dialect": "sqlite",
+	"id": "9306fd7c-dafe-47aa-ba50-02934629179f",
+	"prevId": "d58425e2-8b31-424e-88a2-0a69d601dda8",
+	"tables": {
+		"users_table": {
+			"name": "users_table",
+			"columns": {
+				"id": {
+					"name": "id",
+					"type": "integer",
+					"primaryKey": true,
+					"notNull": true,
+					"autoincrement": true
+				},
+				"name": {
+					"name": "name",
+					"type": "text",
+					"primaryKey": false,
+					"notNull": true,
+					"autoincrement": false
+				},
+				"age": {
+					"name": "age",
+					"type": "integer",
+					"primaryKey": false,
+					"notNull": true,
+					"autoincrement": false
+				},
+				"email": {
+					"name": "email",
+					"type": "text",
+					"primaryKey": false,
+					"notNull": true,
+					"autoincrement": false
+				},
+				"gender": {
+					"name": "gender",
+					"type": "text",
+					"primaryKey": false,
+					"notNull": true,
+					"autoincrement": false
+				}
+			},
+			"indexes": {
+				"users_table_email_unique": {
+					"name": "users_table_email_unique",
+					"columns": ["email"],
+					"isUnique": true
+				}
+			},
+			"foreignKeys": {},
+			"compositePrimaryKeys": {},
+			"uniqueConstraints": {},
+			"checkConstraints": {}
+		}
+	},
+	"views": {},
+	"enums": {},
+	"_meta": {
+		"schemas": {},
+		"tables": {},
+		"columns": {}
+	},
+	"internal": {
+		"indexes": {}
+	}
+}
diff --git a/drizzle-do/meta/_journal.json b/drizzle-do/meta/_journal.json
@@ -0,0 +1,20 @@
+{
+	"version": "7",
+	"dialect": "sqlite",
+	"entries": [
+		{
+			"idx": 0,
+			"version": "6",
+			"when": 1766743478456,
+			"tag": "0000_bright_dark_phoenix",
+			"breakpoints": true
+		},
+		{
+			"idx": 1,
+			"version": "6",
+			"when": 1766746001866,
+			"tag": "0001_awesome_brood",
+			"breakpoints": true
+		}
+	]
+}
diff --git a/drizzle-do/migrations.js b/drizzle-do/migrations.js
@@ -0,0 +1,11 @@
+import journal from "./meta/_journal.json";
+import m0000 from "./0000_bright_dark_phoenix.sql?raw";
+import m0001 from "./0001_awesome_brood.sql?raw";
+
+export default {
+  journal,
+  migrations: {
+    m0000,
+    m0001,
+  },
+};
diff --git a/tsconfig.cloudflare.json b/tsconfig.cloudflare.json
@@ -6,7 +6,8 @@
 		"app/**/.server/**/*",
 		"app/**/.client/**/*",
 		"workers/**/*",
-		"worker-configuration.d.ts"
+		"worker-configuration.d.ts",
+		"drizzle-do/**/*"
 	],
 	"compilerOptions": {
 		"composite": true,
diff --git a/workers/app.ts b/workers/app.ts
@@ -1,4 +1,12 @@
+import { DurableObject } from "cloudflare:workers";
+import {
+	type DrizzleSqliteDODatabase,
+	drizzle,
+} from "drizzle-orm/durable-sqlite";
+import { migrate } from "drizzle-orm/durable-sqlite/migrator";
 import { createRequestHandler } from "react-router";
+import { usersTable } from "~/lib/db/schema-do";
+import migrations from "../drizzle-do/migrations";
 
 declare module "react-router" {
 	export interface AppLoadContext {
@@ -9,6 +17,32 @@ declare module "react-router" {
 	}
 }
 
+export class MyDurableObject extends DurableObject<Env> {
+	storage: DurableObjectStorage;
+	db: DrizzleSqliteDODatabase;
+	constructor(ctx: DurableObjectState, env: Env) {
+		// Required, as we're extending the base class.
+		super(ctx, env);
+		this.storage = ctx.storage;
+		this.db = drizzle(this.storage, {
+			logger: false,
+		});
+
+		ctx.blockConcurrencyWhile(async () => {
+			console.log(migrations);
+			await this._migrate();
+		});
+	}
+
+	async _migrate() {
+		migrate(this.db, migrations);
+	}
+	async insertAndList(user: typeof usersTable.$inferInsert) {
+		await this.db.insert(usersTable).values(user);
+		return this.db.select().from(usersTable);
+	}
+}
+
 const requestHandler = createRequestHandler(
 	() => import("virtual:react-router/server-build"),
 	import.meta.env.MODE,
diff --git a/wrangler.jsonc b/wrangler.jsonc
@@ -26,6 +26,27 @@
 			"database_name": "db",
 			"database_id": "3d47de4a-ae78-48e0-9aea-fab19d6c2fc9"
 		}
+	],
+	"migrations": [
+		{
+			"new_sqlite_classes": ["MyDurableObject"],
+			"tag": "v1"
+		}
+	],
+	"durable_objects": {
+		"bindings": [
+			{
+				"class_name": "MyDurableObject",
+				"name": "DO"
+			}
+		]
+	},
+	"rules": [
+		{
+			"type": "Text",
+			"globs": ["**/*.sql"],
+			"fallthrough": true
+		}
 	]
 	/**
 	 * Smart Placement

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+ALTER TABLE `users_table` ADD `gender` text NOT NULL;