Materializeに接続する

この例では、HyperdriveをMaterialize ↗データベースに接続する方法を示します。Materializeは、ストリーミングデータソースに対してリアルタイムの結果を自動的に計算できるPostgres互換のストリーミングデータベースです。

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

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

Materializeコンソール

ノート

最初のデータベースを設定するには、Materializeのクイックスタートガイド ↗をお読みください。以下の手順は、既存のMaterializeデータベースが準備されていることを前提としています。

Hyperdriveが接続するための新しいアプリケーションユーザーとパスワードを作成する必要があります：

1. Materializeコンソール ↗にログインします。
2. アプリパスワードセクションで、アプリパスワードを管理を選択します。
3. 新しいアプリパスワードを選択し、名前を入力します（例：hyperdrive-user）。
4. パスワードを作成を選択します。
5. 提供されたパスワードをコピーします：これは一度だけ表示されます。

Materializeの設定のホスト名とデータベース名を取得するには：

1. Materializeコンソールのサイドバーで接続を選択します。
2. 外部ツールを選択します。
3. ホスト、ポート、およびデータベースの設定をコピーします。

ユーザー名、アプリパスワード、ホスト名、ポート、データベース名を使用して、HyperdriveをMaterializeデータベースに接続できます。

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.