JSONCompactEachRowWithProgress

Entrée	Sortie	Alias
✗	✔

Description

Combine la sortie compacte ligne par ligne de JSONCompactEachRow avec des informations de progression transmises en continu. ClickHouse transmet chaque événement sous la forme d’un objet JSON distinct ; les valeurs de colonne conservent leurs types JSON natifs. Le format apparenté JSONCompactStringsEachRowWithProgress utilise les mêmes kinds d’objets de premier niveau, mais les valeurs des champs y sont sérialisées sous forme de chaînes de caractères. Partage le même contrat de flux que JSONEachRowWithProgress (writesProgressConcurrently / finalizeImpl), à ceci près que les charges utiles row / totals / min / max sont des tableaux de valeurs ordonnées selon les colonnes, et non des objets nommés.

Objets du flux

Chaque ligne de la réponse est un objet JSON. Les clients doivent aiguiller le traitement en fonction de la clé de premier niveau :

Clé de premier niveau	Quand elle apparaît	Forme
`meta`	Une seule fois, avant le premier `row` (un objet `progress` peut être émis avant)	`{"meta":[{"name":...,"type":...}, ...]}` — noms et types des colonnes
`row`	Une fois par ligne de résultat	`{"row":[...]}` — valeurs des colonnes dans l’ordre de l’en-tête
`progress`	Périodiquement pendant l’exécution de la requête	`{"progress":{...}}` — compteurs tels que `read_rows`, `read_bytes`, `total_rows_to_read`
`totals`	Lorsque des totaux sont présents	`{"totals":[...]}` — valeurs de la ligne des totaux dans l’ordre de l’en-tête
`min` / `max`	Lorsque des valeurs extrêmes sont présentes	`{"min":[...]}` / `{"max":[...]}` — valeurs des lignes extrêmes dans l’ordre de l’en-tête
`rows_before_limit_at_least`	Lorsque la requête contient `LIMIT`	`{"rows_before_limit_at_least":N}` — estimation basse du nombre de lignes qu’il y aurait eu sans `LIMIT` (ne prouve pas que des lignes ont été écartées)
`rows_before_aggregation`	Lorsque la requête effectue une agrégation et que le compteur `rows_before_aggregation` est activé	`{"rows_before_aggregation":N}`
`exception`	Lorsque la requête échoue, via HTTP avec `http_write_exception_in_output_format=1`	`{"exception":"..."}` — texte de l’erreur sous forme de string de premier niveau, non imbriquée sous `row`

L’objet rows_before_limit_at_least est émis dès que la requête contient LIMIT, même si la limite n’a écarté aucune ligne. Il s’agit d’une estimation basse du nombre de lignes qu’il y aurait eu sans LIMIT (même signification que dans JSON) ; les clients ne doivent pas y voir la preuve que des lignes ont été écartées. meta est émis une seule fois, avant le premier row, mais un objet progress peut arriver avant meta. Via HTTP, l’objet exception de premier niveau n’est émis que si http_write_exception_in_output_format=1 ; sinon, l’erreur est remontée par la couche de transport. Lorsqu’il est émis, il s’agit d’un objet de premier niveau distinct, non imbriqué sous row.

Exemple d’utilisation

Query

SELECT *
FROM generateRandom('a Array(Int8), d Decimal32(4), c Tuple(DateTime64(3), UUID)', 1, 10, 2)
LIMIT 5
FORMAT JSONCompactEachRowWithProgress

Response

{"meta":[{"name":"a","type":"Array(Int8)"},{"name":"d","type":"Decimal(9, 4)"},{"name":"c","type":"Tuple(DateTime64(3), UUID)"}]}
{"row":[[-8], 46848.5225, ["2064-06-11 14:00:36.578","b06f4fa1-22ff-f84f-a1b7-a5807d983ae6"]]}
{"row":[[-76], -85331.598, ["2038-06-16 04:10:27.271","2bb0de60-3a2c-ffc0-d7a7-a5c88ed8177c"]]}
{"row":[[-32], -31470.8994, ["2027-07-18 16:58:34.654","1cdbae4c-ceb2-1337-b954-b175f5efbef8"]]}
{"row":[[-116], 32104.097, ["1979-04-27 21:51:53.321","66903704-3c83-8f8a-648a-da4ac1ffa9fc"]]}
{"row":[[], 2427.6614, ["1980-04-24 11:30:35.487","fee19be8-0f46-149b-ed98-43e7455ce2b2"]]}
{"progress":{"read_rows":"5","read_bytes":"184","total_rows_to_read":"5","elapsed_ns":"335771"}}
{"rows_before_limit_at_least":5}

Référence SQL

Types de données

Moteurs

Fonctions

Formats

Paramètres

Tables système

Lacs de données

Description

Objets du flux

Exemple d’utilisation

Paramètres de format

​Description

​Objets du flux

​Exemple d’utilisation

​Paramètres de format

Description

Objets du flux

Exemple d’utilisation

Paramètres de format