Skip to content

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

PlanetScale

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

PlanetScale ↗ は、MySQL 互換および PostgreSQL のデータベースを提供するデータベースプラットフォームです。スケールしやすく、管理も安全で簡単になります。

Hyperdrive で PlanetScale に接続するには、次の手順に従います。

1. Hyperdrive へのアクセスを許可する

新しいユーザーを作成して接続文字列を取得すれば、既存の PlanetScale MySQL 互換データベースに Hyperdrive を接続できます。

PlanetScale Dashboard

  1. PlanetScale dashboard ↗ を開き、接続するデータベースを選びます。
  2. Connect を選びます。パスワード名に hyperdrive-user（または任意の名前）を入力し、権限を設定します。Create password を選びます。ユーザー名とパスワードは再表示されないので控えます。
  3. 言語またはフレームワークとして Other を選びます。データベースホスト、データベース名、データベースのユーザー名、パスワードを控えます。Hyperdrive のデータベース設定を作成するときに使います。

ホスト、データベース名、ユーザー名、パスワードが揃ったら、Hyperdrive のデータベース設定を作成できます。

2. データベース設定を作成する

Hyperdrive を設定するには、次の情報が必要です。

  • データベースの IP アドレス（またはホスト名）とポート。
  • 前の手順で設定したデータベースのユーザー名（例: hyperdrive-demo）。
  • そのユーザー名に対応するパスワード。
  • Hyperdrive が接続するデータベース名。例: mysql。

Hyperdrive は、これらのパラメーターを組み合わせた、データベースドライバーで一般的な接続文字列形式を受け付けます。

mysql://USERNAME:PASSWORD@HOSTNAME_OR_IP_ADDRESS:PORT/database_name

ほとんどのデータベースプロバイダーは、Hyperdrive にそのままコピー＆ペーストできる接続文字列を提供します。

Wrangler CLI で Hyperdrive 設定を作成するには、ターミナルを開き、次のコマンドを実行します。

  • <NAME_OF_HYPERDRIVE_CONFIG> を Hyperdrive 設定の名前に置き換え、データベースホストから提供された接続文字列を貼り付けるか、
  • user、password、HOSTNAME_OR_IP_ADDRESS、port、database_name のプレースホルダーをデータベース固有の値に置き換えます。
npx wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string="mysql://user:password@HOSTNAME_OR_IP_ADDRESS:PORT/database_name"

このコマンドは、Wrangler 設定ファイル 向けのバインディングを出力します。

{
	"$schema": "./node_modules/wrangler/config-schema.json",
	"name": "hyperdrive-example",
	"main": "src/index.ts",
	// Set this to today's date
	"compatibility_date": "2026-09-20",
	"compatibility_flags": [
		"nodejs_compat"
	],
	// Pasted from the output of `wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string=[...]` above.
	"hyperdrive": [
		{
			"binding": "HYPERDRIVE",
			"id": "<ID OF THE CREATED HYPERDRIVE CONFIGURATION>"
		}
	]
}
"$schema" = "./node_modules/wrangler/config-schema.json"
name = "hyperdrive-example"
main = "src/index.ts"
# Set this to today's date
compatibility_date = "2026-09-20"
compatibility_flags = [ "nodejs_compat" ]

[[hyperdrive]]
binding = "HYPERDRIVE"
id = "<ID OF THE CREATED HYPERDRIVE CONFIGURATION>"

3. Worker から Hyperdrive を使う

mysql2 ↗ ドライバーをインストールします。

npm i mysql2@>3.13.0

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>"

Hyperdrive のパラメーターを渡して、新しい connection インスタンスを作成します。

// mysql2 v3.13.0 or later is required
import { createConnection } from "mysql2/promise";

export default {
	async fetch(request, env, ctx): Promise<Response> {
		// Create a new connection on each request. Hyperdrive maintains the underlying
		// database connection pool, so creating a new connection is fast.
		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,
		});

		try {
			// Sample query
			const [results, fields] = await connection.query("SHOW tables;");

			// Return result rows as JSON
			return Response.json({ results, fields });
		} catch (e) {
			console.error(e);
			return Response.json(
				{ error: e instanceof Error ? e.message : e },
				{ status: 500 },
			);
		}
	},
} satisfies ExportedHandler<Env>;

次のステップ

PlanetScale との連携を設定する

PlanetScale との連携を設定する手順は次のとおりです。

  1. 接続先となる PlanetScale データベースが必要です。PlanetScale データベースを作成 ↗ するか、既存のデータベースを PlanetScale にインポート ↗ します。

  2. PlanetScale の Web コンソール ↗ で、次のクエリを使って products テーブルを作成します。

    CREATE TABLE products (
  id int NOT NULL AUTO_INCREMENT PRIMARY KEY,
  name varchar(255) NOT NULL,
  image_url varchar(255),
  category_id INT,
  KEY category_id_idx (category_id)
);

  3. 作成したテーブルにデータを挿入します。次のコマンドを実行して、商品とカテゴリを追加します。

    INSERT INTO products (name, image_url, category_id)
VALUES ('Ballpoint pen', 'https://example.com/500x500', '1');

  4. Worker に PlanetScale のデータベース認証情報を設定します。

    PlanetScale のデータベース認証情報を、Worker のシークレットとして追加します。PlanetScale Dashboard ↗ で接続文字列を作成して接続情報を取得し、Wrangler でシークレットとして追加します。

    # Add the database host as a secret
npx wrangler secret put DATABASE_HOST
# When prompted, paste your PlanetScale host

# Add the database username as a secret
npx wrangler secret put DATABASE_USERNAME
# When prompted, paste your PlanetScale username

# Add the database password as a secret
npx wrangler secret put DATABASE_PASSWORD
# When prompted, paste your PlanetScale password

  5. Worker で @planetscale/database ドライバーをインストールし、PlanetScale データベースに接続してデータの操作を始めます。

    npm i @planetscale/database

  6. 次の例は、Worker から PlanetScale データベースへクエリする手順です。接続に必要な認証情報は、Worker のシークレットとして追加済みです。

    import { connect } from "@planetscale/database";

export default {
	async fetch(request, env) {
		const config = {
			host: env.DATABASE_HOST,
			username: env.DATABASE_USERNAME,
			password: env.DATABASE_PASSWORD,
			// see https://github.com/cloudflare/workerd/issues/698
			fetch: (url, init) => {
				delete init["cache"];
				return fetch(url, init);
			},
		};

		const conn = connect(config);
		const data = await conn.execute("SELECT * FROM products;");
		return new Response(JSON.stringify(data.rows), {
			status: 200,
			headers: {
				"Content-Type": "application/json",
			},
		});
	},
};

PlanetScale の詳細は、PlanetScale の公式ドキュメント ↗ を参照してください。

役に立ちましたか？