MaterializedPostgreSQL - ClickHouse Documentation

ClickHouse Cloud ユーザーには、PostgreSQL から ClickHouse へのレプリケーションに ClickPipes を使用することを推奨します。これは、PostgreSQL 向けの高性能な CDC (変更データキャプチャ) をネイティブでサポートしています。

PostgreSQL データベースのテーブルを取り込んだ ClickHouse データベースを作成します。まず、MaterializedPostgreSQL エンジンのデータベースが PostgreSQL データベースのスナップショットを作成し、必要なテーブルを読み込みます。必要なテーブルには、指定したデータベース内の任意のスキーマにある任意のテーブルの部分集合を含めることができます。スナップショットの作成とあわせて、データベースエンジンは LSN を取得し、テーブルの初期ダンプが完了すると WAL から更新の取り込みを開始します。データベースの作成後に PostgreSQL データベースへ新たに追加されたテーブルは、自動的にはレプリケーションに追加されません。これらは ATTACH TABLE db.table クエリで手動で追加する必要があります。レプリケーションは PostgreSQL Logical Replication Protocol を用いて実装されています。このプロトコルでは DDL はレプリケートできませんが、レプリケーションを破壊する変更 (カラム型の変更、カラムの追加・削除) が発生したかどうかは把握できます。こうした変更が検出されると、該当するテーブルは更新を受信しなくなります。この場合は、ATTACH / DETACH PERMANENTLY クエリを使用してテーブル全体を再読み込みする必要があります。DDL がレプリケーションを破壊しない場合 (たとえばカラム名の変更など) は、テーブルは引き続き更新を受信します (挿入は位置ベースで行われます) 。

このデータベースエンジンは Experimental です。使用するには、設定ファイルで allow_experimental_database_materialized_postgresql を 1 に設定するか、SET コマンドを使用します。

SET allow_experimental_database_materialized_postgresql=1

データベースの作成

CREATE DATABASE [IF NOT EXISTS] db_name [ON CLUSTER cluster]
ENGINE = MaterializedPostgreSQL('host:port', 'database', 'user', 'password') [SETTINGS ...]

エンジンパラメータ

host:port — PostgreSQL サーバーのエンドポイント。
database — PostgreSQL データベースの名前。
user — PostgreSQL ユーザー。
password — ユーザーのパスワード。

使用例

CREATE DATABASE postgres_db
ENGINE = MaterializedPostgreSQL('postgres1:5432', 'postgres_database', 'postgres_user', 'postgres_password');

SHOW TABLES FROM postgres_db;

┌─name───┐
│ table1 │
└────────┘

SELECT * FROM postgres_db.postgres_table;

レプリケーションに新しいテーブルを動的に追加する

MaterializedPostgreSQL データベースを作成しても、対応する PostgreSQL データベース内の新しいテーブルは自動では検出されません。こうしたテーブルは手動で追加できます。

ATTACH TABLE postgres_database.new_table;

バージョン 22.1 より前では、テーブルをレプリケーションに追加すると、削除されない一時的なレプリケーションスロット ({db_name}_ch_replication_slot_tmp という名前) が残っていました。22.1 より前の ClickHouse バージョンでテーブルを Attach する場合は、必ずこれを手動で削除してください (SELECT pg_drop_replication_slot('{db_name}_ch_replication_slot_tmp')) 。削除しないと、ディスク使用量が増加します。この問題は 22.1 で修正されています。

テーブルをレプリケーション対象から動的に外す

特定のテーブルをレプリケーション対象から外すことができます。

DETACH TABLE postgres_database.table_to_remove PERMANENTLY;

PostgreSQL スキーマ

PostgreSQL のスキーマは、3 つの方法で設定できます (バージョン 21.12 以降) 。

MaterializedPostgreSQL データベースエンジン 1 つにつき 1 つのスキーマ。設定 materialized_postgresql_schema を使用する必要があります。テーブルには、テーブル名だけでアクセスします:

CREATE DATABASE postgres_database
ENGINE = MaterializedPostgreSQL('postgres1:5432', 'postgres_database', 'postgres_user', 'postgres_password')
SETTINGS materialized_postgresql_schema = 'postgres_schema';

SELECT * FROM postgres_database.table1;

1 つの MaterializedPostgreSQL データベースエンジンに対して、指定したテーブルのセットを含むスキーマを任意の数だけ指定できます。設定 materialized_postgresql_tables_list を使用する必要があります。各テーブルは、対応するスキーマとあわせて記述します。テーブルには、スキーマ名とテーブル名を併せて使用してアクセスします:

CREATE DATABASE database1
ENGINE = MaterializedPostgreSQL('postgres1:5432', 'postgres_database', 'postgres_user', 'postgres_password')
SETTINGS materialized_postgresql_tables_list = 'schema1.table1,schema2.table2,schema1.table3',
         materialized_postgresql_tables_list_with_schema = 1;

SELECT * FROM database1.`schema1.table1`;
SELECT * FROM database1.`schema2.table2`;

ただし、この場合、materialized_postgresql_tables_list 内のすべてのテーブルは、スキーマ名を付けて記述する必要があります。 materialized_postgresql_tables_list_with_schema = 1 が必要です。警告: この場合、テーブル名にドットは使用できません。

1 つの MaterializedPostgreSQL データベースエンジンに対して、完全なテーブルセットを含む任意の数のスキーマ。設定 materialized_postgresql_schema_list を使用する必要があります。

CREATE DATABASE database1
ENGINE = MaterializedPostgreSQL('postgres1:5432', 'postgres_database', 'postgres_user', 'postgres_password')
SETTINGS materialized_postgresql_schema_list = 'schema1,schema2,schema3';

SELECT * FROM database1.`schema1.table1`;
SELECT * FROM database1.`schema1.table2`;
SELECT * FROM database1.`schema2.table2`;

警告: この場合、テーブル名にドットは使用できません。

要件

PostgreSQL の設定ファイルで、wal_level の値を logical に設定し、max_replication_slots パラメータの値を少なくとも 2 にする必要があります。
各レプリケートテーブルには、以下のいずれかの replica identity が必要です。

主キー (デフォルト)
索引

postgres# CREATE TABLE postgres_table (a Integer NOT NULL, b Integer, c Integer NOT NULL, d Integer, e Integer NOT NULL);
postgres# CREATE unique INDEX postgres_table_index on postgres_table(a, c, e);
postgres# ALTER TABLE postgres_table REPLICA IDENTITY USING INDEX postgres_table_index;

主キーが常に最初に確認されます。主キーが存在しない場合は、replica identity 索引として定義された索引が確認されます。索引を replica identity として使用する場合、そのような索引は1つのテーブルに1つだけでなければなりません。特定のテーブルでどの種類が使用されているかは、次のコマンドで確認できます。

postgres# SELECT CASE relreplident
          WHEN 'd' THEN 'default'
          WHEN 'n' THEN 'nothing'
          WHEN 'f' THEN 'full'
          WHEN 'i' THEN 'index'
       END AS replica_identity
FROM pg_class
WHERE oid = 'postgres_table'::regclass;

TOAST の値のレプリケーションはサポートされていません。代わりに、データ型のデフォルト値が使用されます。

設定

`materialized_postgresql_tables_list`

MaterializedPostgreSQLデータベースエンジンでレプリケートする、PostgreSQLデータベースのテーブルをカンマ区切りで指定します。各テーブルでは、レプリケートするカラムの一部を角括弧で指定できます。カラムの指定を省略した場合は、そのテーブルのすべてのカラムがレプリケートされます。

    materialized_postgresql_tables_list = 'table1(co1, col2),table2,table3(co3, col5, col7)

デフォルト値: 空のリスト — PostgreSQL データベース全体がレプリケートされます。

`materialized_postgresql_schema`

デフォルト値: 空文字列。 (デフォルトのスキーマが使用されます)

`materialized_postgresql_schema_list`

デフォルト値: 空のリスト。 (デフォルトのスキーマが使用されます)

`materialized_postgresql_max_block_size`

データを PostgreSQL データベースのテーブルに書き出す前に、メモリに蓄積する行数を設定します。設定可能な値:

正の整数。

デフォルト値: 65536.

`materialized_postgresql_replication_slot`

ユーザーが作成したレプリケーションスロットです。materialized_postgresql_snapshot と一緒に使用する必要があります。

`materialized_postgresql_snapshot`

PostgreSQLテーブルの初期ダンプの取得元となるスナップショットを識別するテキスト文字列です。materialized_postgresql_replication_slotとあわせて使用する必要があります。

    CREATE DATABASE database1
    ENGINE = MaterializedPostgreSQL('postgres1:5432', 'postgres_database', 'postgres_user', 'postgres_password')
    SETTINGS materialized_postgresql_tables_list = 'table1,table2,table3';

    SELECT * FROM database1.table1;

必要に応じて、設定はDDLクエリで変更できます。ただし、materialized_postgresql_tables_list 設定は変更できません。この設定内のテーブル一覧を更新するには、ATTACH TABLE クエリを使用します。

    ALTER DATABASE postgres_database MODIFY SETTING materialized_postgresql_max_block_size = <new_size>;

`materialized_postgresql_use_unique_replication_consumer_identifier`

レプリケーションには一意の consumer 識別子を使用します。デフォルトは 0 です。 1 に設定すると、同じ PostgreSQL テーブルを参照する複数の MaterializedPostgreSQL テーブルを設定できます。

注記

論理レプリケーションスロットのフェイルオーバー

プライマリに存在する論理レプリケーションスロットは、スタンバイレプリカでは利用できません。そのため、フェイルオーバーが発生すると、新しいプライマリ (以前の物理スタンバイ) は、以前のプライマリに存在していたスロットを認識できません。これにより、PostgreSQL からのレプリケーションが中断されます。この問題を回避するには、レプリケーションスロットを自分で管理し、永続的なレプリケーションスロットを定義します (詳細はこちらを参照してください) 。スロット名は materialized_postgresql_replication_slot 設定で渡す必要があり、そのスロットは EXPORT SNAPSHOT オプション付きで export されている必要があります。スナップショット識別子は materialized_postgresql_snapshot 設定で渡す必要があります。これは、実際に必要な場合にのみ使用してください。明確な必要性がない場合や、理由を十分に理解していない場合は、テーブルエンジンにレプリケーションスロットの作成と管理を任せるほうが適切です。 例 (@bchrobot 提供)

PostgreSQL でレプリケーションスロットを設定します。

apiVersion: "acid.zalan.do/v1"
kind: postgresql
metadata:
  name: acid-demo-cluster
spec:
  numberOfInstances: 2
  postgresql:
    parameters:
      wal_level: logical
  patroni:
    slots:
      clickhouse_sync:
        type: logical
        database: demodb
        plugin: pgoutput

レプリケーションスロットの準備ができるまで待ってから、transaction を開始し、transaction スナップショット識別子を export します。
BEGIN; SELECT pg_export_snapshot();

ClickHouse でデータベースを作成します。

CREATE DATABASE demodb
ENGINE = MaterializedPostgreSQL('postgres1:5432', 'postgres_database', 'postgres_user', 'postgres_password')
SETTINGS
  materialized_postgresql_replication_slot = 'clickhouse_sync',
  materialized_postgresql_snapshot = '0000000A-0000023F-3',
  materialized_postgresql_tables_list = 'table1,table2,table3';

ClickHouse DB へのレプリケーションを確認したら、PostgreSQL の transaction を終了します。フェイルオーバー後もレプリケーションが継続することを確認してください。
kubectl exec acid-demo-cluster-0 -c postgres -- su postgres -c 'patronictl failover --candidate acid-demo-cluster-1 --force'

必要な権限

CREATE PUBLICATION — 作成権限。
CREATE_REPLICATION_SLOT — レプリケーション権限。
pg_drop_replication_slot — レプリケーション権限、またはスーパーユーザー権限。
DROP PUBLICATION — publication の所有者 (MaterializedPostgreSQL エンジン自体の username) 。

2 と 3 のコマンドを実行せず、これらの権限を持たずに済ませることも可能です。設定 materialized_postgresql_replication_slot と materialized_postgresql_snapshot を使用してください。ただし、十分に注意してください。テーブルへのアクセス:

pg_publication
pg_replication_slots
pg_publication_tables

​データベースの作成

​使用例

​レプリケーションに新しいテーブルを動的に追加する

​テーブルをレプリケーション対象から動的に外す

​PostgreSQL スキーマ

​要件

​設定

​materialized_postgresql_tables_list

​materialized_postgresql_schema

​materialized_postgresql_schema_list

​materialized_postgresql_max_block_size

​materialized_postgresql_replication_slot

​materialized_postgresql_snapshot

​materialized_postgresql_use_unique_replication_consumer_identifier

​注記

​論理レプリケーションスロットのフェイルオーバー

​必要な権限

データベースの作成

使用例

レプリケーションに新しいテーブルを動的に追加する

テーブルをレプリケーション対象から動的に外す

PostgreSQL スキーマ

要件

設定

`materialized_postgresql_tables_list`

`materialized_postgresql_schema`

`materialized_postgresql_schema_list`

`materialized_postgresql_max_block_size`

`materialized_postgresql_replication_slot`

`materialized_postgresql_snapshot`

`materialized_postgresql_use_unique_replication_consumer_identifier`

注記

論理レプリケーションスロットのフェイルオーバー

必要な権限