Cloudflare Hyperdrive PlanetScale

Tip

This page is best viewed through the site search or through the AI.

Connect a Cloudflare Worker to a PlanetScale Postgres database through Cloudflare Hyperdrive.

sst.config.ts

const db = planetscale.getDatabaseVitessOutput({
  id: "mydb",
  organization: "myorg",
});

const branch =
  $app.stage === "production"
    ? planetscale.getPostgresBranchOutput({
        id: db.defaultBranch,
        database: db.name,
        organization: db.organization,
      })
    : new planetscale.PostgresBranch("DatabaseBranch", {
        database: db.name,
        name: $app.stage,
        organization: db.organization,
        parentBranch: db.defaultBranch,
      });

const role = new planetscale.PostgresBranchRole("DatabaseRole", {
  branch: branch.name,
  database: db.name,
  inheritedRoles: ["pg_read_all_data", "pg_write_all_data"],
  name: `${$app.name}-${$app.stage}`,
  organization: db.organization,
  successor: "postgres",
});

const hyperdrive = new sst.cloudflare.Hyperdrive("Database", {
  origin: {
    host: role.accessHostUrl,
    database: role.databaseName,
    user: role.username,
    password: role.password,
    port: 6432, // Use 5432 for direct connection instead of PgBouncer
    scheme: "postgres",
  },
  caching: false,
});

const worker = new sst.cloudflare.Worker("Worker", {
  handler: "./worker.ts",
  link: [hyperdrive],
  url: true,
});

worker.ts

import { Client } from "pg";
import { Resource } from "sst";

export default {
  async fetch() {
    const client = new Client({
      connectionString: Resource.Database.connectionString,
    });

    await client.connect();

    const result = await client.query(`SELECT NOW()`);

    return Response.json({
      success: true,
      result: result.rows,
    });
  },
};

View the full example.