JSONEachRowWithProgress

Вход	Выход	Псевдоним
✗	✔

Описание

Отличается от JSONEachRow/JSONStringsEachRow тем, что ClickHouse передаёт в потоке каждое событие как отдельный объект JSON, а также выводит информацию о ходе выполнения. Родственный формат JSONStringsEachRowWithProgress использует те же виды объектов верхнего уровня, но значения полей сериализуются в виде строк. Компактные аналоги JSONCompactEachRowWithProgress и JSONCompactStringsEachRowWithProgress используют те же виды объектов потока и имеют те же особенности, связанные с ходом выполнения, LIMIT и исключениями; однако их полезные нагрузки row / totals / min / max представляют собой массивы значений, а не именованные объекты.

Объекты потока

Каждая строка ответа представляет собой один объект JSON. Клиенты должны выбирать способ обработки в зависимости от ключа верхнего уровня:

Ключ верхнего уровня	Когда появляется	Структура
`meta`	Один раз, перед первым объектом `row` (объект `progress` может быть отправлен раньше)	`{"meta":[{"name":...,"type":...}, ...]}` — имена и типы столбцов
`row`	Один раз для каждой строки результата	`{"row":{...}}` — значения столбцов этой строки
`progress`	Периодически во время выполнения запроса	`{"progress":{...}}` — счётчики, такие как `read_rows`, `read_bytes`, `total_rows_to_read`
`totals`	При наличии итогов	`{"totals":{...}}` — значения итоговой строки
`min` / `max`	При наличии экстремумов	`{"min":{...}}` / `{"max":{...}}` — значения строк с экстремумами
`rows_before_limit_at_least`	Когда запрос содержит `LIMIT`	`{"rows_before_limit_at_least":N}` — нижняя оценка числа строк, которые были бы получены без `LIMIT` (не свидетельствует о том, что строки были отброшены)
`rows_before_aggregation`	Когда запрос выполняет aggregation и включён счётчик `rows_before_aggregation`	`{"rows_before_aggregation":N}`
`exception`	При ошибке выполнения запроса по HTTP, если установлено `http_write_exception_in_output_format=1`	`{"exception":"..."}` — текст ошибки в виде строки верхнего уровня, а не внутри `row`

Объект rows_before_limit_at_least отправляется, когда запрос содержит LIMIT, даже если ограничение не отбросило ни одной строки. Это нижняя оценка числа строк, которые были бы получены без LIMIT (с тем же смыслом, что и в JSON); клиенты не должны считать её подтверждением того, что строки были отброшены. meta отправляется один раз перед первым объектом row, но объект progress может поступить раньше meta. Объект exception верхнего уровня отправляется по HTTP только при http_write_exception_in_output_format=1; в противном случае ошибка передаётся на транспортном уровне. Если этот объект отправляется, он представляет собой отдельный объект верхнего уровня, а не вложенный элемент row.

Пример использования

{"meta":[{"name":"num","type":"UInt8"},{"name":"str","type":"String"},{"name":"arr","type":"Array(UInt8)"}]}
{"row":{"num":42,"str":"hello","arr":[0,1]}}
{"row":{"num":43,"str":"hello","arr":[0,1,2]}}
{"row":{"num":44,"str":"hello","arr":[0,1,2,3]}}
{"progress":{"read_rows":"3","read_bytes":"24","written_rows":"0","written_bytes":"0","total_rows_to_read":"3"}}

Объект progress по-прежнему может выводиться перед meta. При работе по HTTP с http_write_exception_in_output_format=1 запрос, завершившийся ошибкой, заканчивается отдельным объектом верхнего уровня (не вложенным в row):

{"exception":"Code: 62. DB::Exception: Syntax error: failed at position 1 (SELECT) (line 1, col 1): ..."}

Справочник по SQL

Типы данных

Движки

Функции

Форматы

Настройки

Системные таблицы

Озера данных

Описание

Объекты потока

Пример использования

Настройки формата

​Описание

​Объекты потока

​Пример использования

​Настройки формата

Описание

Объекты потока

Пример использования

Настройки формата