Skip to content

Commit 9b9e6a0

Browse files
authored
ESQL: Update text formats documentation
1 parent e204e97 commit 9b9e6a0

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

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

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,21 @@ 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+
::::{tip}
68+
In the "Tabular" formats, only the resulting data will be returned. Other response fields will be missing.
69+
Use them when you want a quick view of the results.
70+
::::
71+
6772

6873
| `format` | HTTP header | Description |
6974
| --- | --- | --- |
70-
| Human readable |
71-
| `csv` | `text/csv` | [Comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values) |
75+
| Structured |
7276
| `json` | `application/json` | [JSON](https://www.json.org/) (JavaScript Object Notation) human-readable format |
77+
| `yaml` | `application/yaml` | [YAML](https://en.wikipedia.org/wiki/YAML) (YAML Ain’t Markup Language) human-readable format |
78+
| Tabular |
79+
| `csv` | `text/csv` | [Comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values) |
7380
| `tsv` | `text/tab-separated-values` | [Tab-separated values](https://en.wikipedia.org/wiki/Tab-separated_values) |
7481
| `txt` | `text/plain` | CLI-like representation |
75-
| `yaml` | `application/yaml` | [YAML](https://en.wikipedia.org/wiki/YAML) (YAML Ain’t Markup Language) human-readable format |
7682
| Binary |
7783
| `cbor` | `application/cbor` | [Concise Binary Object Representation](https://cbor.io/) |
7884
| `smile` | `application/smile` | [Smile](https://en.wikipedia.org/wiki/Smile_(data_interchange_format)) binary data format similarto CBOR |

0 commit comments

Comments
 (0)