Skip to content

Commit 53f74eb

Browse files
authored
Update ESQL CCS docs for new allow_partial_results handling (#126258)
* Update ESQL CCS docs for new allow_partial_results handling
1 parent 17c3f33 commit 53f74eb

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

docs/reference/esql/esql-across-clusters.asciidoc

+5-8
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Once the security model is configured, you can add remote clusters.
145145
include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-remote-cluster-setup]
146146

147147
<1> Since `skip_unavailable` was not set on `cluster_three`, it uses
148-
the default of `false`. See the <<ccq-skip-unavailable-clusters>>
148+
the default of `true`. See the <<ccq-skip-unavailable-clusters>>
149149
section for details.
150150

151151
[discrete]
@@ -283,7 +283,7 @@ searches are currently in that state. The clusters can have one of the following
283283
*successful* (searches on all shards were successful), *skipped* (the search
284284
failed on a cluster marked with `skip_unavailable`=`true`), *failed* (the search
285285
failed on a cluster marked with `skip_unavailable`=`false`) or **partial** (the search was
286-
<<esql-async-query-stop-api, interrupted>> before finishing).
286+
<<esql-async-query-stop-api, interrupted>> before finishing or has partially failed).
287287
<3> The `_clusters/details` section shows metadata about the search on each cluster.
288288
<4> If you included indices from the local cluster you sent the request to in your {ccs},
289289
it is identified as "(local)".
@@ -525,12 +525,9 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001
525525
[[ccq-skip-unavailable-clusters]]
526526
==== Optional remote clusters
527527

528-
{ccs-cap} for {esql} currently does not respect the `skip_unavailable`
529-
setting. As a result, if a remote cluster specified in the request is
530-
unavailable or failed, {ccs} for {esql} queries will fail regardless of the setting.
531-
532-
We are actively working to align the behavior of {ccs} for {esql} with other
533-
{ccs} APIs.
528+
{ccs-cap} for {esql} will set the remote cluster which is disconnected from the querying cluster to `skipped`
529+
and continue the query with other clusters, unless the cluster's `skip_unavailable` setting is set to `false`,
530+
in which case the query will fail.
534531

535532
[discrete]
536533
[[ccq-during-upgrade]]

docs/reference/esql/esql-query-api.asciidoc

+3-2
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,9 @@ precedence.
6565

6666
`allow_partial_results`::
6767
(Optional, boolean) If `true`, partial results will be returned if there are shard failures, but
68-
the query can continue to execute on other clusters and shards. This defaults to the value of
69-
the cluster setting `esql.query.allow_partial_results`.
68+
the query can continue to execute on other clusters and shards. This defaults to `true`, unless
69+
the cluster setting `esql.query.allow_partial_results` is set to `false`, in which case it also
70+
defaults to `false`.
7071

7172
[discrete]
7273
[role="child_attributes"]

0 commit comments

Comments
 (0)