Skip to content

ESQL: Update text formats documentation #2307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 30, 2025
Merged

ESQL: Update text formats documentation #2307

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9b9e6a0
ESQL: Update text formats documentation
ivancea Jul 29, 2025
8e376d7
Moved tip to table description column
ivancea Jul 29, 2025
9b7e41d
Divided into 3 tables
ivancea Jul 29, 2025
f5293c0
Added async headers info
ivancea Jul 29, 2025
88a63b1
Add a format explicit example
ivancea Jul 29, 2025
40ad777
Merge branch 'main' into ivancea-esql-text-formats
ivancea Jul 29, 2025
72b0a18
Merge branch 'main' into ivancea-esql-text-formats
ivancea Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions explore-analyze/query-filter/languages/esql-rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,21 @@ POST /_query?format=txt
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.
::::

::::{tip}
In the "Tabular" formats, only the resulting data will be returned. Other response fields will be missing.
Use them when you want a quick view of the results.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads a bit weird to me; looking for suggestions

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine with me. And lines up with my feelings about that format. Great for seeing the results in a dense way as a human being. CSV may even be good out of curl too. But "applications" should use json.

::::


| `format` | HTTP header | Description |
| --- | --- | --- |
| Human readable |
| `csv` | `text/csv` | [Comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values) |
| Structured |
| `json` | `application/json` | [JSON](https://www.json.org/) (JavaScript Object Notation) human-readable format |
| `yaml` | `application/yaml` | [YAML](https://en.wikipedia.org/wiki/YAML) (YAML Ain’t Markup Language) human-readable format |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `yaml` | `application/yaml` | [YAML](https://en.wikipedia.org/wiki/YAML) (YAML Ain’t Markup Language) human-readable format |
| `yaml` | `application/yaml` | [YAML](https://en.wikipedia.org/wiki/YAML) human-readable format |

nit: not sure if it's useful to provide the recursive acronym 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also don't think it adds much, but we have it in every other format, so I'd say to keep it, even if just for normalization and flavor 👀

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nothing wrong with a bit of flavor 🫡

| Tabular |
| `csv` | `text/csv` | [Comma-separated values](https://en.wikipedia.org/wiki/Comma-separated_values) |
| `tsv` | `text/tab-separated-values` | [Tab-separated values](https://en.wikipedia.org/wiki/Tab-separated_values) |
| `txt` | `text/plain` | CLI-like representation |
| `yaml` | `application/yaml` | [YAML](https://en.wikipedia.org/wiki/YAML) (YAML Ain’t Markup Language) human-readable format |
| Binary |
| `cbor` | `application/cbor` | [Concise Binary Object Representation](https://cbor.io/) |
| `smile` | `application/smile` | [Smile](https://en.wikipedia.org/wiki/Smile_(data_interchange_format)) binary data format similarto CBOR |
Expand Down
Loading