CockroachDB

本示例展示如何将 Hyperdrive 连接到 CockroachDB ↗ 数据库集群。CockroachDB 是 PostgreSQL 兼容的分布式 SQL 数据库，具有强一致性保证。

1. 允许 Hyperdrive 访问

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

CockroachDB 控制台

以下步骤假设你已有 CockroachDB Cloud 账户 ↗ 并已创建数据库集群。

要创建和/或获取数据库凭据：

前往 CockroachDB Cloud 控制台 ↗，选择希望 Hyperdrive 连接的集群。
在左侧侧边栏选择 SQL Users（SQL 用户），然后选择 Add User（添加用户）。
输入用户名（例如 hyperdrive-user），然后选择 Generate & Save Password（生成并保存密码）。
记下用户名并将密码复制到临时位置。

要获取数据库连接详情：

前往 CockroachDB Cloud 控制台 ↗，选择希望 Hyperdrive 连接的集群。
在右上角选择 Connect（连接）。
选择你创建的用户，例如 hyperdrive-user。
选择数据库，例如 defaultdb。
选择 General connection string（常规连接字符串） 选项。
在下方文本框中选择 Copy（复制） 复制连接字符串。

默认情况下，CockroachDB Cloud 允许来自公网（0.0.0.0/0）的连接。若现有集群已更改这些设置，需允许公网连接以便 Hyperdrive 连接。

2. 创建数据库配置

配置 Hyperdrive 需要：

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

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

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

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

在 Cloudflare 仪表板中创建 Hyperdrive 配置：

在 Cloudflare 仪表板中，前往 Hyperdrive 页面。
Go to Hyperdrive ↗
选择 Create Configuration（创建配置）。
填写表单，包括连接字符串。
选择 Create（创建）。

使用 Wrangler CLI 创建 Hyperdrive 配置：

打开终端并运行以下命令。将 <NAME_OF_HYPERDRIVE_CONFIG> 替换为 Hyperdrive 配置名称，并粘贴数据库主机提供的连接字符串，或将 user、password、HOSTNAME_OR_IP_ADDRESS、port 和 database_name 占位符替换为你的数据库信息：
```
npx wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string="postgres://user:password@HOSTNAME_OR_IP_ADDRESS:PORT/database_name"
```

该命令会输出 Wrangler 配置文件的绑定：

{
	"$schema": "./node_modules/wrangler/config-schema.json",
	"name": "hyperdrive-example",
	"main": "src/index.ts",
	// Set this to today's date
	"compatibility_date": "2026-08-17",
	"compatibility_flags": [
		"nodejs_compat"
	],
	// Pasted from the output of `wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string=[...]` above.
	"hyperdrive": [
		{
			"binding": "HYPERDRIVE",
			"id": "<ID OF THE CREATED HYPERDRIVE CONFIGURATION>"
		}
	]
}

"$schema" = "./node_modules/wrangler/config-schema.json"
name = "hyperdrive-example"
main = "src/index.ts"
# Set this to today's date
compatibility_date = "2026-08-17"
compatibility_flags = [ "nodejs_compat" ]

[[hyperdrive]]
binding = "HYPERDRIVE"
id = "<ID OF THE CREATED HYPERDRIVE CONFIGURATION>"

3. 从 Worker 使用 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 可用的其他存储选项。