[API] Updates esql query APIs, adds allow_partial_results parameter

picandocodigo · picandocodigo · commit 59e376837a23 · 2025-06-02T12:49:34.000+01:00
diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb
@@ -27,6 +27,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 [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the entire query will fail if there are any failures.
         # @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/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb
@@ -27,6 +27,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 [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the entire query will fail if there are any failures.
         # @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*)
         #

Original file line number	Diff line number	Diff line change
`@@ -27,6 +27,7 @@ module Actions`
`27`	`27`	`# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml`
`28`	`28`	`# @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format.`
`29`	`29`	# @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.
	`30`	+ # @option arguments [Boolean] :allow_partial_results If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the entire query will fail if there are any failures.
`30`	`31`	`# @option arguments [Hash] :headers Custom HTTP headers`
`31`	`32`	# @option arguments [Hash] :body Use the `query` element to start a query. Use `columnar` to format the answer. (Required)
`32`	`33`	`#`