JSONEachRowWithProgress - ClickHouse Documentation

输入	输出	别名
✗	✔

说明

与 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`	查询执行聚合且启用了 `rows_before_aggregation` 计数器时	`{"rows_before_aggregation":N}`
`exception`	查询失败时出现，仅限 HTTP 路径且设置了 `http_write_exception_in_output_format=1`	`{"exception":"..."}` — 错误文本以顶层字符串形式给出，而非嵌套在 `row` 下

只要查询包含 LIMIT，即使该限制并未丢弃任何行，也会输出 rows_before_limit_at_least 对象。它表示不使用 LIMIT 时本应返回的行数的下限估计 (含义与 JSON 格式中相同) ；客户端不得将其视为有行被丢弃的依据。 meta 会在第一个 row 之前输出一次，但 progress 对象可能先于 meta 到达。仅当在 HTTP 路径上设置了 http_write_exception_in_output_format=1 时，才会输出顶层 exception 对象；否则错误将通过传输层报告。该对象输出时是一个独立的顶层对象，而非嵌套在 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): ..."}

格式设置