AWS RDS 与 Aurora

本示例展示如何将 Hyperdrive 连接到 Amazon Relational Database Service (Amazon RDS) Postgres 或 Amazon Aurora 数据库实例。

要允许 Hyperdrive 连接数据库，需确保 Hyperdrive 拥有有效用户凭据和网络访问权限。

在 AWS 控制台中创建或修改实例时：

1. 配置 DB cluster identifier 及其他要自定义的设置。
2. 在 Settings（设置） > Credential settings（凭据设置） 下，记下 Master username（主用户名） 和 Master password（仅 Aurora）。
3. 在 Connectivity 标题下，确保 Public access 设为 Yes。
4. 选择允许从 0.0.0.0/0 公网访问数据库实例监听端口的 Existing VPC security group（PostgreSQL 实例默认：5432）。
5. 选择 Create database（创建数据库）。

获取 Hyperdrive 连接的数据库端点（主机名）：

1. 在 AWS 控制台 RDS 下前往 Databases 视图。
2. 选择希望 Hyperdrive 连接的数据库。
3. 在 Endpoints 标题下，记下类型为 Writer 的 Endpoint name 和 Port。

对于常规 RDS 实例（非 Aurora），需获取数据库端点和端口：

1. 在 AWS 控制台 RDS 下前往 Databases 视图。
2. 选择希望 Hyperdrive 连接的数据库。
3. 在 Connectivity & security 标题下，记下 Endpoint 和 Port。

端点类似 YOUR_DATABASE_NAME.cpuo5rlli58m.AWS_REGION.rds.amazonaws.com，端口默认为 5432。

数据库创建后，需创建 Hyperdrive 连接用户。虽可使用初始创建时配置的 Master username（主用户名），最佳实践是创建权限较低的用户。

要创建新用户，登录数据库并使用 CREATE ROLE 命令：

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

运行以下 SQL 语句：

-- 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;

请参阅 AWS PostgreSQL 用户角色文档 ↗ 了解更多详情。

有了数据库用户、密码、数据库端点（主机名和端口）和数据库名称（默认：postgres）后，即可设置 Hyperdrive。

配置 Hyperdrive 需要：

• 数据库的 IP 地址（或主机名）和端口。
• 上一步配置的数据库用户名（例如 hyperdrive-demo）。
• 该用户名对应的密码。
• 希望 Hyperdrive 连接的数据库名称，例如 postgres。

Hyperdrive 接受数据库驱动常用的连接字符串格式组合上述参数：

postgres://USERNAME:PASSWORD@HOSTNAME_OR_IP_ADDRESS:PORT/database_name

大多数数据库提供商会提供可直接复制到 Hyperdrive 的连接字符串。

安装 node-postgres 驱动：

npm i pg@>8.16.3

yarn add pg@>8.16.3

pnpm add pg@>8.16.3

bun add pg@>8.16.3

若使用 TypeScript，安装类型包：

npm i -D @types/pg

yarn add -D @types/pg

pnpm add -D @types/pg

bun add -d @types/pg

在 wrangler.jsonc 中添加所需的 Node.js 兼容性标志和 Hyperdrive 绑定：

在 wrangler.jsonc 中添加 Node.js 兼容性标志和 Hyperdrive 绑定（binding）：

{
	// required for database drivers to function
	"compatibility_flags": [
		"nodejs_compat"
	],
	// Set this to today's date
	"compatibility_date": "2026-08-17",
	"hyperdrive": [
		{
			"binding": "HYPERDRIVE",
			"id": "<your-hyperdrive-id-here>"
		}
	]
}

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

[[hyperdrive]]
binding = "HYPERDRIVE"
id = "<your-hyperdrive-id-here>"

创建新的 Client 实例并传入 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 });
		}
	},
};

• 了解更多 Hyperdrive 工作原理。
• 参阅故障排除指南以排查常见问题。
• 进一步了解 Cloudflare Workers 可用的其他存储选项。