INTEGRITY Dokumentace

PlanetScale

Tento příklad ukazuje, jak připojit Hyperdrive k PlanetScale ↗ databáze MySQL.

1. Povolte přístup Hyperdrive

Hyperdrive můžete připojit k libovolné existující databázi kompatibilní s MySQL v PlanetScale vytvořením nového uživatele a získáním connection stringu k databázi.

PlanetScale Dashboard

  1. Přejděte na PlanetScale dashboard ↗ a vyberte databázi, ke které se chcete připojit.
  2. Klikněte na Připojit. Zadejte hyperdrive-user jako název hesla (nebo název dle vlastního výběru) a nastavte oprávnění podle potřeby. Vyberte Vytvoření hesla. Poznamenejte si uživatelské jméno a heslo, protože se znovu nezobrazí.
  3. Vyberte Ostatní jako váš jazyk nebo framework. Poznamenejte si hostitele databáze, název databáze, uživatelské jméno a heslo k databázi. Budete je potřebovat k vytvoření konfigurace databáze v Hyperdrive.

S hostitelem, názvem databáze, uživatelským jménem a heslem teď můžete vytvořit konfiguraci databáze Hyperdrive.

2. Vytvořte konfiguraci databáze

Pro konfiguraci Hyperdrive budete potřebovat:

Hyperdrive přijímá kombinaci těchto parametrů ve standardním formátu connection string používaném databázovými ovladači:

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

Většina poskytovatelů databází nabízí connection string, který můžete přímo zkopírovat a vložit do Hyperdrive.

Chcete-li vytvořit konfiguraci Hyperdrive pomocí Wrangler CLI, otevřete terminál a spusťte následující příkaz.

npx wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string="mysql://user:password@HOSTNAME_OR_IP_ADDRESS:PORT/database_name"

Tento příkaz vypíše vazbu pro Konfigurační soubor Wrangler:

{
	"$schema": "./node_modules/wrangler/config-schema.json",
	"name": "hyperdrive-example",
	"main": "src/index.ts",
	// Set this to today's date
	"compatibility_date": "2026-08-28",
	"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-08-28"
compatibility_flags = [ "nodejs_compat" ]

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

3. Používejte Hyperdrive ve svém Workeru

Nainstalujte mysql2 ↗ ovladač:

npm i mysql2@>3.13.0

Přidejte potřebné příznaky kompatibility s Node.js a vazbu Hyperdrive do svého wrangler.jsonc soubor:

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

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

Vytvořte nový connection instance a předejte parametry Hyperdrive:

// 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>;

Další kroky