Skip to content

Allow sending format with esql.async_query_get #2987

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

Closed
wants to merge 1 commit into from
Closed

Allow sending format with esql.async_query_get #2987

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions elasticsearch/_sync/client/esql.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,14 @@ def async_query_get(
drop_null_columns: t.Optional[bool] = None,
error_trace: t.Optional[bool] = None,
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
format: t.Optional[
t.Union[
str,
t.Literal[
"arrow", "cbor", "csv", "json", "smile", "tsv", "txt", "yaml"
],
]
] = None,
human: t.Optional[bool] = None,
keep_alive: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
pretty: t.Optional[bool] = None,
Expand All @@ -273,6 +281,7 @@ def async_query_get(
will be removed from the `columns` and `values` portion of the results. If
`true`, the response will include an extra section under the name `all_columns`
which has the name of all the columns.
:param format: A short version of the Accept header, for example `json` or `yaml`.
:param keep_alive: The period for which the query and its results are stored
in the cluster. When this period expires, the query and its results are deleted,
even if the query is still ongoing.
Expand All @@ -295,6 +304,8 @@ def async_query_get(
__query["filter_path"] = filter_path
if human is not None:
__query["human"] = human
if format is not None:
__query["format"] = format
if keep_alive is not None:
__query["keep_alive"] = keep_alive
if pretty is not None:
Expand Down