pg_clickhouse

はじめに

pg_clickhouse はオープンソースの PostgreSQL 拡張機能であり、SQL を書き換えることなく、 PostgreSQL から直接 ClickHouse 上で分析クエリを実行できます。PostgreSQL 13 以降および ClickHouse v23 以降をサポートしています。

ClickPipes が ClickHouse へのデータ同期を開始したら、 pg_clickhouse を使って PostgreSQL スキーマに対して import foreign tables を素早く簡単に実行できます。あとは既存の PostgreSQL クエリをそれらのテーブルに対して実行するだけで、実行を ClickHouse 側へ委譲しつつ、既存のコードベースをそのまま維持できます。

はじめに

pg_clickhouse を試す最も簡単な方法は Docker image を使うことです。このイメージは、標準的な PostgreSQL の Docker イメージに pg_clickhouse 拡張機能を追加したものです。

docker run --name pg_clickhouse -e POSTGRES_PASSWORD=my_pass \
       -d ghcr.io/clickhouse/pg_clickhouse:18
docker exec -it pg_clickhouse psql -U postgres -c 'CREATE EXTENSION pg_clickhouse'

ClickHouse テーブルのインポートやクエリのプッシュダウンを始めるには、tutorial を参照してください。

テストケース: TPC-H

この表は、スケールファクター 1 でロードした通常の PostgreSQL テーブルと、ClickHouse に接続した pg_clickhouse 間の TPC-H クエリ性能を比較したものです。✔︎ は完全なプッシュダウンを示し、ダッシュはクエリを 1 分後にキャンセルしたことを示します。すべてのテストは、メモリ 36 GB を搭載した MacBook Pro M4 Max 上で実行しました。

Query	PostgreSQL	pg_clickhouse	プッシュダウン
[Query 1]	4693 ms	268 ms	✔︎
[Query 2]	458 ms	3446 ms
[Query 3]	742 ms	111 ms	✔︎
[Query 4]	270 ms	130 ms	✔︎
[Query 5]	337 ms	1460 ms	✔︎
[Query 6]	764 ms	53 ms	✔︎
[Query 7]	619 ms	96 ms	✔︎
[Query 8]	342 ms	156 ms	✔︎
[Query 9]	3094 ms	298 ms	✔︎
[Query 10]	581 ms	197 ms	✔︎
[Query 11]	212 ms	24 ms	✔︎
[Query 12]	1116 ms	84 ms	✔︎
[Query 13]	958 ms	1368 ms
[Query 14]	181 ms	73 ms	✔︎
[Query 15]	1118 ms	557 ms
[Query 16]	497 ms	1714 ms
[Query 17]	1846 ms	32709 ms
[Query 18]	5823 ms	10649 ms
[Query 19]	53 ms	206 ms	✔︎
[Query 20]	421 ms	-
[Query 21]	1349 ms	4434 ms
[Query 22]	258 ms	1415 ms

ソースからビルドする

一般的な Unix

PostgreSQL と curl の開発用パッケージにはパス内に pg_config と curl-config が含まれているため、そのまま make（または gmake）を実行し、続けて make install を実行し、最後にデータベース上で CREATE EXTENSION pg_clickhouse を実行すれば十分です。

Debian / Ubuntu / APT

PostgreSQL Apt リポジトリからパッケージを取得する方法の詳細については、PostgreSQL Apt を参照してください。

sudo apt install \
  postgresql-server-18 \
  libcurl4-openssl-dev \
  uuid-dev \
  libssl-dev \
  make \
  cmake \
  g++

RedHat / CentOS / Yum

sudo yum install \
  postgresql-server \
  libcurl-devel \
  libuuid-devel \
  openssl-libs \
  automake \
  cmake \
  gcc

PostgreSQL Yum リポジトリから取得する方法の詳細については、PostgreSQL Yum を参照してください。

PGXN からインストール

上記の依存関係を満たしたら、PGXN client（Homebrew、Apt、および pgxnclient という名前の Yum パッケージとして利用可能）を使用して pg_clickhouse をダウンロード、コンパイル、インストールします。

pgxn install pg_clickhouse

コンパイルとインストール

ClickHouse ライブラリと pg_clickhouse をビルドしてインストールするには、次のコマンドを実行します。

make
sudo make install

ホストに複数の PostgreSQL がインストールされている場合は、適切なバージョンの pg_config を明示的に指定する必要があります。

export PG_CONFIG=/usr/lib/postgresql/18/bin/pg_config
make
sudo make install

ホスト上で curl-config が PATH に含まれていない場合は、そのパスを明示的に指定できます：

export CURL_CONFIG=/opt/homebrew/opt/curl/bin/curl-config
make
sudo make install

次のようなエラーが発生した場合は、

"Makefile", line 8: Need an operator

GNU make を使用する必要があります。システムによっては、 gmake としてインストールされている場合があります。

gmake
gmake install
gmake installcheck

次のようなエラーが発生した場合:

make: pg_config: Command not found

pg_config がインストールされており、パスが通っていることを確認してください。RPM などのパッケージ管理システムを使って PostgreSQL をインストールした場合は、-devel パッケージもインストールされていることを確認してください。必要であれば、ビルドプロセスに対して pg_config の場所を指定してください。

export PG_CONFIG=/path/to/pg_config
make
sudo make install

PostgreSQL 18 以降でカスタムのインストールプレフィックスに拡張機能をインストールするには、 install に prefix 引数だけを渡します（他の make ターゲットは指定しません）。

sudo make install prefix=/usr/local/extras

次に、以下の [postgresql.conf のパラメータ] にそのプレフィックスが含まれていることを確認してください。

extension_control_path = '/usr/local/extras/postgresql/share:$system'
dynamic_library_path   = '/usr/local/extras/postgresql/lib:$libdir'

テスト

拡張機能をインストールしたら、次のコマンドでテストスイートを実行します。

make installcheck

次のようなエラーが発生した場合:

ERROR:  must be owner of database regression

テストスイートは、デフォルトのスーパーユーザーである「postgres」などのスーパーユーザーを使用して実行する必要があります。

make installcheck PGUSER=postgres

ロード

pg_clickhouse がインストールされたら、スーパーユーザー権限で接続し、次のコマンドを実行してデータベースに追加します。

CREATE EXTENSION pg_clickhouse;

pg_clickhouse と、その関連するすべてのオブジェクトを特定のスキーマにインストールしたい場合は、次のように SCHEMA 句を使ってスキーマを指定します。

CREATE SCHEMA env;
CREATE EXTENSION pg_clickhouse SCHEMA env;

依存関係

pg_clickhouse 拡張には、PostgreSQL 13 以上、libcurl、libuuid が必要です。この拡張をビルドするには、C および C++ コンパイラ、libSSL、GNU make、CMake が必要です。

ロードマップ

現在の最優先事項は、DML 機能を追加する前に、分析ワークロード向けのプッシュダウン対応を完了することです。今後のロードマップは次のとおりです。

まだプッシュダウンされていない残り 10 個の TPC-H クエリについて、最適な実行計画となるようにする
ClickBench クエリに対するプッシュダウンをテストし、修正する
すべての PostgreSQL 集約関数の透過的なプッシュダウンをサポートする
すべての PostgreSQL 関数の透過的なプッシュダウンをサポートする
CREATE SERVER と GUC を通じて、サーバーレベルおよびセッションレベルの ClickHouse 設定を行えるようにする
すべての ClickHouse データ型をサポートする
論理削除（lightweight DELETE）および UPDATE をサポートする
COPY によるバッチ挿入をサポートする
任意の ClickHouse クエリを実行し、その結果をテーブルとして返す関数を追加する
すべてがリモートデータベースを対象としている場合に、UNION クエリのプッシュダウンをサポートする

著者

著作権

はじめに​

はじめに​

テストケース: TPC-H​

ソースからビルドする​

一般的な Unix​

Debian / Ubuntu / APT​

RedHat / CentOS / Yum​

PGXN からインストール​

コンパイルとインストール​

テスト​

ロード​

依存関係​

ロードマップ​

著者​

著作権​

はじめに

はじめに

テストケース: TPC-H

ソースからビルドする

一般的な Unix

Debian / Ubuntu / APT

RedHat / CentOS / Yum

PGXN からインストール

コンパイルとインストール

テスト

ロード

依存関係

ロードマップ

著者

著作権