Connect to Google Cloud SQL
This example shows you how to connect Hyperdrive to a Google Cloud SQL PostgreSQL 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:
- In the Cloud Console, select the instance you want Hyperdrive to connect to.
- Expand Connections > ensure Public IP is enabled > Add a Network and input
0.0.0.0/0. - Select Done > Save to persist your changes.
- Select Overview from the sidebar and note down the Public IP address of your instance.
To create a user for Hyperdrive to connect as:
- Select Users in the sidebar.
- Select Add User Account > select Built-in authentication.
- Provide a name (for example,
hyperdrive-user) > select Generate to generate a password. - 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: postgres), you can now create a Hyperdrive database configuration.
gcloud CLI
The gcloud CLI allows you to create a new user and enable Hyperdrive to connect to your database.
Use gcloud sql to create a new user (for example, hyperdrive-user) with a strong password:
Run the following command to enable Internet access to your database instance:
Refer to Google Cloud’s documentation for additional configuration options.
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,
postgres.
Hyperdrive accepts the combination of these parameters in the common connection string format used by database drivers:
Most database providers will provide a connection string you can directly 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:
This command outputs a binding for wrangler.toml:
Install the driver:
Copy the below Worker code, which passes the connection string generated from env.HYPERDRIVE.connectionString directly to the driver.
Next steps
- Learn more about How Hyperdrive Works.
- Refer to the troubleshooting guide to debug common issues.
- Understand more about other storage options available to Cloudflare Workers.