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

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 文件加载数据。然后查询表的内容。

结果: