跳转到内容
搜索文档
↵选择
↑↓导航
ESC关闭

Neon

将 Hyperdrive 连接到 Neon Postgres 数据库。

最后更新 查看 MarkdownAgent 设置

本示例展示如何将 Hyperdrive 连接到 Neon ↗ Postgres 数据库。

1. 允许 Hyperdrive 访问

通过创建新用户并获取数据库连接字符串，可将 Hyperdrive 连接到任何现有 Neon 数据库。

Neon 仪表板

  1. 前往 Neon 仪表板 ↗ 并选择要连接的项目（数据库）。
  2. 在侧边栏选择 Roles（角色），再选择 New Role（新角色）。输入 hyperdrive-user 作为名称（或你偏好的名称）并复制密码。密码不会再次显示：若未保存需重置。
  3. 在侧边栏选择 Dashboard（仪表板） > 进入 Connection Details（连接详情） 面板 > 确保已选择 Hyperdrive 将连接的 branch（分支）、database（数据库） 和 role（例如 hyperdrive-user）。
  4. 选择 psql 并取消勾选 connection pooling 复选框。从文本框记下连接字符串（以 postgres://hyperdrive-user@... 开头）。

有了连接字符串和密码后，即可创建 Hyperdrive 数据库配置。

2. 创建数据库配置

配置 Hyperdrive 需要：

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

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

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

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

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

  1. 在 Cloudflare 仪表板中，前往 Hyperdrive 页面。

    Go to Hyperdrive ↗

  2. 选择 Create Configuration（创建配置）。

  3. 填写表单，包括连接字符串。

  4. 选择 Create（创建）。

使用 Wrangler CLI 创建 Hyperdrive 配置：

  1. 打开终端并运行以下命令。将 <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"

  2. 该命令会输出 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

若使用 TypeScript，安装类型包：

npm i -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 });
		}
	},
};

后续步骤

这篇文档对您有帮助吗？