本示例展示如何将 Hyperdrive 连接到 Amazon Relational Database Service (Amazon RDS) 或 Amazon Aurora MySQL 数据库实例。
要允许 Hyperdrive 连接数据库,需确保 Hyperdrive 拥有有效用户凭据和网络访问权限。
在 AWS 控制台中创建或修改实例时:
- 配置 database cluster 及其他要自定义的设置。
- 在 Settings(设置) > Credential settings(凭据设置) 下,记下 Master username(主用户名) 和 Master password(仅 Aurora)。
- 在 Connectivity 标题下,确保 Public access 设为 Yes。
- 选择允许从
0.0.0.0/0公网访问数据库实例监听端口的 Existing VPC security group(MySQL 实例默认:3306)。 - 选择 Create database(创建数据库)。
获取 Hyperdrive 连接的数据库端点(主机名):
- 在 AWS 控制台 RDS 下前往 Databases 视图。
- 选择希望 Hyperdrive 连接的数据库。
- 在 Endpoints 标题下,记下类型为
Writer的 Endpoint name 和 Port。
对于常规 RDS 实例(非 Aurora),需获取数据库端点和端口:
- 在 AWS 控制台 RDS 下前往 Databases 视图。
- 选择希望 Hyperdrive 连接的数据库。
- 在 Connectivity & security 标题下,记下 Endpoint 和 Port。
端点类似 YOUR_DATABASE_NAME.cpuo5rlli58m.AWS_REGION.rds.amazonaws.com,端口默认为 3306。
数据库创建后,需创建 Hyperdrive 连接用户。虽可使用初始创建时配置的 Master username(主用户名),最佳实践是创建权限较低的用户。
要创建新用户,登录数据库并使用 CREATE USER 命令:
# Log in to the database
mysql -h ENDPOINT_NAME -P PORT -u MASTER_USERNAME -p database_name运行以下 SQL 语句:
-- Create a role for Hyperdrive
CREATE ROLE hyperdrive;
-- Allow Hyperdrive to connect
GRANT USAGE ON mysql_db.* TO hyperdrive;
-- Grant database privileges to the hyperdrive role
GRANT ALL PRIVILEGES ON mysql_db.* to hyperdrive;
-- Create a specific user for Hyperdrive to log in as
CREATE USER 'hyperdrive_user'@'%' IDENTIFIED WITH caching_sha2_password BY 'sufficientlyRandomPassword';
-- Grant this new user the hyperdrive role privileges
GRANT hyperdrive to 'hyperdrive_user'@'%';请参阅 AWS MySQL 用户角色文档 ↗ 了解更多详情。
有了数据库用户、密码、数据库端点(主机名和端口)和数据库名称后,即可设置 Hyperdrive。
配置 Hyperdrive 需要:
- 数据库的 IP 地址(或主机名)和端口。
- 上一步配置的数据库用户名(例如
hyperdrive-demo)。 - 该用户名对应的密码。
- 希望 Hyperdrive 连接的数据库名称,例如
mysql。
Hyperdrive 接受数据库驱动常用的连接字符串格式组合上述参数:
mysql://USERNAME:PASSWORD@HOSTNAME_OR_IP_ADDRESS:PORT/database_name大多数数据库提供商会提供可直接复制到 Hyperdrive 的连接字符串。
使用 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="mysql://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>"安装 mysql2 ↗ 驱动:
npm i mysql2@>3.13.0yarn add mysql2@>3.13.0pnpm add mysql2@>3.13.0bun add mysql2@>3.13.0在 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>"创建新的 connection 实例并传入 Hyperdrive 参数:
// mysql2 v3.13.0 or later is required
import { createConnection } from "mysql2/promise";
export default {
async fetch(request, env, ctx): Promise<Response> {
// Create a new connection on each request. Hyperdrive maintains the underlying
// database connection pool, so creating a new connection is fast.
const connection = await createConnection({
host: env.HYPERDRIVE.host,
user: env.HYPERDRIVE.user,
password: env.HYPERDRIVE.password,
database: env.HYPERDRIVE.database,
port: env.HYPERDRIVE.port,
// Required to enable mysql2 compatibility for Workers
disableEval: true,
});
try {
// Sample query
const [results, fields] = await connection.query("SHOW tables;");
// Return result rows as JSON
return Response.json({ results, fields });
} catch (e) {
console.error(e);
return Response.json(
{ error: e instanceof Error ? e.message : e },
{ status: 500 },
);
}
},
} satisfies ExportedHandler<Env>;- 了解更多 Hyperdrive 工作原理。
- 参阅故障排除指南以排查常见问题。
- 进一步了解 Cloudflare Workers 可用的其他存储选项。