Skip to content
Cloudflare Docs

Google Cloud SQL

Last reviewed: over 2 years ago

Connect Hyperdrive to a Google Cloud SQL database instance.

This example shows you how to connect Hyperdrive to a Google Cloud SQL MySQL database instance.

1. Allow Hyperdrive access

To allow Hyperdrive to connect to your database, you will need to ensure that Hyperdrive has valid user credentials and network access.

Cloud Console

When creating the instance or when editing an existing instance in the Google Cloud Console ↗:

To allow Hyperdrive to reach your instance:

  1. In the Cloud Console ↗, select the instance you want Hyperdrive to connect to.
  2. Expand Connections > Networking > ensure Public IP is enabled > Add a Network and input 0.0.0.0/0.
  3. Select Done > Save to persist your changes.
  4. Select Overview from the sidebar and note down the Public IP address of your instance.

To create a user for Hyperdrive to connect as:

  1. Select Users in the sidebar.
  2. Select Add User Account > select Built-in authentication.
  3. Provide a name (for example, hyperdrive-user), then select Generate to generate a password.
  4. Copy this password to your clipboard before selecting Add to create the user.

With the username, password, public IP address and (optional) database name (default: mysql), 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:

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

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:

{
  // required for database drivers to function
  "compatibility_flags": [
    "nodejs_compat"
  ],
  // Set this to today's date
  "compatibility_date": "2026-02-19",
  "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 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>;

Next steps