node-postgres (pg)

node-postgres ↗ (pg) is a widely-used PostgreSQL driver for Node.js applications. This example demonstrates how to use node-postgres with Cloudflare Hyperdrive in a Workers application.

Install the node-postgres driver:

npm

npm i pg@>8.13.0

yarn

yarn add pg@>8.13.0

pnpm

pnpm add pg@>8.13.0

bun

bun add pg@>8.13.0

Note

The minimum version of node-postgres required for Hyperdrive is 8.13.0.

If using TypeScript, install the types package:

npm

npm i -D @types/pg

yarn

yarn add -D @types/pg

pnpm

pnpm add -D @types/pg

bun

bun add -d @types/pg

Add the required Node.js compatibility flags and Hyperdrive binding to your wrangler.jsonc file:

wrangler.jsonc

{
  "compatibility_flags": [
    "nodejs_compat"
  ],
  "compatibility_date": "2024-09-23",
  "hyperdrive": [
    {
      "binding": "HYPERDRIVE",
      "id": "<your-hyperdrive-id-here>"
    }
  ]
}

wrangler.toml

# required for database drivers to function
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();
    }
  },
};