gRPC 接口

介绍

ClickHouse 支持 gRPC 接口。它是一个使用 HTTP/2 和 Protocol Buffers 的开源远程过程调用系统。ClickHouse 中 gRPC 的实现支持：

SSL；
身份验证；
会话；
压缩；
通过同一通道执行并行查询；
取消查询；
获取进度和日志；
外部表。

该接口的规范定义在 clickhouse_grpc.proto 中。

gRPC 配置

要使用 gRPC 接口，请在主服务器配置中设置 grpc_port。其他配置选项请参考以下示例：

<grpc_port>9100</grpc_port>
    <grpc>
        <enable_ssl>false</enable_ssl>

        <!-- The following two files are used only if SSL is enabled -->
        <ssl_cert_file>/path/to/ssl_cert_file</ssl_cert_file>
        <ssl_key_file>/path/to/ssl_key_file</ssl_key_file>

        <!-- Whether server requests client for a certificate -->
        <ssl_require_client_auth>false</ssl_require_client_auth>

        <!-- The following file is used only if ssl_require_client_auth=true -->
        <ssl_ca_cert_file>/path/to/ssl_ca_cert_file</ssl_ca_cert_file>

        <!-- Default compression algorithm (applied if client doesn't specify another algorithm, see result_compression in QueryInfo).
             Supported algorithms: none, deflate, gzip, stream_gzip -->
        <compression>deflate</compression>

        <!-- Default compression level (applied if client doesn't specify another level, see result_compression in QueryInfo).
             Supported levels: none, low, medium, high -->
        <compression_level>medium</compression_level>

        <!-- Send/receive message size limits in bytes. -1 means unlimited -->
        <max_send_message_size>-1</max_send_message_size>
        <max_receive_message_size>-1</max_receive_message_size>

        <!-- Enable if you want to get detailed logs -->
        <verbose_logs>false</verbose_logs>
    </grpc>

内置客户端

可以使用 gRPC 支持的任意编程语言，基于提供的规范编写客户端。也可以使用内置的 Python 客户端。它位于代码仓库中的 utils/grpc-client/clickhouse-grpc-client.py。内置客户端依赖 grpcio 和 grpcio-tools 这两个 Python 模块。

该客户端支持以下参数：

--help – 显示帮助信息并退出。
--host HOST, -h HOST – 服务器名称。默认值：localhost。也可以使用 IPv4 或 IPv6 地址。
--port PORT – 要连接的端口。该端口应在 ClickHouse 服务器配置中启用（参见 grpc_port）。默认值：9100。
--user USER_NAME, -u USER_NAME – 用户名。默认值：default。
--password PASSWORD – 密码。默认值：空字符串。
--query QUERY, -q QUERY – 在非交互模式下要执行的查询。
--database DATABASE, -d DATABASE – 默认数据库。如果未指定，则使用服务器设置中的当前数据库（默认是 default）。
--format OUTPUT_FORMAT, -f OUTPUT_FORMAT – 结果输出格式。交互模式下的默认值：PrettyCompact。
--debug – 启用调试信息输出。

要以交互模式运行客户端，请在调用时不带 --query 参数。

在批处理模式下，可以通过 stdin 传递查询数据。

客户端使用示例

在以下示例中，将创建一个表，并从一个 CSV 文件中加载数据。然后对该表的内容进行查询。

./clickhouse-grpc-client.py -q "CREATE TABLE grpc_example_table (id UInt32, text String) ENGINE = MergeTree() ORDER BY id;"
echo -e "0,Input data for\n1,gRPC protocol example" > a.csv
cat a.csv | ./clickhouse-grpc-client.py -q "INSERT INTO grpc_example_table FORMAT CSV"

./clickhouse-grpc-client.py --format PrettyCompact -q "SELECT * FROM grpc_example_table;"

结果：

┌─id─┬─text──────────────────┐
│  0 │ Input data for        │
│  1 │ gRPC protocol example │
└────┴───────────────────────┘

介绍​

gRPC 配置​

内置客户端​

介绍

gRPC 配置

内置客户端