跳到主要内容
跳到主要内容

gRPC接口

介绍

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

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

接口的规范描述在clickhouse_grpc.proto

gRPC配置

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

内置客户端

您可以使用提供的规范在任何支持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文件加载数据。然后对表的内容进行查询。

结果: