Skip to content

Commit 9b7e41d

Browse files
authored
Divided into 3 tables
1 parent 8e376d7 commit 9b7e41d

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

explore-analyze/query-filter/languages/esql-rest.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,23 +64,41 @@ POST /_query?format=txt
6464
The URL parameter takes precedence over the HTTP headers. If neither is specified then the response is returned in the same format as the request.
6565
::::
6666

67+
#### Structured formats
68+
69+
Complete responses with metadata. Useful for automatic parsing.
6770

6871
| `format` | HTTP header | Description |
6972
| --- | --- | --- |
7073
| Structured | | _Complete response with metadata_ |
7174
| `json` | `application/json` | [JSON](https://www.json.org/) (JavaScript Object Notation) human-readable format |
7275
| `yaml` | `application/yaml` | [YAML](https://en.wikipedia.org/wiki/YAML) (YAML Ain’t Markup Language) human-readable format |
76+
77+
#### Tabular formats
78+
79+
Query results only, without metadata. Useful for quick and manual data previews.
80+
81+
| `format` | HTTP header | Description |
82+
| --- | --- | --- |
7383
| Tabular | | _Query results only, no metadata_ |
7484
| `csv` | `text/csv` | [Comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values) |
7585
| `tsv` | `text/tab-separated-values` | [Tab-separated values](https://en.wikipedia.org/wiki/Tab-separated_values) |
7686
| `txt` | `text/plain` | CLI-like representation |
77-
| Binary | | _Compact binary encoding_ |
87+
88+
::::{tip}
89+
The `csv` format accepts a formatting URL query attribute, `delimiter`, which indicates which character should be used to separate the CSV values. It defaults to comma (`,`) and cannot take any of the following values: double quote (`"`), carriage-return (`\r`) and new-line (`\n`). The tab (`\t`) can also not be used. Use the `tsv` format instead.
90+
::::
91+
92+
#### Binary formats
93+
94+
Compact binary encoding. To be used by applications.
95+
96+
| `format` | HTTP header | Description |
97+
| --- | --- | --- |
7898
| `cbor` | `application/cbor` | [Concise Binary Object Representation](https://cbor.io/) |
7999
| `smile` | `application/smile` | [Smile](https://en.wikipedia.org/wiki/Smile_(data_interchange_format)) binary data format similarto CBOR |
80100
| `arrow` | `application/vnd.apache.arrow.stream` | **Experimental.** [Apache Arrow](https://arrow.apache.org/) dataframes, [IPC streaming format](https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format) |
81101

82-
The `csv` format accepts a formatting URL query attribute, `delimiter`, which indicates which character should be used to separate the CSV values. It defaults to comma (`,`) and cannot take any of the following values: double quote (`"`), carriage-return (`\r`) and new-line (`\n`). The tab (`\t`) can also not be used. Use the `tsv` format instead.
83-
84102

85103
### Filtering using {{es}} Query DSL [esql-rest-filtering]
86104

0 commit comments

Comments
 (0)