Пакеты клиента
| value | name | description |
|---|---|---|
| 0 | Hello | Начало рукопожатия клиента |
| 1 | Query | Запрос |
| 2 | Data | Блок с данными |
| 3 | Cancel | Отмена запроса |
| 4 | Ping | Ping-запрос |
| 5 | TableStatus | Запрос статуса таблицы |
Пакет Data может быть сжат.
Hello
Например, у нас есть Go Client v1.10, который поддерживает версию протокола 54451 и
мы хотим подключиться к базе данных default с пользователем default и паролем secret.
| field | type | value | description |
|---|---|---|---|
| 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" | Пароль |
Protocol version
Версия протокола — это версия TCP-протокола клиента.
Обычно она равна последней совместимой ревизии сервера, но её не следует с ней путать.
Defaults
Все значения должны быть явно заданы, на стороне сервера нет значений по умолчанию.
На стороне клиента используйте "default" как имя базы данных, "default" как имя пользователя и "" (пустую строку)
как пароль по умолчанию.
Запрос
| field | type | value | description |
|---|---|---|---|
| query_id | String | 1ff-a123 | Идентификатор запроса, может быть UUIDv4 |
| client_info | ClientInfo | See type | Данные о клиенте |
| settings | Settings | See type | Список настроек |
| secret | String | secret | Межсерверный секрет |
| stage | UVarInt | 2 | Выполнять до стадии обработки запроса |
| compression | UVarInt | 0 | 0 — отключено, 1 — включено |
| body | String | SELECT 1 | Текст запроса |
Информация о клиенте
| field | type | description |
|---|---|---|
| query_kind | byte | None=0, Initial=1, Secondary=2 |
| initial_user | String | Исходный пользователь |
| initial_query_id | String | Исходный идентификатор запроса |
| 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) | Идентификатор трассы |
| span_id | FixedString(8) | Идентификатор спана |
| trace_state | String | Состояние трассировки |
| trace_flags | Byte | Флаги трассировки |
Настройки
| field | type | value | description |
|---|---|---|---|
| key | String | send_logs_level | Ключ настройки |
| value | String | trace | Значение настройки |
| important | Bool | true | Можно ли игнорировать настройку |
Кодируется в виде списка; пустые key и value обозначают конец списка.
Стадия
| value | name | description |
|---|---|---|
| 0 | FetchColumns | Только получить типы столбцов |
| 1 | WithMergeableState | До состояния, пригодного для слияния |
| 2 | Complete | До полной завершённости (должно быть значением по умолчанию) |
Данные
| field | type | description |
|---|---|---|
| info | BlockInfo | Закодированная информация блока |
| columns | UVarInt | Количество столбцов |
| rows | UVarInt | Количество строк |
| columns | []Column | Столбцы с данными |
Столбец
| field | type | value | description |
|---|---|---|---|
| name | String | foo | Имя столбца |
| type | String | DateTime64(9) | Тип столбца |
| data | bytes | ~ | Данные столбца |
Cancel
Тело пакета отсутствует. Сервер должен отменить запрос.
Ping
Не содержит тела пакета. Сервер должен ответить сообщением pong.
