INTEGRITY Dokumentace

PlanetScale

PlanetScale je databázová platforma, která poskytuje databáze kompatibilní s MySQL a PostgreSQL, čímž je činí lépe škálovatelnými a snadněji a bezpečněji spravovatelnými.

Chcete-li se připojit k PlanetScale pomocí Hyperdrive, postupujte takto:

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:

  • IP adresa (nebo hostname) a port vaší databáze.
  • Uživatelské jméno databáze (například hyperdrive-demo) kterou jste nakonfigurovali v předchozím kroku.
  • Heslo přiřazené k tomuto uživatelskému jménu.
  • Název databáze, ke které se má Hyperdrive připojit. Například mysql.

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.

  • Nahraďte <NAME_OF_HYPERDRIVE_CONFIG> názvem konfigurace Hyperdrive a vložte connection string poskytnutý vaším databázovým hostitelem, nebo,
  • Nahraďte user, password, HOSTNAME_OR_IP_ADDRESS, port, a database_name zástupné symboly za symboly specifické pro vaši databázi:
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

Nastavit integraci s PlanetScale

Chcete-li nastavit integraci se službou PlanetScale:

  1. Potřebujete existující databázi PlanetScale, ke které se připojíte. Vytvořte databázi PlanetScale nebo importovat existující databázi do PlanetScale.

  2. Z Webová konzole PlanetScale, vytvořte products tabulku pomocí následujícího dotazu:

    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. Vložte nějaká data do nově vytvořené tabulky. Spuštěním následujícího příkazu přidáte do tabulky produkt a kategorii:

    INSERT INTO products (name, image_url, category_id)
    VALUES ('Ballpoint pen', 'https://example.com/500x500', '1');
  4. Nakonfigurujte přihlašovací údaje databáze PlanetScale ve svém Workeru:

    Do Workeru musíte jako secrets přidat přihlašovací údaje k databázi PlanetScale. Údaje pro připojení získáte v PlanetScale Dashboard vytvořením connection stringu a jejich následným přidáním jako secrets pomocí Wrangleru:

    # 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. Ve svém Workeru nainstalujte @planetscale/database ovladač pro připojení k databázi PlanetScale a začněte pracovat s daty:

    npm i @planetscale/database
  6. Následující příklad ukazuje, jak ve Workeru odeslat dotaz do databáze PlanetScale. Přihlašovací údaje potřebné pro připojení k PlanetScale byly do Workeru přidány jako secrets.

    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",
    			},
    		});
    	},
    };

Další informace o PlanetScale naleznete v Oficiální dokumentace PlanetScale.