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 支持在查询运行期间显示进度、查询取消和结果流。它有一个秘密功能，可以显示查询管道的图表和图形。

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 查询，有三种选择：

将请求作为 URL 'query' 参数发送
使用 POST 方法。
在 'query' 参数中发送查询的开头，其余部分使用 POST

备注

默认情况下，URL 的大小限制为 1 MiB，这可以通过 http_max_uri_size 设置进行更改。

如果成功，您将收到 200 响应代码和结果在响应体中。如果发生错误，您将收到 500 响应代码和响应体中的错误描述文本。

使用 GET 的请求是“只读”的。这意味着对于修改数据的查询，您只能使用 POST 方法。您可以在 POST 主体中或在 URL 参数中发送查询本身。让我们看一些示例。

在下面的示例中，使用 curl 发送查询 SELECT 1。请注意对空格使用 URL 编码：%20。

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

在这个示例中，使用 wget 和 -nv（非详细）和 -O- 参数将结果输出到终端。在这种情况下，没有必要对空格进行 URL 编码：

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

在这个示例中，我们通过 netcat 管道传递原始 HTTP 请求：

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

HTTP/1.0 200 OK
Date: Wed, 27 Nov 2019 10:30:18 GMT
Connection: Close
Content-Type: text/tab-separated-values; charset=UTF-8
X-ClickHouse-Server-Display-Name: clickhouse.ru-central1.internal
X-ClickHouse-Query-Id: 5abe861c-239c-467f-b955-8a201abb8b7f
X-ClickHouse-Summary: {"read_rows":"0","read_bytes":"0","written_rows":"0","written_bytes":"0","total_rows_to_read":"0","elapsed_ns":"662334"}

1

如您所见，curl 命令有点不方便，因为必须对空格进行 URL 转义。虽然 wget 自动转义所有内容，但我们不推荐使用它，因为在使用 keep-alive 和 Transfer-Encoding: chunked 时，它在 HTTP 1.1 上工作不佳。

$ 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 中，则在这两个数据部分之间会插入换行符。例如，这样是行不通的：

$ 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
    }
}

您可以使用 default_format URL 参数或 X-ClickHouse-Format 头指定除 TabSeparated 外的默认格式。

$ 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 查询需要使用 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 压缩。ClickHouse 支持以下压缩方法：

gzip
br
deflate
xz
zstd
lz4
bz2
snappy

要发送压缩的 POST 请求，请在请求头中附加 Content-Encoding: compression_method。

为了让 ClickHouse 压缩响应，请使用 enable_http_compression 设置启用压缩，并在请求中附加 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。或者，您可以在表名之前始终指定数据库。

身份验证

用户名和密码可以通过以下三种方式之一指定：

使用 HTTP 基本身份验证。

例如：

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 会话

您还可以在 HTTP 协议中使用 ClickHouse 会话。为此，您需要在请求中添加 session_id GET 参数。可以使用任何字符串作为会话 ID。

默认情况下，若 60 秒内无活动，则会话将终止。要更改此超时（以秒为单位），请在服务器配置中修改 default_session_timeout 设置，或在请求中添加 session_timeout GET 参数。

要检查会话状态，请使用 session_check=1 参数。在单个会话中只能执行一个查询。

您可以在 X-ClickHouse-Progress 响应头中接收有关查询进度的信息。为此，请启用 send_progress_in_http_headers。

以下是头部序列的示例：

X-ClickHouse-Progress: {"read_rows":"2752512","read_bytes":"240570816","total_rows_to_read":"8880128","elapsed_ns":"662334"}
X-ClickHouse-Progress: {"read_rows":"5439488","read_bytes":"482285394","total_rows_to_read":"8880128","elapsed_ns":"992334"}
X-ClickHouse-Progress: {"read_rows":"8783786","read_bytes":"819092887","total_rows_to_read":"8880128","elapsed_ns":"1232334"}

可能的头字段包括：

头字段	描述
`read_rows`	读取的行数。
`read_bytes`	读取的数据量（以字节为单位）。
`total_rows_to_read`	总共要读取的行数。
`written_rows`	写入的行数。
`written_bytes`	写入的数据量（以字节为单位）。

如果 HTTP 连接丢失，正在运行的请求不会自动停止。解析和数据格式化在服务器端执行，使用网络可能效率不高。

以下是一些可选参数：

参数	描述
`query_id`（可选）	可以作为查询 ID（任何字符串）传递。`replace_running_query`
`quota_key`（可选）	可以作为配额键（任何字符串）传递。"配额"

HTTP 接口允许传递外部数据（外部临时表）进行查询处理。有关更多信息，请参见 "查询处理的外部数据"。

响应缓冲

可以在服务器端启用响应缓冲。为此提供以下 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 主体。

带参数的查询

您可以创建带有参数的查询，并将值通过相应的 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 参数中的制表符

查询参数以“转义”格式解析。这带来了某些好处，例如可以明确将 null 解析为 \N。这意味着制表符字符应编码为 \t（或 \ 和制表符）。例如，以下内容在 abc 和 123 之间包含一个实际的制表符，输入字符串被拆分为两个值：

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 还支持预定义 HTTP 接口，帮助您更轻松地与第三方工具集成，如 Prometheus exporter。让我们看一个示例。

首先，将此部分添加到您的服务器配置文件中。

http_handlers 被配置为包含多个 rule。ClickHouse 将收到的 HTTP 请求与 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>

现在您可以直接请求该 URL，以获取 Prometheus 格式的数据：

$ 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"}
<

# 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 的定义。这是一个可选配置。如果在配置文件中未定义，则不匹配 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 — 与任何类型一起使用，响应头部映射。也可以用于设置内容类型。
- response_content — 与 static 类型一起使用，发送到客户端的响应内容，当使用前缀 'file://' 或 'config://' 时，从文件或配置中查找要发送给客户端的内容。
- user - 执行查询的用户（默认用户为 default）。注意，您不需要为该用户指定密码。

不同 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 设置的值，然后查询系统表以检查这些设置是否成功设置。

备注

要保留默认 handlers，如 query、play、ping，请添加 <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

备注

在一个 predefined_query_handler 中仅支持一个 query。

dynamic_query_handler

在 dynamic_query_handler 中，查询以 HTTP 请求的参数形式编写。不同之处在于，在 predefined_query_handler 中，查询是在配置文件中编写的。query_param_name 可以在 dynamic_query_handler 中配置。

ClickHouse 将提取并执行 URL 中 query_param_name 值对应的值。query_param_name 的默认值为 /query。这是一个可选配置。如果在配置文件中没有定义，则不会传递该参数。

要实验此功能，以下示例定义了 max_threads 和 max_final_threads 和 queries 的值，以检查这些设置是否成功设置。

示例：

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

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"}
<
* 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"}
<
* 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"}
<
<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"}
<
<html><body>Relative Path File</body></html>
* Connection #0 to host localhost left intact

redirect

redirect 将进行 302 重定向到 location

例如，您可以自动将用户添加到 ClickHouse play 的 play：

<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 响应中都会包含这些头。

在下面的示例中，所有服务器响应将包含两个自定义头： 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 （默认启用），指示 ClickHouse 在指定格式中写入异常（当前支持 XML 和 JSON* 格式）。

示例：

$ 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 插入查询​

示例​

压缩​

示例​

默认数据库​

身份验证​

在 HTTP 协议中使用 ClickHouse 会话​

响应缓冲​

使用查询参数设置角色​

HTTP 响应代码注意事项​

带参数的查询​

示例​

URL 参数中的制表符​

预定义 HTTP 接口​

predefined_query_handler​

dynamic_query_handler​

static​

redirect​

HTTP 响应头​

在 HTTP 流式传输期间出现异常时的有效 JSON/XML 响应​