Skip to content
Cloudflare Docs

Fly

Last reviewed: 11 months ago

Connect Hyperdrive to a Fly Postgres database instance.

This example shows you how to connect Hyperdrive to a Fly Postgres database instance.

1. Allow Hyperdrive access

You can connect Hyperdrive to any existing Fly database by:

  1. Allocating a public IP address to your Fly database instance
  2. Configuring an external service
  3. Deploying the configuration
  4. Obtain the connection string, which is used to connect the database to Hyperdrive.

  1. Run the following command to allocate a public IP address ↗.

    fly ips allocate-v6 --app <pg-app-name>

  2. Configure an external service ↗ by modifying the contents of your fly.toml file. Run the following command to download the fly.toml file.

    fly config save --app <pg-app-name>

    Then, replace the services and services.ports section of the file with the following toml snippet:

    [[services]]
      internal_port = 5432 # Postgres instance
      protocol = "tcp"
    

    [[services.ports]]
      handlers = ["pg_tls"]
      port = 5432

  3. Deploy the new configuration ↗.

  4. Obtain the connection string ↗, which is in the form of:

    postgres://{username}:{password}@{public-hostname}:{port}/{database}?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:

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 Cloudflare dashboard:

  1. In the Cloudflare dashboard, go to the Hyperdrive page.

    Go to Hyperdrive

  2. Select Create Configuration.

  3. Fill out the form, including the connection string.

  4. Select Create.

3. Use Hyperdrive from your Worker

Install the node-postgres driver:

Terminal window
npm i pg@>8.16.3

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:

{
  // required for database drivers to function
  "compatibility_flags": [
    "nodejs_compat"
  ],
  // Set this to today's date
  "compatibility_date": "2026-02-25",
  "hyperdrive": [
    {
      "binding": "HYPERDRIVE",
      "id": "<your-hyperdrive-id-here>"
    }
  ]
}

Create a new Client instance and pass the Hyperdrive connectionString:

TypeScript
// 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. Hyperdrive maintains the
    // underlying database connection pool, so creating a new client is fast.
    const client = new Client({
      connectionString: env.HYPERDRIVE.connectionString,
    });


    try {
      // Connect to the database
      await client.connect();


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


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


      return new Response("Internal error occurred", { status: 500 });
    }
  },
};

Next steps