コンテンツにスキップ

CockroachDBに接続する

HyperdriveをCockroachDBデータベースに接続します。

この例では、HyperdriveをCockroachDB ↗データベースクラスターに接続する方法を示します。CockroachDBは、強い整合性保証を持つPostgreSQL互換の分散SQLデータベースです。

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

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

CockroachDBコンソール

以下の手順は、既存のCockroachDB Cloudアカウント ↗とデータベースクラスターが作成されていることを前提としています。

データベースの資格情報を作成および取得するには：

  1. CockroachDB Cloudコンソール ↗に移動し、Hyperdriveが接続するクラスターを選択します。
  2. 左側のサイドバーからSQL Usersを選択し、Add Userを選択します。
  3. ユーザー名（例えば、`hyperdrive-user）を入力し、Generate & Save Passwordを選択します。
  4. ユーザー名をメモし、パスワードを一時的な場所にコピーします。

データベース接続の詳細を取得するには：

  1. CockroachDB Cloudコンソール ↗に移動し、Hyperdriveが接続するクラスターを選択します。
  2. 右上のConnectを選択します。
  3. 作成したユーザー（例えば、hyperdrive-user）を選択します。
  4. データベース（例えば、defaultdb）を選択します。
  5. オプションとしてGeneral connection stringを選択します。
  6. 下のテキストボックスで、Copyを選択して接続文字列をコピーします。

デフォルトでは、CockroachDBクラウドはパブリックインターネット（0.0.0.0/0）からの接続を有効にしています。既存のクラスターでこれらの設定を変更した場合、Hyperdriveが接続できるようにパブリックインターネットからの接続を許可する必要があります。

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:

Terminal window
npx wrangler hyperdrive create <NAME_OF_HYPERDRIVE_CONFIG> --connection-string="postgres://user:password@HOSTNAME_OR_IP_ADDRESS:PORT/database_name"

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:

Terminal window
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

Cloudflare DashboardDiscordCommunityLearning CenterSupport Portal
Cookie Settings