Skip to content
Cloudflare Docs

PlanetScale

PlanetScale ↗ is a database platform that provides MySQL-compatible and PostgreSQL databases, making them more scalable, easier and safer to manage.

To connect to PlanetScale using Hyperdrive, follow these steps:

1. Allow Hyperdrive access

You can connect Hyperdrive to any existing PlanetScale MySQL-compatible database by creating a new user and fetching your database connection string.

PlanetScale Dashboard

  1. Go to the PlanetScale dashboard ↗ and select the database you wish to connect to.
  2. Click Connect. Enter hyperdrive-user as the password name (or your preferred name) and configure the permissions as desired. Select Create password. Note the username and password as they will not be displayed again.
  3. Select Other as your language or framework. Note down the database host, database name, database username, and password. You will need these to create a database configuration in Hyperdrive.

With the host, database name, username and password, you can now create a Hyperdrive database configuration.

2. Create a database configuration

To configure Hyperdrive, you will need:

  • The IP address (or hostname) and port of your database.
  • The database username (for example, hyperdrive-demo) you configured in a previous step.
  • The password associated with that username.
  • The name of the database you want Hyperdrive to connect to. For example, mysql.

Hyperdrive accepts the combination of these parameters in the common connection string format used by database drivers:

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

Most database providers will provide a connection string you can copy-and-paste directly into Hyperdrive.

To create a Hyperdrive configuration with the Wrangler CLI, open your terminal and run the following command.

  • Replace <NAME_OF_HYPERDRIVE_CONFIG> with a name for your Hyperdrive configuration and paste the connection string provided from your database host, or,
  • Replace user, password, HOSTNAME_OR_IP_ADDRESS, port, and database_name placeholders with those specific to your database:
Terminal window
npx wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string="mysql://user:password@HOSTNAME_OR_IP_ADDRESS:PORT/database_name"

This command outputs a binding for the Wrangler configuration file:

{
  "name": "hyperdrive-example",
  "main": "src/index.ts",
  "compatibility_date": "2024-08-21",
  "compatibility_flags": [
    "nodejs_compat"
  ],
  "hyperdrive": [
    {
      "binding": "HYPERDRIVE",
      "id": "<ID OF THE CREATED HYPERDRIVE CONFIGURATION>"
    }
  ]
}

3. Use Hyperdrive from your Worker

Install the mysql2 ↗ driver:

Terminal window
npm i mysql2@>3.13.0

Add the required Node.js compatibility flags and Hyperdrive binding to your wrangler.jsonc file:

{
  "compatibility_flags": [
    "nodejs_compat"
  ],
  "compatibility_date": "2024-09-23",
  "hyperdrive": [
    {
      "binding": "HYPERDRIVE",
      "id": "<your-hyperdrive-id-here>"
    }
  ]
}

Create a new connection instance and pass the Hyperdrive parameters:

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


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


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


      // Clean up the client after the response is returned, before the Worker is killed
      ctx.waitUntil(connection.end());


      // Return result rows as JSON
      return Response.json({ results, fields });
    } catch (e) {
      console.error(e);
    }
  },
} satisfies ExportedHandler<Env>;

Next steps