PlanetScale for Postgres ソース設定ガイド

ClickPipes のソースとして PlanetScale for Postgres を設定する

PlanetScale for Postgres は現在、早期アクセス版です。

​

サポート対象のPostgresバージョン

ClickPipes は Postgres バージョン 12 以降をサポートしています。

​

論理レプリケーションを有効にする

1. Postgresインスタンスでレプリケーションを有効にするには、まず次の設定になっていることを確認する必要があります。

   wal_level = logical
   

   確認するには、次のSQLコマンドを実行します。

   SHOW wal_level;
   

   デフォルトでは、出力は logical になっているはずです。そうでない場合は、PlanetScale Console にログインし、Cluster configuration->Parameters に移動して Write-ahead log までスクロールし、設定を変更してください。

PlanetScale Console でこの設定を変更すると、必ず再起動が発生します。

2. また、設定 max_slot_wal_keep_size はデフォルトの4GBから増やすことを推奨します。これも PlanetScale Console で Cluster configuration->Parameters に移動し、Write-ahead log までスクロールして設定します。新しい値の決め方については、こちらを参照してください。

​

権限と publication を持つユーザーの作成

デフォルトの postgres.<...> ユーザーを使用して PlanetScale Postgres インスタンスに接続し、以下のコマンドを実行します。

1. ClickPipes 専用のユーザーを作成します。

   CREATE USER clickpipes_user PASSWORD 'some-password';
   

2. 前の手順で作成したユーザーに、スキーマレベルの読み取り専用アクセス権を付与します。以下の例は、public スキーマに対する権限を示しています。レプリケートしたいテーブルを含む各スキーマに対して、これらのコマンドを繰り返してください。

   GRANT USAGE ON SCHEMA "public" TO clickpipes_user;
   GRANT SELECT ON ALL TABLES IN SCHEMA "public" TO clickpipes_user;
   ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT SELECT ON TABLES TO clickpipes_user;
   

3. ユーザーにレプリケーション権限を付与します。

   ALTER USER clickpipes_user WITH REPLICATION;
   

4. レプリケートしたいテーブルを含む publication を作成します。パフォーマンス上のオーバーヘッドを避けるため、publication には必要なテーブルだけを含めることを強く推奨します。

publication に含めるテーブルには、主キー が定義されているか、または replica identity が FULL に設定されている必要があります。スコープ設定のガイドについては、Postgres よくある質問 を参照してください。

• 特定のテーブルに対する publication を作成するには:

  CREATE PUBLICATION clickpipes FOR TABLE table_to_replicate, table_to_replicate2;
  

  • 特定のスキーマ内のすべてのテーブルに対する publication を作成するには:

    CREATE PUBLICATION clickpipes FOR TABLES IN SCHEMA "public";
    

clickpipes publication には、指定したテーブルから生成される変更イベントのセットが含まれ、後でレプリケーションストリームの取り込みに使用されます。

​

注意事項

1. PlanetScale Postgres に接続するには、現在のブランチを先ほど作成したユーザー名の末尾に追加する必要があります。たとえば、作成したユーザー名が clickpipes_user の場合、ClickPipe の作成時に指定する実際のユーザー名は clickpipes_user.branch である必要があります。ここで branch は、現在の PlanetScale Postgres ブランチの “id” を指します。これをすばやく確認するには、先ほどユーザー作成時に使用した postgres ユーザーのユーザー名を参照してください。ピリオド以降の部分がブランチ ID です。
2. PlanetScale Postgres に接続する CDC パイプでは、PSBouncer ポート (現在は 6432) を使用しないでください。通常のポート 5432 を使用する必要があります。初回ロードのみのパイプでは、どちらのポートも使用できます。
3. 接続先は必ずプライマリ インスタンスのみにしてください。現在、レプリカ インスタンスへの接続はサポートされていません。

​

次は？

これで、ClickPipe を作成 して、Postgres インスタンスから ClickHouse Cloud へのデータ取り込みを開始できます。 ClickPipe の作成時に必要になるため、Postgres インスタンスのセットアップ時に使用した接続情報は必ず控えておいてください。