http_* server settings

These settings configure the ClickHouse server and are autogenerated from ClickHouse source.

http_allow_path_requests

Allow the HTTP interface to route path-style requests (such as /my_db/my_table.csv) to the query handler. This flag gates the routing decision only, which is made before the request is authenticated, so it cannot depend on a per-user setting. After routing, the per-user settings http_allow_database_as_path, http_allow_table_as_file, and http_allow_filters_as_path control whether the routed path is actually interpreted for the authenticated user. When this flag is off, unknown paths return a plain 404. Enabled by default. Set it to 0 to restore the previous behavior, in which every path that is not a configured handler returns 404. Example

<http_allow_path_requests>0</http_allow_path_requests>

http_handlers

Allows using custom HTTP handlers. To add a new http handler simply add a new <rule>. Rules are checked from top to bottom as defined, and the first match will run the handler. The following settings can be configured by sub-tags:

Sub-tags	Definition
`url`	To match the request URL, you can use the ‘regex:’ prefix to use regex match (optional)
`methods`	To match request methods, you can use commas to separate multiple method matches (optional)
`headers`	To match request headers, match each child element (child element name is header name), you can use ‘regex:’ prefix to use regex match (optional)
`handler`	The request handler
`empty_query_string`	Check that there is no query string in the URL

handler contains the following settings, which can be configured by sub-tags:

Sub-tags	Definition
`url`	A location for redirect
`type`	Supported types: static, dynamic_query_handler, predefined_query_handler, redirect
`status`	Use with static type, response status code
`query_param_name`	Use with dynamic_query_handler type, extracts and executes the value corresponding to the `<query_param_name>` value in HTTP request params
`query`	Use with predefined_query_handler type, executes query when the handler is called
`content_type`	Use with static type, response content-type
`response_content`	Use with static type, Response content sent to client, when using the prefix ‘file://’ or ‘config://’, find the content from the file or configuration send to client

Along with a list of rules, you can specify <defaults/> which specifies to enable all the default handlers. Example:

<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

Used to add headers to the response in an OPTIONS HTTP request. The OPTIONS method is used when making CORS preflight requests. For more information, see OPTIONS. Example:

<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

The page that is shown by default when you access the ClickHouse HTTP(s) server. The default value is “Ok.” (with a line feed at the end)

Default: "Ok.\n"

Example Opens https://tabix.io/ when accessing http://localhost: http_port.

<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 Reference

Data Types

Engines

Functions

Formats

Settings

System Tables

Data Lakes

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