客户端数据包
| 值 | 名称 | 描述 |
|---|---|---|
| 0 | Hello | 客户端握手开始 |
| 1 | Query | 查询请求 |
| 2 | Data | 带有数据的数据块 |
| 3 | Cancel | 取消查询 |
| 4 | Ping | Ping 请求 |
| 5 | TableStatus | 表状态请求 |
Data 可以被压缩。
Hello
例如，我们是 Go Client v1.10，支持 54451 协议版本，并且想要连接到 default 数据库，使用 default 用户和 secret 密码。
| 字段 | 类型 | 值 | 描述 |
|---|---|---|---|
| client_name | String | "Go Client" | 客户端实现名称 |
| version_major | UVarInt | 1 | 客户端主版本 |
| version_minor | UVarInt | 10 | 客户端次版本 |
| protocol_version | UVarInt | 54451 | TCP 协议版本 |
| database | String | "default" | 数据库名称 |
| username | String | "default" | 用户名 |
| password | String | "secret" | 密码 |
协议版本
协议版本是客户端的 TCP 协议版本。
通常它等于最新的兼容服务器修订版，但不应与服务器修订版混淆。
默认值
所有值都应显式设置，服务器端没有默认值。在客户端，使用 "default" 数据库，"default" 用户名和 ""（空字符串）密码作为默认值。
Query
| 字段 | 类型 | 值 | 描述 |
|---|---|---|---|
| query_id | String | 1ff-a123 | 查询 ID，可以是 UUIDv4 |
| client_info | ClientInfo | 参见类型 | 关于客户端的数据 |
| settings | 设置 | 参见类型 | 设置列表 |
| secret | String | secret | 服务器间密钥 |
| stage | UVarInt | 2 | 执行查询直到阶段 |
| compression | UVarInt | 0 | 禁用=0，启用=1 |
| body | String | SELECT 1 | 查询文本 |
客户端信息
| 字段 | 类型 | 描述 |
|---|---|---|
| query_kind | byte | 无=0，初始=1，二级=2 |
| initial_user | String | 初始用户 |
| initial_query_id | String | 初始查询 ID |
| initial_address | String | 初始地址 |
| initial_time | Int64 | 初始时间 |
| interface | byte | TCP=1, HTTP=2 |
| os_user | String | 操作系统用户 |
| client_hostname | String | 客户端主机名 |
| client_name | String | 客户端名称 |
| version_major | UVarInt | 客户端主版本 |
| version_minor | UVarInt | 客户端次版本 |
| protocol_version | UVarInt | 客户端协议版本 |
| quota_key | String | 配额密钥 |
| distributed_depth | UVarInt | 分布式深度 |
| version_patch | UVarInt | 客户端补丁版本 |
| otel | Bool | 存在追踪字段 |
| trace_id | FixedString(16) | 追踪 ID |
| span_id | FixedString(8) | Span ID |
| trace_state | String | 追踪状态 |
| trace_flags | Byte | 追踪标记 |
设置
| 字段 | 类型 | 值 | 描述 |
|---|---|---|---|
| key | String | send_logs_level | 设置的键 |
| 值 | String | trace | 设置的值 |
| important | Bool | true | 可以忽略或不忽略 |
编码为列表，空白键和值表示列表的结尾。
Stage
| 值 | 名称 | 描述 |
|---|---|---|
| 0 | FetchColumns | 仅获取列类型 |
| 1 | WithMergeableState | 直到可合并状态 |
| 2 | Complete | 直到完全完成（应该是默认值） |
Data
| 字段 | 类型 | 描述 |
|---|---|---|
| info | BlockInfo | 编码的数据块信息 |
| columns | UVarInt | 列计数 |
| rows | UVarInt | 行计数 |
| columns | []Column | 带有数据的列 |
Column
| 字段 | 类型 | 值 | 描述 |
|---|---|---|---|
| 名称 | String | foo | 列名 |
| 类型 | String | DateTime64(9) | 列类型 |
| data | bytes | ~ | 列数据 |
Cancel
没有数据包主体。服务器应取消查询。
Ping
没有数据包主体。服务器应使用 pong 响应。