Skip to content

Commit dc7beff

Browse files
authored
Better description of skip-un funciton in 8.19 (#130043)
* Better description of skip-un function in 8.19
1 parent 7269d35 commit dc7beff

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

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

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -523,9 +523,24 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001
523523
[[ccq-skip-unavailable-clusters]]
524524
==== Optional remote clusters
525525

526-
{ccs-cap} for {esql} will set the remote cluster which is disconnected from the querying cluster to `skipped`
527-
and continue the query with other clusters, unless the cluster's `skip_unavailable` setting is set to `false`,
528-
in which case the query will fail.
526+
If the remote cluster is configured with `skip_unavailable: true` (the default setting), the cluster would be set
527+
to `skipped` or `partial` status but the query will not fail, if:
528+
529+
* The remote cluster is disconnected from the querying cluster, either before or during the query.
530+
* The remote cluster does not have the requested index.
531+
* An error happened while processing the query on the remote cluster.
532+
533+
The `partial` status will be used if the remote query was partially successful and some data was returned.
534+
535+
This however does not apply to the situation when the remote cluster is missing an index and this is the only index in the query,
536+
or all the indices in the query are missing. For example, the following queries will fail:
537+
538+
[source,esql]
539+
----
540+
FROM cluster_one:missing-index | LIMIT 10
541+
FROM cluster_one:missing-index* | LIMIT 10
542+
FROM cluster_one:missing-index*,cluster_two:missing-index | LIMIT 10
543+
----
529544

530545
[discrete]
531546
[[ccq-during-upgrade]]

0 commit comments

Comments
 (0)