HTTP インターフェース

前提条件

この記事の例を試すには、次のものが必要です。

稼働中の ClickHouse サーバーインスタンス
curl がインストールされていること。Ubuntu または Debian では sudo apt install curl を実行するか、インストール手順についてはこのドキュメントを参照してください。

概要

HTTP インターフェイスを使用すると、REST API の形式で、任意のプラットフォーム・任意のプログラミング言語から ClickHouse を利用できます。HTTP インターフェイスはネイティブインターフェイスより機能が制限されますが、言語サポートは優れています。

デフォルトでは、clickhouse-server は次のポートで待ち受けます:

HTTP 用のポート 8123
HTTPS 用として有効化可能なポート 8443

パラメータなしで GET / リクエストを送信すると、ステータスコード 200 と文字列「Ok.」が返されます。

$ curl 'http://localhost:8123/'
Ok.

"Ok." は、http_server_default_response で定義されている既定値であり、必要に応じて変更できます。

また、HTTP 応答コードに関する注意事項も参照してください。

Web ユーザーインターフェイス

ClickHouse には Web ユーザーインターフェイスがあり、以下のアドレスからアクセスできます。

http://localhost:8123/play

Web UI は、クエリ実行中の進行状況表示、クエリのキャンセル、および結果のストリーミング表示をサポートしています。クエリパイプラインに対してチャートやグラフを表示できる隠し機能も備えています。

クエリが正常に実行されると、ダウンロードボタンが表示され、CSV、TSV、JSON、JSONLines、Parquet、Markdown、あるいは ClickHouse がサポートする任意のカスタムフォーマットなど、さまざまな形式でクエリ結果をダウンロードできます。ダウンロード機能はクエリキャッシュを利用して、クエリを再実行することなく効率的に結果を取得します。UI 上で多数あるページのうち 1 ページだけが表示されていた場合でも、ダウンロードでは完全な結果セットが取得されます。

Web UI は、あなたのようなプロフェッショナル向けに設計されています。

ヘルスチェック用スクリプトでは GET /ping リクエストを使用してください。このハンドラは常に「Ok.」（末尾に改行付き）を返します。バージョン 18.12.13 以降で利用可能です。レプリカの遅延を確認するには /replicas_status も参照してください。

$ curl 'http://localhost:8123/ping'
Ok.
$ curl 'http://localhost:8123/replicas_status'
Ok.

HTTP/HTTPS 経由でのクエリ実行

HTTP/HTTPS 経由でクエリを実行する方法は 3 つあります:

リクエストを URL の 'query' パラメータとして送信する
POST メソッドを使用する
クエリの先頭部分を 'query' パラメータで送り、残りを POST で送信する

注記

URL のサイズはデフォルトで 1 MiB に制限されています。この制限は http_max_uri_size 設定で変更できます。

成功した場合は、レスポンスコード 200 とレスポンスボディ内の結果が返されます。エラーが発生した場合は、レスポンスコード 500 とレスポンスボディ内のエラー内容テキストが返されます。

GET を使用するリクエストは 'readonly'（読み取り専用）です。つまり、データを変更するクエリでは POST メソッドのみ使用できます。クエリ自体は、POST のボディに含めるか、URL パラメータとして送信できます。いくつか例を見ていきます。

以下の例では、curl を使用してクエリ SELECT 1 を送信します。スペース文字を URL エンコードした %20 の使用に注意してください。

curl 'http://localhost:8123/?query=SELECT%201'

この例では、-nv（詳細出力なし）および -O- パラメータを指定した wget を使用し、結果をターミナルに出力しています。この場合、スペースを URL エンコードする必要はありません。

wget -nv -O- 'http://localhost:8123/?query=SELECT 1'

次の例では、生の HTTP リクエストをそのまま netcat にパイプします。

echo -ne 'GET /?query=SELECT%201 HTTP/1.0\r\n\r\n' | nc localhost 8123

HTTP/1.0 200 OK
X-ClickHouse-Summary: {"read_rows":"1","read_bytes":"1","written_rows":"0","written_bytes":"0","total_rows_to_read":"1","result_rows":"0","result_bytes":"0","elapsed_ns":"4505959","memory_usage":"1111711"}
Date: Tue, 11 Nov 2025 18:16:01 GMT
Connection: Close
Content-Type: text/tab-separated-values; charset=UTF-8
Access-Control-Expose-Headers: X-ClickHouse-Query-Id,X-ClickHouse-Summary,X-ClickHouse-Server-Display-Name,X-ClickHouse-Format,X-ClickHouse-Timezone,X-ClickHouse-Exception-Code,X-ClickHouse-Exception-Tag
X-ClickHouse-Server-Display-Name: MacBook-Pro.local
X-ClickHouse-Query-Id: ec0d8ec6-efc4-4e1d-a14f-b748e01f5294
X-ClickHouse-Format: TabSeparated
X-ClickHouse-Timezone: Europe/London
X-ClickHouse-Exception-Tag: dngjzjnxkvlwkeua

1

ご覧のとおり、curl コマンドは空白文字を URL エンコードしなければならないという点でやや不便です。 wget は自動的に URL エンコードしてくれますが、HTTP/1.1 で keep-alive と Transfer-Encoding: chunked を使用する場合にうまく動作しないため、使用は推奨しません。

$ echo 'SELECT 1' | curl 'http://localhost:8123/' --data-binary @-
1

$ echo 'SELECT 1' | curl 'http://localhost:8123/?query=' --data-binary @-
1

$ echo '1' | curl 'http://localhost:8123/?query=SELECT' --data-binary @-
1

クエリの一部がパラメータで送信され、残りが POST で送信される場合、これら2つのデータパーツの間に改行が挿入されます。例えば、次のようなものは正しく動作しません：

$ echo 'ECT 1' | curl 'http://localhost:8123/?query=SEL' --data-binary @-
Code: 59, e.displayText() = DB::Exception: Syntax error: failed at position 0: SEL
ECT 1
, expected One of: SHOW TABLES, SHOW DATABASES, SELECT, INSERT, CREATE, ATTACH, RENAME, DROP, DETACH, USE, SET, OPTIMIZE., e.what() = DB::Exception

デフォルトでは、データは TabSeparated フォーマットで返されます。

FORMAT 句は、クエリ内で他のフォーマットを指定するために使用します。たとえば、次のように指定します。

wget -nv -O- 'http://localhost:8123/?query=SELECT 1, 2, 3 FORMAT JSON'

{
    "meta":
    [
        {
            "name": "1",
            "type": "UInt8"
        },
        {
            "name": "2",
            "type": "UInt8"
        },
        {
            "name": "3",
            "type": "UInt8"
        }
    ],

    "data":
    [
        {
            "1": 1,
            "2": 2,
            "3": 3
        }
    ],

    "rows": 1,

    "statistics":
    {
        "elapsed": 0.000515,
        "rows_read": 1,
        "bytes_read": 1
    }
}

TabSeparated 以外のデフォルトのフォーマットを指定するには、default_format URL パラメータまたは X-ClickHouse-Format ヘッダーを使用できます。

$ echo 'SELECT 1 FORMAT Pretty' | curl 'http://localhost:8123/?' --data-binary @-
┏━━━┓
┃ 1 ┃
┡━━━┩
│ 1 │
└───┘

パラメータ化クエリには POST メソッドを使用できます。パラメータは {name:Type} のように、パラメータ名と型を中括弧で指定します。パラメータ値は param_name パラメータで渡します。

$ curl -X POST -F 'query=select {p1:UInt8} + {p2:UInt8}' -F "param_p1=3" -F "param_p2=4" 'http://localhost:8123/'

7

HTTP/HTTPS 経由での INSERT クエリ

INSERT クエリでデータを送信するには、POST メソッドが必要です。この場合、クエリの先頭部分を URL パラメータに記述し、POST を使って挿入するデータ本体を渡します。挿入するデータとしては、例えば MySQL からのタブ区切りダンプなどが考えられます。この方法では、INSERT クエリが MySQL の LOAD DATA LOCAL INFILE の代わりとなります。

例

テーブルを作成するには、次のようにします：

$ echo 'CREATE TABLE t (a UInt8) ENGINE = Memory' | curl 'http://localhost:8123/' --data-binary @-

おなじみの INSERT クエリを使ってデータを挿入するには、次のようにします。

$ echo 'INSERT INTO t VALUES (1),(2),(3)' | curl 'http://localhost:8123/' --data-binary @-

クエリとは別にデータを送信するには、次のようにします。

$ echo '(4),(5),(6)' | curl 'http://localhost:8123/?query=INSERT%20INTO%20t%20VALUES' --data-binary @-

任意のデータフォーマットを指定できます。たとえば、INSERT INTO t VALUES を記述するときと同じ「Values」形式を指定できます。

$ echo '(7),(8),(9)' | curl 'http://localhost:8123/?query=INSERT%20INTO%20t%20FORMAT%20Values' --data-binary @-

タブ区切りのダンプからデータを挿入するには、対応するフォーマットを指定します。

$ echo -ne '10\n11\n12\n' | curl 'http://localhost:8123/?query=INSERT%20INTO%20t%20FORMAT%20TabSeparated' --data-binary @-

テーブルの内容を読み出すには、以下を実行します：

$ curl 'http://localhost:8123/?query=SELECT%20a%20FROM%20t'
7
8
9
10
11
12
1
2
3
4
5
6

注記

クエリの並列処理により、データはランダムな順序で出力されます。

テーブルを削除するには次のようにします。

$ echo 'DROP TABLE t' | curl 'http://localhost:8123/' --data-binary @-

データテーブルを伴わない成功したリクエストでは、空のレスポンスボディが返されます。

圧縮

大量のデータを送信するときのネットワークトラフィックを削減したり、その場で圧縮されたダンプを作成したりするために、圧縮を使用できます。

データ送信時には、ClickHouse の内部圧縮形式を使用できます。圧縮データは非標準の形式であり、扱うには clickhouse-compressor プログラムが必要です。これは clickhouse-client パッケージと共にデフォルトでインストールされます。

データ挿入の効率を高めるには、http_native_compression_disable_checksumming_on_decompress 設定を使用して、サーバー側のチェックサム検証を無効化してください。

URL に compress=1 を指定すると、サーバーは送信データを圧縮します。URL に decompress=1 を指定すると、サーバーは POST メソッドで送信したデータを解凍します。

HTTP compression を使用することもできます。ClickHouse は次の compression methods をサポートします:

gzip
br
deflate
xz
zstd
lz4
bz2
snappy

圧縮した POST リクエストを送信するには、リクエストヘッダーに Content-Encoding: compression_method を追加します。

ClickHouse にレスポンスを圧縮させるには、リクエストに Accept-Encoding: compression_method ヘッダーを追加します。

すべての圧縮方式に対して、http_zlib_compression_level 設定を使用してデータ圧縮レベルを構成できます。

参考文献

一部の HTTP クライアントはデフォルトで（gzip および deflate によって）サーバーからのデータを自動的に解凍する場合があり、圧縮設定を正しく使用していても解凍済みデータを受け取ることがあります。

例

圧縮データをサーバーに送信するには、次のようにします。

echo "SELECT 1" | gzip -c | \
curl -sS --data-binary @- -H 'Content-Encoding: gzip' 'http://localhost:8123/'

サーバーから圧縮データアーカイブを取得するには、次のようにします。

curl -vsS "http://localhost:8123/?enable_http_compression=1" \
-H 'Accept-Encoding: gzip' --output result.gz -d 'SELECT number FROM system.numbers LIMIT 3'

zcat result.gz
0
1
2

サーバーから圧縮データを受信し、gunzip を使って展開済みデータを取得するには、次のようにします：

curl -sS "http://localhost:8123/?enable_http_compression=1" \
-H 'Accept-Encoding: gzip' -d 'SELECT number FROM system.numbers LIMIT 3' | gunzip -
0
1
2

デフォルトデータベース

database URL パラメータまたは X-ClickHouse-Database ヘッダーを使用して、デフォルトのデータベースを指定できます。

echo 'SELECT number FROM numbers LIMIT 10' | curl 'http://localhost:8123/?database=system' --data-binary @-
0
1
2
3
4
5
6
7
8
9

デフォルトでは、サーバー設定で登録されているデータベースがデフォルトデータベースとして使用されます。インストール直後の状態では、これは default という名前のデータベースです。あるいは、テーブル名の前にドット区切りでデータベース名を付けて明示的に指定することもできます。

認証

ユーザー名とパスワードは、次の 3 つの方法のいずれかで指定できます。

HTTP Basic Authentication を使用する場合。

例:

echo 'SELECT 1' | curl 'http://user:password@localhost:8123/' -d @-

user と password の URL パラメータを使用する方法

注記

パラメータが Web プロキシによってログに記録されたり、ブラウザにキャッシュされたりする可能性があるため、この方法は推奨されません。

例えば、次のように指定します。

echo 'SELECT 1' | curl 'http://localhost:8123/?user=user&password=password' -d @-

'X-ClickHouse-User' および 'X-ClickHouse-Key' ヘッダーを使用する

例：

echo 'SELECT 1' | curl -H 'X-ClickHouse-User: user' -H 'X-ClickHouse-Key: password' 'http://localhost:8123/' -d @-

ユーザー名が指定されていない場合は、default というユーザー名が使用されます。パスワードが指定されていない場合は、空のパスワードが使用されます。また、URL パラメーターを使用して、単一のクエリの処理や設定プロファイル全体に対する各種設定を指定することもできます。

例:

http://localhost:8123/?profile=web&max_rows_to_read=1000000000&query=SELECT+1

$ echo 'SELECT number FROM system.numbers LIMIT 10' | curl 'http://localhost:8123/?' --data-binary @-
0
1
2
3
4
5
6
7
8
9

詳細は以下を参照してください:

設定
SET

HTTP プロトコルでの ClickHouse セッションの使用

ClickHouse セッションは HTTP プロトコルでも使用できます。これを行うには、リクエストに session_id の GET パラメーターを追加します。セッション ID には任意の文字列を使用できます。

デフォルトでは、セッションは 60 秒間アクティビティがないと終了します。このタイムアウト（秒）を変更するには、サーバー設定の default_session_timeout 設定を変更するか、リクエストに session_timeout の GET パラメーターを追加します。

セッションのステータスを確認するには、session_check=1 パラメーターを使用します。1 つのセッション内で同時に実行できるクエリは 1 件のみです。

クエリの実行状況に関する情報は、X-ClickHouse-Progress レスポンスヘッダーで受け取ることができます。そのためには、send_progress_in_http_headers を有効にします。

以下はヘッダーシーケンスの例です。

X-ClickHouse-Progress: {"read_rows":"261636","read_bytes":"2093088","total_rows_to_read":"1000000","elapsed_ns":"14050417","memory_usage":"22205975"}
X-ClickHouse-Progress: {"read_rows":"654090","read_bytes":"5232720","total_rows_to_read":"1000000","elapsed_ns":"27948667","memory_usage":"83400279"}
X-ClickHouse-Progress: {"read_rows":"1000000","read_bytes":"8000000","total_rows_to_read":"1000000","elapsed_ns":"38002417","memory_usage":"80715679"}

利用可能なヘッダーフィールドは次のとおりです。

Header field	Description
`read_rows`	読み取った行数。
`read_bytes`	読み取ったデータ量（バイト単位）。
`total_rows_to_read`	読み取る予定の行の合計数。
`written_rows`	書き込んだ行数。
`written_bytes`	書き込んだデータ量（バイト単位）。
`elapsed_ns`	クエリの実行時間（ナノ秒単位）。
`memory_usage`	クエリで使用されたメモリ量（バイト単位）。

HTTP 接続が失われても、実行中のリクエストは自動的には停止しません。解析およびデータのフォーマットはサーバー側で実行されるため、ネットワークの使用が非効率になる場合があります。

次のオプションパラメータを指定できます。

Parameters	Description
`query_id` (optional)	クエリ ID（任意の文字列）として渡すことができます。 `replace_running_query`
`quota_key` (optional)	クォータキー（任意の文字列）として渡すことができます。 "Quotas"

HTTP インターフェイスでは、クエリ用に外部データ（外部一時テーブル）を渡すことができます。詳細については "External data for query processing" を参照してください。

レスポンスのバッファリング

レスポンスのバッファリングはサーバー側で有効化できます。このために、次の URL パラメータが用意されています:

buffer_size
wait_end_of_query

次の設定を使用できます:

buffer_size は、サーバーメモリ内でバッファリングする結果のバイト数を決定します。レスポンスボディがこのしきい値より大きい場合、バッファは HTTP チャネルに書き込まれ、残りのデータは直接 HTTP チャネルに送信されます。

レスポンス全体がバッファリングされるようにするには、wait_end_of_query=1 を設定します。この場合、メモリに保持されないデータはサーバー上の一時ファイルにバッファリングされます。

例:

curl -sS 'http://localhost:8123/?max_result_bytes=4000000&buffer_size=3000000&wait_end_of_query=1' -d 'SELECT toUInt8(number) FROM system.numbers LIMIT 9000000 FORMAT RowBinary'

ヒント

バッファリングを使用して、ステータスコードと HTTP ヘッダーがクライアントに送信された後にクエリ処理エラーが発生してしまう状況を回避してください。このような場合、エラーメッセージはレスポンスボディの末尾に書き込まれ、クライアント側ではレスポンスを解析する段階になって初めてエラーを検出できます。

クエリパラメータでロールを設定する

この機能は ClickHouse 24.4 で導入されました。

特定のケースでは、文自体を実行する前に、付与されたロールを先に設定しておく必要がある場合があります。しかし、マルチステートメントは許可されていないため、SET ROLE と文をまとめて送信することはできません。

curl -sS "http://localhost:8123" --data-binary "SET ROLE my_role;SELECT * FROM my_table;"

上記のコマンドを実行すると、次のエラーが発生します：

Code: 62. DB::Exception: Syntax error (Multi-statements are not allowed)

この制限を回避するには、代わりに role クエリパラメータを使用してください:

curl -sS "http://localhost:8123?role=my_role" --data-binary "SELECT * FROM my_table;"

これは、ステートメントの前に SET ROLE my_role を実行するのと同等です。

さらに、role クエリパラメータを複数指定することもできます。

curl -sS "http://localhost:8123?role=my_role&role=my_other_role" --data-binary "SELECT * FROM my_table;"

この場合、?role=my_role&role=my_other_role は、ステートメントの前に SET ROLE my_role, my_other_role を実行するのと同等の効果があります。

HTTP レスポンスコードに関する注意事項

HTTP プロトコルの制限により、HTTP 200 レスポンスコードが返ってきても、クエリが成功したとは限りません。

次の例を見てみましょう。

curl -v -Ss "http://localhost:8123/?max_block_size=1&query=select+sleepEachRow(0.001),throwIf(number=2)from+numbers(5)"
*   Trying 127.0.0.1:8123...
...
< HTTP/1.1 200 OK
...
Code: 395. DB::Exception: Value passed to 'throwIf' function is non-zero: while executing 'FUNCTION throwIf(equals(number, 2) :: 1) -> throwIf(equals(number, 2))

この動作が発生する理由は、HTTP プロトコルの性質によるものです。HTTP ヘッダーはまず HTTP ステータスコード 200 とともに送信され、その後に HTTP ボディが続き、そのボディの中にエラーがプレーンテキストとして挿入されます。

この動作は、使用されるフォーマットに依存しません。Native、TSV、JSON のいずれであっても、エラーメッセージは常にレスポンスストリームの途中に現れます。

この問題は wait_end_of_query=1（レスポンスのバッファリング）を有効にすることである程度軽減できます。この場合、HTTP ヘッダーの送信は、クエリ全体の処理が完了するまで遅延されます。ただし、この方法でも問題は完全には解決しません。結果は依然として http_response_buffer_size の範囲内に収まる必要があり、さらに send_progress_in_http_headers のような他の設定がヘッダー送信の遅延に影響を与える可能性があります。

ヒント

すべてのエラーを確実に検出する唯一の方法は、必要なフォーマットでパースする前に HTTP ボディを解析することです。

ClickHouse におけるこの種の例外は、http_write_exception_in_output_format=0（デフォルト）の場合、使用するフォーマット（例: Native、TSV、JSON など）に関係なく、以下のように一貫した例外フォーマットになります。これにより、クライアント側でエラーメッセージをパースおよび抽出しやすくなります。

\r\n
__exception__\r\n
<TAG>\r\n
<error message>\r\n
<message_length> <TAG>\r\n
__exception__\r\n

ここでの <TAG> は 16 バイトのランダムなタグであり、X-ClickHouse-Exception-Tag レスポンスヘッダーで送信されるタグと同じものです。 <error message> は実際の例外メッセージです（正確な長さは <message_length> で確認できます）。前述の例外ブロック全体のサイズは最大で 16 KiB です。

以下は JSON 形式での例です。

$ curl -v -Ss "http://localhost:8123/?max_block_size=1&query=select+sleepEachRow(0.001),throwIf(number=2)from+numbers(5)+FORMAT+JSON"
...
{
    "meta":
    [
        {
            "name": "sleepEachRow(0.001)",
            "type": "UInt8"
        },
        {
            "name": "throwIf(equals(number, 2))",
            "type": "UInt8"
        }
    ],

    "data":
    [
        {
            "sleepEachRow(0.001)": 0,
            "throwIf(equals(number, 2))": 0
        },
        {
            "sleepEachRow(0.001)": 0,
            "throwIf(equals(number, 2))": 0
        }
__exception__
dmrdfnujjqvszhav
Code: 395. DB::Exception: Value passed to 'throwIf' function is non-zero: while executing 'FUNCTION throwIf(equals(__table1.number, 2_UInt8) :: 1) -> throwIf(equals(__table1.number, 2_UInt8)) UInt8 : 0'. (FUNCTION_THROW_IF_VALUE_IS_NON_ZERO) (version 25.11.1.1)
262 dmrdfnujjqvszhav
__exception__

同様の例を、CSV 形式で示します

$ curl -v -Ss "http://localhost:8123/?max_block_size=1&query=select+sleepEachRow(0.001),throwIf(number=2)from+numbers(5)+FORMAT+CSV"
...
<
0,0
0,0

__exception__
rumfyutuqkncbgau
Code: 395. DB::Exception: Value passed to 'throwIf' function is non-zero: while executing 'FUNCTION throwIf(equals(__table1.number, 2_UInt8) :: 1) -> throwIf(equals(__table1.number, 2_UInt8)) UInt8 : 0'. (FUNCTION_THROW_IF_VALUE_IS_NON_ZERO) (version 25.11.1.1)
262 rumfyutuqkncbgau
__exception__

パラメータ付きクエリ

パラメータ付きのクエリを作成し、対応する HTTP リクエストのパラメータから値を渡すことができます。詳細については、CLI のパラメータ付きクエリを参照してください。

例

$ curl -sS "<address>?param_id=2&param_phrase=test" -d "SELECT * FROM table WHERE int_column = {id:UInt8} and string_column = {phrase:String}"

URL パラメータ内のタブ

クエリパラメータは「エスケープされた」形式からパースされます。これには、\N として NULL を明確にパースできるといった利点があります。したがって、タブ文字は \t（または \ とタブ）としてエンコードする必要があります。たとえば、次の例では abc と 123 の間に実際のタブが含まれており、入力文字列は 2 つの値に分割されます。

curl -sS "http://localhost:8123" -d "SELECT splitByChar('\t', 'abc      123')"

['abc','123']

しかし、URL パラメーター内で実際のタブ文字を %09 としてエンコードしようとしても、正しく解釈されません。

curl -sS "http://localhost:8123?param_arg1=abc%09123" -d "SELECT splitByChar('\t', {arg1:String})"
Code: 457. DB::Exception: Value abc    123 cannot be parsed as String for query parameter 'arg1' because it isn't parsed completely: only 3 of 7 bytes was parsed: abc. (BAD_QUERY_PARAMETER) (version 23.4.1.869 (official build))

URL パラメータとして使用する場合は、\t を %5C%09 にエンコードする必要があります。例えば、次のように指定します。

curl -sS "http://localhost:8123?param_arg1=abc%5C%09123" -d "SELECT splitByChar('\t', {arg1:String})"

['abc','123']

あらかじめ定義された HTTP インターフェース

ClickHouse では、HTTP インターフェース経由で特定のクエリを実行できます。たとえば、次のようにテーブルにデータを書き込むことができます。

$ echo '(4),(5),(6)' | curl 'http://localhost:8123/?query=INSERT%20INTO%20t%20VALUES' --data-binary @-

ClickHouse は、Prometheus exporter のようなサードパーティーツールとの統合をより簡単に行えるようにする Predefined HTTP Interface もサポートしています。例を見てみましょう。

まず、このセクションをサーバー設定ファイルに追加します。

http_handlers には複数の rule を含めるように構成します。ClickHouse は受信した HTTP リクエストを rule に定義された事前定義のタイプと照合し、最初にマッチした rule がハンドラーを実行します。マッチに成功すると、ClickHouse は対応する事前定義クエリを実行します。

<http_handlers>
    <rule>
        <url>/predefined_query</url>
        <methods>POST,GET</methods>
        <handler>
            <type>predefined_query_handler</type>
            <query>SELECT * FROM system.metrics LIMIT 5 FORMAT Template SETTINGS format_template_resultset = 'prometheus_template_output_format_resultset', format_template_row = 'prometheus_template_output_format_row', format_template_rows_between_delimiter = '\n'</query>
        </handler>
    </rule>
    <rule>...</rule>
    <rule>...</rule>
</http_handlers>

Prometheus 形式のデータは、次の URL から直接リクエストできます：

$ curl -v 'http://localhost:8123/predefined_query'
*   Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /predefined_query HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
>
< HTTP/1.1 200 OK
< Date: Tue, 28 Apr 2020 08:52:56 GMT
< Connection: Keep-Alive
< Content-Type: text/plain; charset=UTF-8
< X-ClickHouse-Server-Display-Name: i-mloy5trc
< Transfer-Encoding: chunked
< X-ClickHouse-Query-Id: 96fe0052-01e6-43ce-b12a-6b7370de6e8a
< X-ClickHouse-Format: Template
< X-ClickHouse-Timezone: Asia/Shanghai
< Keep-Alive: timeout=10
< X-ClickHouse-Summary: {"read_rows":"0","read_bytes":"0","written_rows":"0","written_bytes":"0","total_rows_to_read":"0","elapsed_ns":"662334","memory_usage":"8451671"}
<
# HELP "Query" "Number of executing queries"
# TYPE "Query" counter
"Query" 1

# HELP "Merge" "Number of executing background merges"
# TYPE "Merge" counter
"Merge" 0

# HELP "PartMutation" "Number of mutations (ALTER DELETE/UPDATE)"
# TYPE "PartMutation" counter
"PartMutation" 0

# HELP "ReplicatedFetch" "Number of data parts being fetched from replica"
# TYPE "ReplicatedFetch" counter
"ReplicatedFetch" 0

# HELP "ReplicatedSend" "Number of data parts being sent to replicas"
# TYPE "ReplicatedSend" counter
"ReplicatedSend" 0

* Connection #0 to host localhost left intact

* Connection #0 to host localhost left intact

http_handlers の構成オプションは、次のように機能します。

rule では、以下のパラメータを設定できます。

method
headers
url
full_url
handler

これらそれぞれについて、以下で順に説明します。

method は、HTTP リクエストのメソッド部分をマッチさせる役割を持ちます。method は HTTP プロトコルにおける [method]
(https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods) の定義に完全に準拠します。これは任意の設定です。設定ファイルで定義されていない場合、HTTP リクエストのメソッド部分にはマッチしません。
url は、HTTP リクエストの URL 部分（パスおよびクエリ文字列）をマッチさせる役割を持ちます。 url が regex: でプレフィックスされている場合、RE2 の正規表現として解釈されます。これは任意の設定です。設定ファイルで定義されていない場合、HTTP リクエストの URL 部分にはマッチしません。
full_url は url と同様ですが、完全な URL、すなわち schema://host:port/path?query_string を含みます。なお、ClickHouse は「バーチャルホスト」をサポートしていないため、host は IP アドレスです（Host ヘッダーの値ではありません）。
empty_query_string - リクエストにクエリ文字列（?query_string）が存在しないことを保証します。
headers は、HTTP リクエストのヘッダー部分をマッチさせる役割を持ちます。RE2 の正規表現と互換性があります。これは任意の設定です。設定ファイルで定義されていない場合、HTTP リクエストのヘッダー部分にはマッチしません。
handler は、主要な処理部分を含みます。

次のような type を取ることができます:
および次のパラメータを取ります:
- query — predefined_query_handler 型で使用し、ハンドラーが呼び出されたときにクエリを実行します。
- query_param_name — dynamic_query_handler 型で使用し、HTTP リクエストパラメータの中から query_param_name に対応する値を抽出して実行します。
- status — static 型で使用し、レスポンスのステータスコードを指定します。
- content_type — 任意の型で使用し、レスポンスの content-type を指定します。
- http_response_headers — 任意の型で使用し、レスポンスヘッダーのマップです。content type の設定にも使用できます。
- response_content — static 型で使用し、クライアントに送信されるレスポンスコンテンツです。file:// または config:// のプレフィックスを使用する場合、ファイルまたは設定からコンテンツを取得してクライアントに送信します。
- user - クエリを実行する USER（デフォルトのユーザーは default）を指定します。注意: この USER に対してパスワードを指定する必要はありません。

異なる type ごとの設定方法については、次で説明します。

predefined_query_handler

predefined_query_handler は、Settings および query_params の値の設定をサポートします。predefined_query_handler タイプでは query を設定できます。

query の値は predefined_query_handler における事前定義済みクエリであり、HTTP リクエストに一致したときに ClickHouse によって実行され、そのクエリ結果が返されます。これは必須の設定です。

次の例では、max_threads と max_final_threads 設定の値を定義し、その後でシステムテーブルに対してクエリを実行して、これらの設定が正しく反映されているかを確認します。

注記

query、play、ping のようなデフォルトの handlers を保持するには、<defaults/> ルールを追加します。

例えば:

<http_handlers>
    <rule>
        <url><![CDATA[regex:/query_param_with_url/(?P<name_1>[^/]+)]]></url>
        <methods>GET</methods>
        <headers>
            <XXX>TEST_HEADER_VALUE</XXX>
            <PARAMS_XXX><![CDATA[regex:(?P<name_2>[^/]+)]]></PARAMS_XXX>
        </headers>
        <handler>
            <type>predefined_query_handler</type>
            <query>
                SELECT name, value FROM system.settings
                WHERE name IN ({name_1:String}, {name_2:String})
            </query>
        </handler>
    </rule>
    <defaults/>
</http_handlers>

curl -H 'XXX:TEST_HEADER_VALUE' -H 'PARAMS_XXX:max_final_threads' 'http://localhost:8123/query_param_with_url/max_threads?max_threads=1&max_final_threads=2'
max_final_threads    2
max_threads    1

注記

1 つの predefined_query_handler では、1 つの query のみ対応しています。

dynamic_query_handler

dynamic_query_handler では、クエリは HTTP リクエストのパラメータとして記述されます。predefined_query_handler との違いは、predefined_query_handler ではクエリが設定ファイル内に記述される点です。query_param_name は dynamic_query_handler 内で設定できます。

ClickHouse は、HTTP リクエストの URL 内で query_param_name に対応する値を取り出して実行します。query_param_name のデフォルト値は /query です。これは任意の設定です。設定ファイル内に定義がない場合、このパラメータは渡されません。

この機能を試すために、次の例では max_threads と max_final_threads の値を設定し、クエリを実行して設定が正しく適用されているかを確認します。

例:

<http_handlers>
    <rule>
    <headers>
        <XXX>TEST_HEADER_VALUE_DYNAMIC</XXX>    </headers>
    <handler>
        <type>dynamic_query_handler</type>
        <query_param_name>query_param</query_param_name>
    </handler>
    </rule>
    <defaults/>
</http_handlers>

curl  -H 'XXX:TEST_HEADER_VALUE_DYNAMIC'  'http://localhost:8123/own?max_threads=1&max_final_threads=2&param_name_1=max_threads&param_name_2=max_final_threads&query_param=SELECT%20name,value%20FROM%20system.settings%20where%20name%20=%20%7Bname_1:String%7D%20OR%20name%20=%20%7Bname_2:String%7D'
max_threads 1
max_final_threads   2

static

static は content_type、status、および response_content を返せます。response_content に指定したコンテンツが返されます。

例えば、"Say Hi!" というメッセージを返すには:

<http_handlers>
        <rule>
            <methods>GET</methods>
            <headers><XXX>xxx</XXX></headers>
            <url>/hi</url>
            <handler>
                <type>static</type>
                <status>402</status>
                <content_type>text/html; charset=UTF-8</content_type>
                <http_response_headers>
                    <Content-Language>en</Content-Language>
                    <X-My-Custom-Header>43</X-My-Custom-Header>
                </http_response_headers>
                #highlight-next-line
                <response_content>Say Hi!</response_content>
            </handler>
        </rule>
        <defaults/>
</http_handlers>

content_type の代わりに、http_response_headers を使用して Content-Type を設定できます。

<http_handlers>
        <rule>
            <methods>GET</methods>
            <headers><XXX>xxx</XXX></headers>
            <url>/hi</url>
            <handler>
                <type>static</type>
                <status>402</status>
                #begin-highlight
                <http_response_headers>
                    <Content-Type>text/html; charset=UTF-8</Content-Type>
                    <Content-Language>en</Content-Language>
                    <X-My-Custom-Header>43</X-My-Custom-Header>
                </http_response_headers>
                #end-highlight
                <response_content>Say Hi!</response_content>
            </handler>
        </rule>
        <defaults/>
</http_handlers>

curl -vv  -H 'XXX:xxx' 'http://localhost:8123/hi'
*   Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /hi HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
> XXX:xxx
>
< HTTP/1.1 402 Payment Required
< Date: Wed, 29 Apr 2020 03:51:26 GMT
< Connection: Keep-Alive
< Content-Type: text/html; charset=UTF-8
< Transfer-Encoding: chunked
< Keep-Alive: timeout=10
< X-ClickHouse-Summary: {"read_rows":"0","read_bytes":"0","written_rows":"0","written_bytes":"0","total_rows_to_read":"0","elapsed_ns":"662334","memory_usage":"8451671"}
<
* Connection #0 to host localhost left intact
Say Hi!%

設定で指定されたコンテンツを見つけてクライアントに送信します。

<get_config_static_handler><![CDATA[<html ng-app="SMI2"><head><base href="http://ui.tabix.io/"></head><body><div ui-view="" class="content-ui"></div><script src="http://loader.tabix.io/master.js"></script></body></html>]]></get_config_static_handler>

<http_handlers>
        <rule>
            <methods>GET</methods>
            <headers><XXX>xxx</XXX></headers>
            <url>/get_config_static_handler</url>
            <handler>
                <type>static</type>
                <response_content>config://get_config_static_handler</response_content>
            </handler>
        </rule>
</http_handlers>

$ curl -v  -H 'XXX:xxx' 'http://localhost:8123/get_config_static_handler'
*   Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /get_config_static_handler HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
> XXX:xxx
>
< HTTP/1.1 200 OK
< Date: Wed, 29 Apr 2020 04:01:24 GMT
< Connection: Keep-Alive
< Content-Type: text/plain; charset=UTF-8
< Transfer-Encoding: chunked
< Keep-Alive: timeout=10
< X-ClickHouse-Summary: {"read_rows":"0","read_bytes":"0","written_rows":"0","written_bytes":"0","total_rows_to_read":"0","elapsed_ns":"662334","memory_usage":"8451671"}
<
* Connection #0 to host localhost left intact
<html ng-app="SMI2"><head><base href="http://ui.tabix.io/"></head><body><div ui-view="" class="content-ui"></div><script src="http://loader.tabix.io/master.js"></script></body></html>%

クライアントに送信されるファイルの内容を取得するには：

<http_handlers>
        <rule>
            <methods>GET</methods>
            <headers><XXX>xxx</XXX></headers>
            <url>/get_absolute_path_static_handler</url>
            <handler>
                <type>static</type>
                <content_type>text/html; charset=UTF-8</content_type>
                <http_response_headers>
                    <ETag>737060cd8c284d8af7ad3082f209582d</ETag>
                </http_response_headers>
                <response_content>file:///absolute_path_file.html</response_content>
            </handler>
        </rule>
        <rule>
            <methods>GET</methods>
            <headers><XXX>xxx</XXX></headers>
            <url>/get_relative_path_static_handler</url>
            <handler>
                <type>static</type>
                <content_type>text/html; charset=UTF-8</content_type>
                <http_response_headers>
                    <ETag>737060cd8c284d8af7ad3082f209582d</ETag>
                </http_response_headers>
                <response_content>file://./relative_path_file.html</response_content>
            </handler>
        </rule>
</http_handlers>

$ user_files_path='/var/lib/clickhouse/user_files'
$ sudo echo "<html><body>Relative Path File</body></html>" > $user_files_path/relative_path_file.html
$ sudo echo "<html><body>Absolute Path File</body></html>" > $user_files_path/absolute_path_file.html
$ curl -vv -H 'XXX:xxx' 'http://localhost:8123/get_absolute_path_static_handler'
*   Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /get_absolute_path_static_handler HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
> XXX:xxx
>
< HTTP/1.1 200 OK
< Date: Wed, 29 Apr 2020 04:18:16 GMT
< Connection: Keep-Alive
< Content-Type: text/html; charset=UTF-8
< Transfer-Encoding: chunked
< Keep-Alive: timeout=10
< X-ClickHouse-Summary: {"read_rows":"0","read_bytes":"0","written_rows":"0","written_bytes":"0","total_rows_to_read":"0","elapsed_ns":"662334","memory_usage":"8451671"}
<
<html><body>Absolute Path File</body></html>
* Connection #0 to host localhost left intact
$ curl -vv -H 'XXX:xxx' 'http://localhost:8123/get_relative_path_static_handler'
*   Trying ::1...
* Connected to localhost (::1) port 8123 (#0)
> GET /get_relative_path_static_handler HTTP/1.1
> Host: localhost:8123
> User-Agent: curl/7.47.0
> Accept: */*
> XXX:xxx
>
< HTTP/1.1 200 OK
< Date: Wed, 29 Apr 2020 04:18:31 GMT
< Connection: Keep-Alive
< Content-Type: text/html; charset=UTF-8
< Transfer-Encoding: chunked
< Keep-Alive: timeout=10
< X-ClickHouse-Summary: {"read_rows":"0","read_bytes":"0","written_rows":"0","written_bytes":"0","total_rows_to_read":"0","elapsed_ns":"662334","memory_usage":"8451671"}
<
<html><body>Relative Path File</body></html>
* Connection #0 to host localhost left intact

redirect

redirect は location に対して 302 リダイレクトを行います。

たとえば、ClickHouse Play 用に play に set user を自動的に追加するには、次のようにします。

<clickhouse>
    <http_handlers>
        <rule>
            <methods>GET</methods>
            <url>/play</url>
            <handler>
                <type>redirect</type>
                <location>/play?user=play</location>
            </handler>
        </rule>
    </http_handlers>
</clickhouse>

HTTP レスポンスヘッダー

ClickHouse では、設定可能なあらゆる種類のハンドラーに適用できるカスタム HTTP レスポンスヘッダーを構成できます。これらのヘッダーは、ヘッダー名とその値を表すキーと値のペアを受け取る http_response_headers 設定で指定します。この機能は、カスタムセキュリティヘッダーや CORS ポリシー、その他 ClickHouse の HTTP インターフェイス全体に適用する必要がある各種 HTTP ヘッダー要件を実装するのに特に有用です。

たとえば、次のような対象にヘッダーを構成できます:

通常のクエリエンドポイント
Web UI
ヘルスチェック

common_http_response_headers を指定することも可能です。これらは、設定で定義されたすべての HTTP ハンドラーに適用されます。

ヘッダーは、設定されたすべてのハンドラーに対する HTTP レスポンスに含まれます。

以下の例では、すべてのサーバーレスポンスに 2 つのカスタムヘッダー X-My-Common-Header と X-My-Custom-Header が含まれます。

<clickhouse>
    <http_handlers>
        <common_http_response_headers>
            <X-My-Common-Header>Common header</X-My-Common-Header>
        </common_http_response_headers>
        <rule>
            <methods>GET</methods>
            <url>/ping</url>
            <handler>
                <type>ping</type>
                <http_response_headers>
                    <X-My-Custom-Header>Custom indeed</X-My-Custom-Header>
                </http_response_headers>
            </handler>
        </rule>
    </http_handlers>
</clickhouse>

HTTP ストリーミング中の例外発生時における有効な JSON/XML レスポンス

HTTP 経由でクエリを実行している間、データの一部がすでに送信された後で例外が発生することがあります。通常、例外はプレーンテキストでクライアントに送信されます。特定のデータ形式で出力している場合でも、例外により出力が指定されたデータ形式として不正になる可能性があります。これを防ぐために、http_write_exception_in_output_format 設定（デフォルトでは無効）を使用すると、例外を指定した形式（現在は XML および JSON* 形式をサポート）で書き出すよう ClickHouse に指示できます。

例:

$ curl 'http://localhost:8123/?query=SELECT+number,+throwIf(number>3)+from+system.numbers+format+JSON+settings+max_block_size=1&http_write_exception_in_output_format=1'
{
    "meta":
    [
        {
            "name": "number",
            "type": "UInt64"
        },
        {
            "name": "throwIf(greater(number, 2))",
            "type": "UInt8"
        }
    ],

    "data":
    [
        {
            "number": "0",
            "throwIf(greater(number, 2))": 0
        },
        {
            "number": "1",
            "throwIf(greater(number, 2))": 0
        },
        {
            "number": "2",
            "throwIf(greater(number, 2))": 0
        }
    ],

    "rows": 3,

    "exception": "Code: 395. DB::Exception: Value passed to 'throwIf' function is non-zero: while executing 'FUNCTION throwIf(greater(number, 2) :: 2) -> throwIf(greater(number, 2)) UInt8 : 1'. (FUNCTION_THROW_IF_VALUE_IS_NON_ZERO) (version 23.8.1.1)"
}

$ curl 'http://localhost:8123/?query=SELECT+number,+throwIf(number>2)+from+system.numbers+format+XML+settings+max_block_size=1&http_write_exception_in_output_format=1'
<?xml version='1.0' encoding='UTF-8' ?>
<result>
    <meta>
        <columns>
            <column>
                <name>number</name>
                <type>UInt64</type>
            </column>
            <column>
                <name>throwIf(greater(number, 2))</name>
                <type>UInt8</type>
            </column>
        </columns>
    </meta>
    <data>
        <row>
            <number>0</number>
            <field>0</field>
        </row>
        <row>
            <number>1</number>
            <field>0</field>
        </row>
        <row>
            <number>2</number>
            <field>0</field>
        </row>
    </data>
    <rows>3</rows>
    <exception>Code: 395. DB::Exception: Value passed to 'throwIf' function is non-zero: while executing 'FUNCTION throwIf(greater(number, 2) :: 2) -> throwIf(greater(number, 2)) UInt8 : 1'. (FUNCTION_THROW_IF_VALUE_IS_NON_ZERO) (version 23.8.1.1)</exception>
</result>

前提条件​

概要​

Web ユーザーインターフェイス​

HTTP/HTTPS 経由でのクエリ実行​

HTTP/HTTPS 経由での INSERT クエリ​

例​

圧縮​

例​

デフォルトデータベース​

認証​

HTTP プロトコルでの ClickHouse セッションの使用​

レスポンスのバッファリング​

クエリパラメータでロールを設定する​

HTTP レスポンスコードに関する注意事項​

パラメータ付きクエリ​

例​

URL パラメータ内のタブ​

あらかじめ定義された HTTP インターフェース​

predefined_query_handler​

dynamic_query_handler​

static​

redirect​

HTTP レスポンスヘッダー​

HTTP ストリーミング中の例外発生時における有効な JSON/XML レスポンス​