Skip to content
Cloudflare Docs

Azure Database

Connect Hyperdrive to an Azure Database for PostgreSQL instance.

This example shows you how to connect Hyperdrive to an Azure Database for PostgreSQL instance.

1. Allow Hyperdrive access

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

Azure Portal

Public access networking

To connect to your Azure Database for PostgreSQL instance using public Internet connectivity:

  1. In the Azure Portal ↗, select the instance you want Hyperdrive to connect to.
  2. Expand Settings > Networking > ensure Public access is enabled > in Firewall rules add 0.0.0.0 as Start IP address and 255.255.255.255 as End IP address.
  3. Select Save to persist your changes.
  4. Select Overview from the sidebar and note down the Server name of your instance.

With the username, password, server name, and database name (default: postgres), you can now create a Hyperdrive database configuration.

Private access networking

To connect to a private Azure Database for PostgreSQL instance, refer to Connect to a private database using Tunnel.

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:

{
  "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:

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.
    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");


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


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

Next steps