Skip to content
Cloudflare Docs

CockroachDB

Connect Hyperdrive to a CockroachDB database.

This example shows you how to connect Hyperdrive to a CockroachDB ↗ database cluster. CockroachDB is a PostgreSQL-compatible distributed SQL database with strong consistency guarantees.

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.

CockroachDB Console

The steps below assume you have an existing CockroachDB Cloud account ↗ and database cluster created.

To create and/or fetch your database credentials:

  1. Go to the CockroachDB Cloud console ↗ and select the cluster you want Hyperdrive to connect to.
  2. Select SQL Users from the sidebar on the left, and select Add User.
  3. Enter a username (for example, `hyperdrive-user), and select Generate & Save Password.
  4. Note down the username and copy the password to a temporary location.

To retrieve your database connection details:

  1. Go to the CockroachDB Cloud console ↗ and select the cluster you want Hyperdrive to connect to.
  2. Select Connect in the top right.
  3. Choose the user you created, for example,hyperdrive-user.
  4. Select the database, for example defaultdb.
  5. Select General connection string as the option.
  6. In the text box below, select Copy to copy the connection string.

By default, the CockroachDB cloud enables connections from the public Internet (0.0.0.0/0). If you have changed these settings on an existing cluster, you will need to allow connections from the public Internet for Hyperdrive to connect.

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:

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

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:

Terminal window
npx wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string="postgres://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 node-postgres driver:

Terminal window
npm i pg@>8.13.0

If using TypeScript, install the types package:

Terminal window
npm i -D @types/pg

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 Client instance and pass the Hyperdrive connectionString:

// filepath: src/index.ts
import { Client } from "pg";


export default {
  async fetch(
    request: Request,
    env: Env,
    ctx: ExecutionContext,
  ): Promise<Response> {
    // Create a new client instance for each request.
    const client = new Client({
      connectionString: env.HYPERDRIVE.connectionString,
    });


    try {
      // Connect to the database
      await client.connect();
      console.log("Connected to PostgreSQL database");


      // Perform a simple query
      const result = await client.query("SELECT * FROM pg_tables");


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


      return Response.json({
        success: true,
        result: result.rows,
      });
    } catch (error: any) {
      console.error("Database error:", error.message);


      return Response.error();
    }
  },
};

Next steps