Skip to content

Commit 5afdc76

Browse files
jrodewigdnhatn
andauthored
Document partial search results with skip_unavailable (#84057) (#84300)
This commit adds an explanation for the relation between `allow_partial_search_results` and `skip_unavailable` in CCS requests. Relates to #33915 Closes #82407 Co-authored-by: James Rodewig <[email protected]> (cherry picked from commit 86964c9) Co-authored-by: Nhat Nguyen <[email protected]>
1 parent 68251d4 commit 5afdc76

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

docs/reference/cluster/remote-info.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@ by the configured remote cluster alias.
4141

4242
[[skip-unavailable]]
4343
`skip_unavailable`::
44-
Whether the remote cluster is skipped in case it is searched through
45-
a {ccs} request but none of its nodes are available.
44+
Whether a {ccs} skips the remote cluster if its nodes are unavailable during the
45+
search. If `true`, a {ccs} also ignores errors returned by the remote cluster.
46+
Refer to <<skip-unavailable-clusters>>.
4647

4748
`seeds`::
4849
Initial seed transport addresses of the remote cluster when sniff mode is

docs/reference/search/search-your-data/search-across-clusters.asciidoc

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -292,16 +292,29 @@ means the document came from the local cluster.
292292

293293
[discrete]
294294
[[skip-unavailable-clusters]]
295-
=== Skip unavailable clusters
295+
=== Optional remote clusters
296296

297-
By default, a {ccs} returns an error if *any* cluster in the request is
298-
unavailable.
297+
By default, a {ccs} fails if a remote cluster in the request returns an
298+
error or is unavailable. Use the `skip_unavailable` cluster
299+
setting to mark a specific remote cluster as optional for {ccs}.
299300

300-
To skip an unavailable cluster during a {ccs}, set the
301-
<<skip-unavailable,`skip_unavailable`>> cluster setting to `true`.
301+
If `skip_unavailable` is `true`, a {ccs}:
302302

303-
The following <<cluster-update-settings,cluster update settings>> API request
304-
changes `cluster_two`'s `skip_unavailable` setting to `true`.
303+
* Skips the remote cluster if its nodes are unavailable during the search. The
304+
response's `_cluster.skipped` value contains a count of any skipped clusters.
305+
306+
* Ignores errors returned by the remote cluster, such as errors related to
307+
unavailable shards or indices. This can include errors related to search
308+
parameters such as <<multi-index,`allow_no_indices`>> and
309+
<<multi-index,`ignore_unavailable`>>.
310+
311+
* Ignores the <<search-partial-responses,`allow_partial_search_results`>>
312+
parameter and the related `search.default_allow_partial_results` cluster setting
313+
when searching the remote cluster. This means searches on the remote cluster may
314+
return partial results.
315+
316+
The following <<cluster-update-settings,cluster update settings>>
317+
API request changes `cluster_two`'s `skip_unavailable` setting to `true`.
305318

306319
[source,console]
307320
--------------------------------

0 commit comments

Comments
 (0)