habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
b140fcda7f1d0e35dcf6fe3658ffe536a133c979
elasticsearch-js/docs/reference/api/SqlQueryResponse.md
Josh Mock b140fcda7f Another round of tweaks
2025-05-28 10:02:30 -05:00

1.3 KiB
Raw Blame History

SqlQueryResponse [interface-SqlQueryResponse]

Name Type Description
columns SqlColumn[] Column headings for the search results. Each object is a column.
cursor string The cursor for the next set of paginated results. For CSV, TSV, and TXT responses, this value is returned in the Cursor HTTP header.
id Id The identifier for the search. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-ID HTTP header.
is_partial boolean If true, the response does not contain complete search results. If is_partial is true and is_running is true, the search is still running. If is_partial is true but is_running is false, the results are partial due to a failure or timeout. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.
is_running boolean If true, the search is still running. If false, the search has finished. This value is returned only for async and saved synchronous searches. For CSV, TSV, and TXT responses, this value is returned in the Async-partial HTTP header.
rows SqlRow[] The values for the search results.