http_* サーバー設定

これらの設定はClickHouse serverの構成に使用され、ClickHouseのソースコードから自動生成されています。

http_allow_path_requests

HTTP インターフェイスで、パス形式のリクエスト (/my_db/my_table.csv など) をクエリハンドラーにルーティングできるようにします。このフラグは、リクエストの認証前に行われるルーティング判定のみを制御するため、ユーザーごとの設定に依存させることはできません。ルーティング後は、ユーザーごとの設定である http_allow_database_as_path、http_allow_table_as_file、http_allow_filters_as_path により、認証済みユーザーに対してルーティングされたパスを実際に解釈するかどうかが制御されます。このフラグがオフの場合、未知のパスには通常の 404 が返されます。デフォルトで有効です。以前の動作 (設定済みのハンドラーに該当しないパスにはすべて 404 を返す) に戻すには、0 に設定します。例

<http_allow_path_requests>0</http_allow_path_requests>

http_handlers

カスタム HTTP ハンドラーを使用できます。新しい http ハンドラーを追加するには、新しい <rule> を追加するだけです。ルールは定義された順に上から下へチェックされ、最初に一致したルールのハンドラーが実行されます。以下の設定は sub-tags で構成できます。

Sub-tags	Definition
`url`	リクエスト URL を照合するには、`regex:` プレフィックスを使用して正規表現マッチを行えます (任意)
`methods`	リクエストの methods を照合するには、カンマ区切りで複数の method を指定できます (任意)
`headers`	request headers を照合するには、各 child 要素 (child 要素名は header 名) を照合します。`regex:` プレフィックスを使用して正規表現マッチを行えます (任意)
`handler`	リクエストハンドラー
`empty_query_string`	URL に query string が存在しないことを確認します

handler には以下の設定があり、sub-tags で構成できます。

Sub-tags	Definition
`url`	リダイレクト先の location
`type`	サポートされる types: static, dynamic_query_handler, predefined_query_handler, redirect
`status`	static type とともに使用し、レスポンスの status code を指定します
`query_param_name`	dynamic_query_handler type とともに使用し、HTTP リクエスト params 内の `<query_param_name>` に対応する値を抽出して実行します
`query`	predefined_query_handler type とともに使用し、ハンドラーが呼び出されたときにクエリを実行します
`content_type`	static type とともに使用し、レスポンスの content-type を指定します
`response_content`	static type とともに使用し、クライアントに送信する Response の内容を指定します。`file://` または `config://` プレフィックスを使用した場合は、ファイルまたは configuration から内容を取得してクライアントに送信します

ルールの一覧に加えて、すべての default ハンドラーを有効にする <defaults/> を指定することもできます。例:

<http_handlers>
    <rule>
        <url>/</url>
        <methods>POST,GET</methods>
        <headers><pragma>no-cache</pragma></headers>
        <handler>
            <type>dynamic_query_handler</type>
            <query_param_name>query</query_param_name>
        </handler>
    </rule>

    <rule>
        <url>/predefined_query</url>
        <methods>POST,GET</methods>
        <handler>
            <type>predefined_query_handler</type>
            <query>SELECT * FROM system.settings</query>
        </handler>
    </rule>

    <rule>
        <handler>
            <type>static</type>
            <status>200</status>
            <content_type>text/plain; charset=UTF-8</content_type>
            <response_content>config://http_server_default_response</response_content>
        </handler>
    </rule>
</http_handlers>

http_options_response

OPTIONS HTTPリクエストのレスポンスにヘッダーを追加するために使用します。 OPTIONS メソッドは、CORSのプレフライトリクエストを行う際に使用されます。詳細については、OPTIONS を参照してください。例:

<http_options_response>
     <header>
            <name>Access-Control-Allow-Origin</name>
            <value>*</value>
     </header>
     <header>
          <name>Access-Control-Allow-Headers</name>
          <value>origin, x-requested-with, x-clickhouse-format, x-clickhouse-user, x-clickhouse-key, Authorization</value>
     </header>
     <header>
          <name>Access-Control-Allow-Methods</name>
          <value>POST, GET, OPTIONS</value>
     </header>
     <header>
          <name>Access-Control-Max-Age</name>
          <value>86400</value>
     </header>
</http_options_response>

http_server_default_response

ClickHouse HTTP(s) server にアクセスしたときにデフォルトで表示されるページです。デフォルト値は “Ok.” です (末尾に改行文字を含みます) 。

デフォルト: "Ok.\n"

例 http://localhost: http_port にアクセスすると、https://tabix.io/ が開きます。

<http_server_default_response>
  <![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>]]>
</http_server_default_response>

SQLリファレンス

データ型

エンジン

関数

フォーマット

設定

システムテーブル

データレイク

http_allow_path_requests

http_handlers

http_options_response

http_server_default_response

​http_allow_path_requests

​http_handlers

​http_options_response

​http_server_default_response

http_allow_path_requests

http_handlers

http_options_response

http_server_default_response