Google Cloud SQLに接続

この例では、HyperdriveをGoogle Cloud SQL PostgreSQLデータベースインスタンスに接続する方法を示します。

1. Hyperdriveのアクセスを許可する

Hyperdriveがデータベースに接続できるようにするには、Hyperdriveに有効なユーザー資格情報とネットワークアクセスがあることを確認する必要があります。

ノート

Hyperdrive currently requires public Internet access to your database instances. In the future, Hyperdrive will support private connectivity over Magic WAN and Cloudflare Tunnel.

Cloud Console

インスタンスを作成する際、またはGoogle Cloud Console ↗で既存のインスタンスを編集する際：

Hyperdriveがインスタンスに到達できるようにするには：

1. Cloud Console ↗で、Hyperdriveが接続するインスタンスを選択します。
2. Connectionsを展開し、Public IPが有効になっていることを確認し、Add a Networkを選択して0.0.0.0/0を入力します。
3. Doneを選択し、Saveを選択して変更を保存します。
4. サイドバーからOverviewを選択し、インスタンスのPublic IP addressをメモします。

Hyperdriveが接続するためのユーザーを作成するには：

1. サイドバーでUsersを選択します。
2. Add User Accountを選択し、Built-in authenticationを選択します。
3. 名前を入力します（例：hyperdrive-user）> Generateを選択してパスワードを生成します。
4. ユーザーを作成する前に、このパスワードをクリップボードにコピーします。

ユーザー名、パスワード、パブリックIPアドレス、および（オプションの）データベース名（デフォルト：postgres）を使用して、Hyperdriveデータベース構成を作成できます。

gcloud CLI

gcloud CLI ↗を使用すると、新しいユーザーを作成し、Hyperdriveがデータベースに接続できるようにします。

gcloud sqlを使用して、強力なパスワードを持つ新しいユーザー（例：hyperdrive-user）を作成します：

gcloud sql users create hyperdrive-user --instance=YOUR_INSTANCE_NAME --password=SUFFICIENTLY_LONG_PASSWORD

次のコマンドを実行して、データベースインスタンスへのインターネットアクセス ↗を有効にします：

# 既存の承認されたネットワークがある場合は、それらをカンマ区切りのリストとして提供してください。
# gcloud CLIは、ここで提供したリストで既存の承認されたネットワークを置き換えます。
gcloud sql instances patch YOUR_INSTANCE_NAME --authorized-networks="0.0.0.0/0"

追加の構成オプションについては、Google Cloudのドキュメント ↗を参照してください。

2. データベース構成を作成する

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"

ノート

Hyperdrive will attempt to connect to your database with the provided credentials to verify they are correct before creating a configuration. If you encounter an error when attempting to connect, refer to Hyperdrive’s troubleshooting documentation to debug possible causes.

This command outputs a binding for wrangler.toml:

name = "hyperdrive-example"
main = "src/index.ts"
compatibility_date = "2024-08-21"
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>"

Install the driver:

npm install postgres

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

import postgres from 'postgres'

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 sql = postgres(env.HYPERDRIVE.connectionString)

    try {
      // Test query
      const result = await sql`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.