PostgreSQL インターフェイス

ClickHouse は PostgreSQL ワイヤプロトコル をサポートしているため、Postgres クライアントを使って ClickHouse に接続できます。言い換えると、ClickHouse は PostgreSQL インスタンスとして振る舞えるため、ClickHouse がまだ直接サポートしていない PostgreSQLクライアントアプリケーション (たとえば Amazon Redshift) からでも ClickHouse に接続できます。

PostgreSQL ワイヤプロトコル を有効にするには、サーバーの設定ファイルに postgresql_port 設定を追加します。たとえば、config.d フォルダー内の新しい XML ファイルでポートを定義できます。

<clickhouse>
    <postgresql_port>9005</postgresql_port>
</clickhouse>

ClickHouse serverを起動し、Listening for PostgreSQL compatibility protocol という文言を含む、次のようなログメッセージを探します:

{} <Information> Application: Listening for PostgreSQL compatibility protocol: 127.0.0.1:9005

次のコマンドは、PostgreSQLクライアント psql を ClickHouse に接続する方法を示しています。

psql -p [port] -h [hostname] -U [username] [database_name]

例：

psql -p 9005 -h 127.0.0.1 -U alice default

psql クライアントでパスワードの入力が求められます。

Password for user alice:
psql (14.2, server 22.3.1.1)
WARNING: psql major version 14, server major version 22.
         Some psql features might not work.
Type "help" for help.

default=>

以上で完了です。これで、ClickHouse に接続された PostgreSQL client を利用でき、すべてのコマンドとクエリは ClickHouse 上で実行されます。

ClickHouse インスタンスで SSL/TLS が設定されている場合、postgresql_port でも同じ設定が使われます (このポートはセキュア接続と非セキュア接続の両方で共有されます) 。

SSL を使用した接続方法は、クライアントごとに異なります。次のコマンドは、証明書と秘密鍵を指定して psql から ClickHouse に安全に接続する方法を示しています。

psql "port=9005 host=127.0.0.1 user=alice dbname=default sslcert=/path/to/certificate.pem sslkey=/path/to/key.pem sslrootcert=/path/to/rootcert.pem sslmode=verify-ca"

ClickHouse で安全なユーザー認証を行うには、SCRAM-SHA-256 プロトコルの使用を推奨します。users.xml ファイルで password_scram_sha256_hex 要素を指定して、ユーザーを設定します。パスワードハッシュは num_iterations=4096 を指定して生成する必要があります。

接続時に psql クライアントが SCRAM-SHA-256 をサポートし、そのネゴシエーションを行うことを確認してください。

パスワード abacaba のユーザー user_with_sha256 の設定例:

<user_with_sha256>
    <password_scram_sha256_hex>04e7a70338d7af7bb6142fe7e19fef46d9b605f3e78b932a60e8200ef9154976</password_scram_sha256_hex>
</user_with_sha256>

PostgreSQL ドキュメントで、SSL 設定の詳細を確認できます。