Neon

To connect to Neon using Hyperdrive, follow these steps:

1. Allow Hyperdrive access

You can connect Hyperdrive to any existing Neon database by creating a new user and fetching your database connection string.

Neon Dashboard

1. Go to the Neon dashboard and select the project (database) you wish to connect to.
2. Select Roles from the sidebar and select New Role. Enter hyperdrive-user as the name (or your preferred name) and copy the password. Note that the password will not be displayed again: you will have to reset it if you do not save it somewhere.
3. Select Dashboard from the sidebar > go to the Connection Details pane > ensure you have selected the branch, database and role (for example,hyperdrive-user) that Hyperdrive will connect through.
4. Select the psql and uncheck the connection pooling checkbox. Note down the connection string (starting with postgres://hyperdrive-user@...) from the text box.

With both the connection string and the password, you can now create a Hyperdrive database configuration.

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.

To connect to Neon using @neondatabase/serverless, follow these steps:

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

2. Create an elements table using the Neon SQL editor. The SQL Editor allows you to query your databases directly from the Neon Console.

   CREATE TABLE elements (
     id INTEGER NOT NULL,
     elementName TEXT NOT NULL,
     atomicNumber INTEGER NOT NULL,
     symbol TEXT NOT NULL
   );

3. Insert some data into your newly created table.

   INSERT INTO elements (id, elementName, atomicNumber, symbol)
   VALUES
     (1, 'Hydrogen', 1, 'H'),
     (2, 'Helium', 2, 'He'),
     (3, 'Lithium', 3, 'Li'),
     (4, 'Beryllium', 4, 'Be'),
     (5, 'Boron', 5, 'B'),
     (6, 'Carbon', 6, 'C'),
     (7, 'Nitrogen', 7, 'N'),
     (8, 'Oxygen', 8, 'O'),
     (9, 'Fluorine', 9, 'F'),
     (10, 'Neon', 10, 'Ne');

4. Configure the Neon database credentials in your Worker:

   You need to add your Neon database connection string as a secret to your Worker. Get your connection string from the Neon Console under Connection Details, then add it as a secret using Wrangler:

   # Add the database connection string as a secret
   npx wrangler secret put DATABASE_URL
   # When prompted, paste your Neon database connection string

5. In your Worker, install the @neondatabase/serverless driver to connect to your database and start manipulating data:

   npmyarnpnpmbun

   npm i @neondatabase/serverless

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

   import { Client } from "@neondatabase/serverless";
   
   export default {
   	async fetch(request, env, ctx) {
   		const client = new Client(env.DATABASE_URL);
   		await client.connect();
   		const { rows } = await client.query("SELECT * FROM elements");
   
   		return new Response(JSON.stringify(rows));
   	},
   };

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