Supabase

Supabase client setup

To set up an integration with Supabase:

1. You need to have an existing Supabase database to connect to. Create a Supabase database or have an existing database to connect to Supabase and load data from.

2. Create a countries table with the following query. You can create a table in your Supabase dashboard in two ways:

   • Use the table editor, which allows you to set up Postgres similar to a spreadsheet.
   • Alternatively, use the SQL editor:
   CREATE TABLE countries (
   id SERIAL PRIMARY KEY,
   name VARCHAR(255) NOT NULL
   );

3. Insert some data in your newly created table. Run the following commands to add countries to your table:

   INSERT INTO countries (name) VALUES ('United States');
   INSERT INTO countries (name) VALUES ('Canada');
   INSERT INTO countries (name) VALUES ('The Netherlands');

4. Configure the Supabase database credentials in your Worker:

   You need to add your Supabase URL and anon key as secrets to your Worker. Get these from your Supabase Dashboard under Settings > API, then add them as secrets using Wrangler:

   # Add the Supabase URL as a secret
   npx wrangler secret put SUPABASE_URL
   # When prompted, paste your Supabase project URL
   
   # Add the Supabase anon key as a secret
   npx wrangler secret put SUPABASE_KEY
   # When prompted, paste your Supabase anon/public key

5. In your Worker, install the @supabase/supabase-js driver to connect to your database and start manipulating data:

   npmyarnpnpmbun

   npm i @supabase/supabase-js

6. The following example shows how to make a query to your Supabase database in a Worker. The credentials needed to connect to Supabase have been added as secrets to your Worker.

   import { createClient } from "@supabase/supabase-js";
   
   export default {
   	async fetch(request, env) {
   		const supabase = createClient(env.SUPABASE_URL, env.SUPABASE_KEY);
   		const { data, error } = await supabase.from("countries").select("*");
   		if (error) throw error;
   		return new Response(JSON.stringify(data), {
   			headers: {
   				"Content-Type": "application/json",
   			},
   		});
   	},
   };

To learn more about Supabase, refer to Supabase's official documentation.

When connecting to Supabase with Hyperdrive, you connect directly to the underlying Postgres database. This provides the lowest latency for database queries when accessed server-side from Workers. To connect to Supabase using Hyperdrive, follow these steps:

1. Allow Hyperdrive access

You can connect Hyperdrive to any existing Supabase database as the Postgres user which is set up during project creation. Alternatively, to create a new user for Hyperdrive, run these commands in the SQL Editor.

The database endpoint can be found in the database settings page.

With a database user, password, database endpoint (hostname and port) and database name (default: postgres), you can now set up Hyperdrive.

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.

3. Use Hyperdrive from your Worker

Install the node-postgres driver:

npm i pg@>8.16.3

yarn add pg@>8.16.3

pnpm add pg@>8.16.3

bun add pg@>8.16.3

If using TypeScript, install the types package:

npm i -D @types/pg

yarn add -D @types/pg

pnpm add -D @types/pg

bun add -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-11-02",
	"hyperdrive": [
		{
			"binding": "HYPERDRIVE",
			"id": "<your-hyperdrive-id-here>"
		}
	]
}

compatibility_flags = [ "nodejs_compat" ]
# Set this to today's date
compatibility_date = "2026-11-02"

[[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. 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

• Learn more about How Hyperdrive Works.
• Refer to the troubleshooting guide to debug common issues.
• Understand more about other storage options available to Cloudflare Workers.