Connect to AWS RDS and Aurora

This example shows you how to connect Hyperdrive to an Amazon Relational Database Service (Amazon RDS) Postgres or Amazon Aurora database instance.

​​ 1. Allow Hyperdrive access

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

​​ AWS Console

When creating or modifying an instance in the AWS console:

1. Configure a DB cluster identifier and other settings you wish to customize.
2. Under Settings > Credential settings, note down the Master username and Master password.
3. Under the Connectivity header, ensure Public access is set to Yes.
4. Select an Existing VPC security group that allows public Internet access from 0.0.0.0/0 to the port your database instance is configured to listen on (default: 5432 for PostgreSQL instances).
5. Select Create database.

​​ Retrieve the database endpoint (Aurora)

To retrieve the database endpoint (hostname) for Hyperdrive to connect to:

1. Go to Databases view under RDS in the AWS console.
2. Select the database you want Hyperdrive to connect to.
3. Under the Endpoints header, note down the Endpoint name with the type Writer and the Port.

​​ Retrieve the database endpoint (RDS PostgreSQL)

For regular RDS instances (non-Aurora), you will need to fetch the endpoint and port of the database:

1. Go to Databases view under RDS in the AWS console.
2. Select the database you want Hyperdrive to connect to.
3. Under the Connectivity & security header, note down the Endpoint and the Port.

The endpoint will resemble YOUR_DATABASE_NAME.cpuo5rlli58m.AWS_REGION.rds.amazonaws.com and the port will default to 5432.

​​ 2. Create your user

Once your database is created, you will need to create a user for Hyperdrive to connect as. Although you can use the Master username configured during initial database creation, best practice is to create a less privileged user.

To create a new user, log in to the database and use the CREATE ROLE command:

# Log in to the database
$ psql postgresql://MASTER_USERNAME:MASTER_PASSWORD@ENDPOINT_NAME:PORT/database_name

Run the following SQL statements:

-- Create a role for Hyperdrive
CREATE ROLE hyperdrive;

-- Allow Hyperdrive to connect
GRANT CONNECT ON DATABASE postgres TO hyperdrive;

-- Grant database privileges to the hyperdrive role
GRANT ALL PRIVILEGES ON DATABASE postgres to hyperdrive;

-- Create a specific user for Hyperdrive to log in as
CREATE ROLE hyperdrive_user LOGIN PASSWORD 'sufficientlyRandomPassword';

-- Grant this new user the hyperdrive role privileges
GRANT hyperdrive to hyperdrive_user;

Refer to AWS’ documentation on user roles in PostgreSQL Open external link for more details.

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

​​ 3. 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 Wrangler CLI, open your terminal and run the following command. Replace <NAME_OF_HYPERDRIVE_CONFIG> with a name for your Hyperdrive configuration and paste the connection string provided from your database host, or replace user, password, HOSTNAME_OR_IP_ADDRESS, port, and database_name placeholders with those specific to your database:

$ npx wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string="postgres://user:password@HOSTNAME_OR_IP_ADDRESS:PORT/database_name"

This command outputs a binding for wrangler.toml:

wrangler.toml
name = "hyperdrive-example"
main = "src/index.ts"
compatibility_date = "2023-09-11"

node_compat = true # required for database drivers to function

# Pasted from the output of `wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string=[...]` above.
[[hyperdrive]]
binding = "HYPERDRIVE"
id = ""

Install the driver:

$ npm install pg

Copy the below Worker code, which passes the connection string generated from env.HYPERDRIVE.connectionString directly to the driver.

src/index.ts
import { Client } from 'pg';

export interface Env {
	// If you set another name in wrangler.toml as the value for 'binding',
	// replace "HYPERDRIVE" with the variable name you defined.
	HYPERDRIVE: Hyperdrive;
}

export default {
	async fetch(request, env, ctx): Promise<Response> {
		console.log(JSON.stringify(env))
		// Create a database client that connects to our database via Hyperdrive
		// Hyperdrive generates a unique connection string you can pass to
		// supported drivers, including node-postgres, Postgres.js, and the many
		// ORMs and query builders that use these drivers.
		const client = new Client({ connectionString: env.HYPERDRIVE.connectionString });

		try {
			// Connect to our database
			await client.connect();

			// Test query
			const result = await client.query({ text: 'SELECT * FROM pg_tables' });

			// Returns result rows as JSON
			return Response.json({ result: result });
		} catch (e) {
			console.log(e);
			return Response.json({ error: e.message }, { status: 500 });
		}
	},
} satisfies ExportedHandler<Env>;

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