[API] Adds :drop_null_columns boolean parameter to esql APIs

elastic · Jan 18, 2024 · 074a8eb · 074a8eb
1 parent 4f2f588
commit 074a8eb
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb
@@ -30,6 +30,7 @@ module Actions
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format.
+        # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Use the `query` element to start a query. Use `columnar` to format the answer. (*Required*)
         #

diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb
@@ -27,6 +27,7 @@ module Actions
         # @option arguments [String] :id The async query ID
         # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response
         # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available
+        # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
         # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-get-api.html

diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb
@@ -30,6 +30,7 @@ module Actions
         #
         # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
         # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format.
+        # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body Use the `query` element to start a query. Use `columnar` to format the answer. (*Required*)
         #