From 237f6dbe92ca00c75a124ba5c6a7c83cfc33fb37 Mon Sep 17 00:00:00 2001 From: Stanislav Malyshev Date: Thu, 3 Apr 2025 20:46:16 -0600 Subject: [PATCH 1/2] Update ESQL CCS docs for new allow_partial_results handling --- docs/reference/esql/esql-across-clusters.asciidoc | 12 ++++-------- docs/reference/esql/esql-query-api.asciidoc | 5 +++-- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/reference/esql/esql-across-clusters.asciidoc b/docs/reference/esql/esql-across-clusters.asciidoc index f607f804549f3..7a95d7536cda9 100644 --- a/docs/reference/esql/esql-across-clusters.asciidoc +++ b/docs/reference/esql/esql-across-clusters.asciidoc @@ -145,7 +145,7 @@ Once the security model is configured, you can add remote clusters. include::{es-ref-dir}/search/search-your-data/search-across-clusters.asciidoc[tag=ccs-remote-cluster-setup] <1> Since `skip_unavailable` was not set on `cluster_three`, it uses -the default of `false`. See the <> +the default of `true`. See the <> section for details. [discrete] @@ -283,7 +283,7 @@ searches are currently in that state. The clusters can have one of the following *successful* (searches on all shards were successful), *skipped* (the search failed on a cluster marked with `skip_unavailable`=`true`), *failed* (the search failed on a cluster marked with `skip_unavailable`=`false`) or **partial** (the search was -<> before finishing). +<> before finishing or has partially failed). <3> The `_clusters/details` section shows metadata about the search on each cluster. <4> If you included indices from the local cluster you sent the request to in your {ccs}, it is identified as "(local)". @@ -525,12 +525,8 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001 [[ccq-skip-unavailable-clusters]] ==== Optional remote clusters -{ccs-cap} for {esql} currently does not respect the `skip_unavailable` -setting. As a result, if a remote cluster specified in the request is -unavailable or failed, {ccs} for {esql} queries will fail regardless of the setting. - -We are actively working to align the behavior of {ccs} for {esql} with other -{ccs} APIs. +{ccs-cap} for {esql} will ignore the remote cluster which is disconnected from the querying cluster unless its +`skip_unavailable` setting is set to `false`, in which case the query will fail. [discrete] [[ccq-during-upgrade]] diff --git a/docs/reference/esql/esql-query-api.asciidoc b/docs/reference/esql/esql-query-api.asciidoc index e8180209073c3..ed72371de009f 100644 --- a/docs/reference/esql/esql-query-api.asciidoc +++ b/docs/reference/esql/esql-query-api.asciidoc @@ -65,8 +65,9 @@ precedence. `allow_partial_results`:: (Optional, boolean) If `true`, partial results will be returned if there are shard failures, but -the query can continue to execute on other clusters and shards. This defaults to the value of -the cluster setting `esql.query.allow_partial_results`. +the query can continue to execute on other clusters and shards. This defaults to `true`, unless +the cluster setting `esql.query.allow_partial_results` is set to `false`, in which case it also +defaults to `false`. [discrete] [role="child_attributes"] From 131864a8217b6f39cac3e3f449ecce49c0d7ee39 Mon Sep 17 00:00:00 2001 From: Stanislav Malyshev Date: Thu, 3 Apr 2025 20:50:25 -0600 Subject: [PATCH 2/2] better wording --- docs/reference/esql/esql-across-clusters.asciidoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reference/esql/esql-across-clusters.asciidoc b/docs/reference/esql/esql-across-clusters.asciidoc index 7a95d7536cda9..8fff0800de591 100644 --- a/docs/reference/esql/esql-across-clusters.asciidoc +++ b/docs/reference/esql/esql-across-clusters.asciidoc @@ -525,8 +525,9 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001 [[ccq-skip-unavailable-clusters]] ==== Optional remote clusters -{ccs-cap} for {esql} will ignore the remote cluster which is disconnected from the querying cluster unless its -`skip_unavailable` setting is set to `false`, in which case the query will fail. +{ccs-cap} for {esql} will set the remote cluster which is disconnected from the querying cluster to `skipped` +and continue the query with other clusters, unless the cluster's `skip_unavailable` setting is set to `false`, +in which case the query will fail. [discrete] [[ccq-during-upgrade]]