Expand description
ES|QL responses and the sync/async /_query runners.
Structs§
- Esql
Column - Esql
Response - Row-major
values: one array of cells per row.columnarresponses are transposed into this shape bydecode_columnarso callers always see rows.
Functions§
- decode
- Strict decode of a row-major
POST /_queryresponse. Unknown fields are accepted; a missing or mistypedcolumns/valuesis an error, never an empty result. - decode_
columnar - Strict decode of a column-major (
columnar: true) response.valuesholds one array per column, each the length of the row count; the result is transposed into the row-majorEsqlResponseshape. - poll_
until_ complete - Poll
GET /_query/async/{id}until it reports completion, cleaning up on every exit path.max_polls * intervalbounds the wait;run_asyncpasses a bulk-export-sized budget, while tests pass a tiny one. - run_
async - Run a query through the async API and poll until complete. ES|QL has no
page-by-page cursor; the full result returns in one response.
columnar: truekeeps the payload and memory footprint low. - run_
sync - Run a synchronous ES|QL query.
querycarries its ownFROMandLIMIT.