From 87c5d9372baa1440f713f74d493af1faef10fcc4 Mon Sep 17 00:00:00 2001
From: jetn-ttc <jetn@thetechcollective.eu>
Date: Fri, 20 Jun 2025 13:42:30 +0200
Subject: [PATCH] Allow sending format with esql.async_query_get

The format of received async queries is determined by the async_query_get call, not the async_query (unless it returns immediately).
This change allows one to send the format specifier whenever useful.
Note that sending format=arrow with a to small completion timeout results in an empty response and no way to get the ID.
A more useful strategy is therefore: async_query with no format (or JSON) to get the ID, and only then async_query_get with the received ID and format=arrow.
---
 elasticsearch/_sync/client/esql.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/elasticsearch/_sync/client/esql.py b/elasticsearch/_sync/client/esql.py
index 0897feb54..601d9d095 100644
--- a/elasticsearch/_sync/client/esql.py
+++ b/elasticsearch/_sync/client/esql.py
@@ -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,
@@ -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.
@@ -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: