Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

Drizzle ORM

最終更新 Markdown で表示Agent セットアップ

Drizzle ORM は、型安全性を重視した軽量な TypeScript ORM です。この例では、Cloudflare Workers アプリケーションで Hyperdrive 経由の MySQL に Drizzle ORM を使う方法を示します。

前提条件

1. Drizzle をインストールする

Drizzle ORM と、mysql2 ドライバーなどの依存関係をインストールします。

# mysql2 v3.13.0 or later is required
npm i drizzle-orm mysql2 dotenv
npm i -D drizzle-kit tsx @types/node

wrangler.jsonc に、必要な Node.js 互換フラグと Hyperdrive バインディングを追加します。

{
	// required for database drivers to function
	"compatibility_flags": [
		"nodejs_compat"
	],
	// Set this to today's date
	"compatibility_date": "2026-09-20",
	"hyperdrive": [
		{
			"binding": "HYPERDRIVE",
			"id": "<your-hyperdrive-id-here>"
		}
	]
}
compatibility_flags = [ "nodejs_compat" ]
# Set this to today's date
compatibility_date = "2026-09-20"

[[hyperdrive]]
binding = "HYPERDRIVE"
id = "<your-hyperdrive-id-here>"

2. Drizzle を設定する

2.1. スキーマを定義する

Drizzle ORM では、生の SQL ではなく TypeScript でスキーマを定義します。

  1. /src//db/ フォルダーを作成します。

  2. schema.ts ファイルを作成します。

  3. schema.ts で、次のように users テーブルを定義します。

    src/db/schema.tsts
    // src/schema.ts
    import { mysqlTable, int, varchar, timestamp } from "drizzle-orm/mysql-core";
    
    export const users = mysqlTable("users", {
    	id: int("id").primaryKey().autoincrement(),
    	name: varchar("name", { length: 255 }).notNull(),
    	email: varchar("email", { length: 255 }).notNull().unique(),
    	createdAt: timestamp("created_at").defaultNow(),
    });

2.2. Hyperdrive で Drizzle ORM をデータベースに接続する

Drizzle ORM を使うときは、Hyperdrive 設定の認証情報を使います。

次のように index.ts を記述します。

src/index.tsts
// src/index.ts

import { drizzle } from "drizzle-orm/mysql2";
import { createConnection } from "mysql2/promise";
import { users } from "./db/schema";

export interface Env {
	HYPERDRIVE: Hyperdrive;
  }

export default {
	async fetch(request, env, ctx): Promise<Response> {
		// Create a connection using the mysql2 driver with the Hyperdrive credentials (only accessible from your Worker).
		const connection = await createConnection({
			host: env.HYPERDRIVE.host,
			user: env.HYPERDRIVE.user,
			password: env.HYPERDRIVE.password,
			database: env.HYPERDRIVE.database,
			port: env.HYPERDRIVE.port,

			// Required to enable mysql2 compatibility for Workers
			disableEval: true,
		});

		// Create the Drizzle client with the mysql2 driver connection
		const db = drizzle(connection);

		// Sample query to get all users
		const allUsers = await db.select().from(users);

		return Response.json(allUsers);
	},
} satisfies ExportedHandler<Env>;

2.3. マイグレーション用に Drizzle Kit を設定する(任意)

Drizzle Kit CLI を使うと、スキーマに基づいて SQL マイグレーションを生成し、データベースで実行できます。詳細は Drizzle ORM のドキュメント を参照してください。

  1. プロジェクトのルートフォルダーに .env ファイルを作成し、データベースの接続文字列を追加します。Drizzle Kit CLI はこの接続文字列を使ってマイグレーションを作成・適用します。

    .envtoml
    # .env
    # Replace with your direct database connection string
    DATABASE_URL='mysql://user:password@db-host.cloud/database-name'
  2. プロジェクトのルートフォルダーに drizzle.config.ts を作成して Drizzle Kit を設定し、次の内容を追加します。

    drizzle.config.tsts
    import 'dotenv/config';
    import { defineConfig } from 'drizzle-kit';
    export default defineConfig({
    out: './drizzle',
    schema: './src/db/schema.ts',
    dialect: 'mysql',
    dbCredentials: {
    url: process.env.DATABASE_URL!,
      },
    });
  3. スキーマファイルに従ってデータベース用のマイグレーションファイルを生成し、データベースに適用します。

    npx drizzle-kit generate
    No config path provided, using default 'drizzle.config.ts'
    Reading config file 'drizzle.config.ts'
    Reading schema files:
    /src/db/schema.ts
    
    1 tables
    users 4 columns 0 indexes 0 fks
    
    [✓] Your SQL migration file ➜ drizzle/0000_daffy_rhodey.sql 🚀
    npx drizzle-kit migrate
    No config path provided, using default 'drizzle.config.ts'
    Reading config file 'drizzle.config.ts'

3. Worker をデプロイする

Worker をデプロイします。

npx wrangler deploy

次のステップ

役に立ちましたか?