Пакеты сервера

Сервер собственного протокола

значение	имя	описание
0	Hello	Ответ сервера при рукопожатии
1	Data	То же, что и данные клиента
2	Exception	Исключение при обработке запроса
3	Progress	Прогресс запроса
4	Pong	Ответ на Ping
5	EndOfStream	Все пакеты переданы
6	ProfileInfo	Данные профилирования
7	Totals	Итоговые значения
8	Extremes	Предельные значения (min, max)
9	TablesStatusResponse	Ответ на запрос TableStatus
10	Log	Системный журнал запроса
11	TableColumns	Описание столбцов
12	UUIDs	Список уникальных идентификаторов частей
13	ReadTaskRequest	Строка (UUID) описывает запрос, для которого нужна следующая задача
14	ProfileEvents	Пакет с событиями профилирования от сервера

Пакеты Data, Totals и Extremes могут быть сжаты.

​

Hello

Ответ на client hello.

поле	тип	значение	описание
name	String	Clickhouse	Имя сервера
version_major	UVarInt	21	Мажорная версия сервера
version_minor	UVarInt	12	Минорная версия сервера
revision	UVarInt	54452	Ревизия сервера
tz	String	Europe/Moscow	Часовой пояс сервера
display_name	String	Clickhouse	Имя сервера в интерфейсе
version_patch	UVarInt	3	Патч-версия сервера

​

Исключение

Исключение на сервере при обработке запроса.

поле	тип	значение	описание
code	Int32	60	См. ErrorCodes.cpp.
name	String	DB::Exception	Основная версия сервера
message	String	DB::Exception: Table X doesn't exist	Младшая версия сервера
stack_trace	String	~	Трассировка стека C++
nested	Bool	true	Дополнительные ошибки

Это может быть непрерывный список исключений, пока nested не равно false.

​

Прогресс

Прогресс выполнения запроса, о котором сервер периодически сообщает.

Прогресс передаётся дельтами. Чтобы получить итоговые значения, накапливайте их на клиенте.

поле	тип	значение	описание
rows	UVarInt	65535	Количество строк
bytes	UVarInt	871799	Количество байт
total_rows	UVarInt	0	Всего строк
wrote_rows	UVarInt	0	Строки от клиента
wrote_bytes	UVarInt	0	Байты от клиента

​

Pong

Ответ на Ping клиента, тело пакета отсутствует.

​

Конец потока

Пакеты Data больше не отправляются: результат запроса полностью передан с сервера клиенту.

Тело пакета отсутствует.

​

Информация о профиле

поле	тип
rows	UVarInt
blocks	UVarInt
bytes	UVarInt
applied_limit	Bool
rows_before_limit	UVarInt
calculated_rows_before_limit	Bool

​

Log

Блок данных с логом сервера.

Кодируется как блок данных, состоящий из столбцов, но никогда не сжимается.

столбец	тип
time	DateTime
time_micro	UInt32
host_name	String
query_id	String
thread_id	UInt64
priority	Int8
source	String
text	String

​

События профилирования

Блок данных со событиями профилирования.

Кодируется как блок данных, состоящий из столбцов, но никогда не сжимается.

Тип value — UInt64 или Int64 в зависимости от ревизии сервера.

столбец	тип
host_name	String
current_time	DateTime
thread_id	UInt64
type	Int8
name	String
value	UInt64 or Int64