Skip to content

Commit 31214cb

Browse files
committed
Improve skip_un description
1 parent 078a03c commit 31214cb

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

explore-analyze/query-filter/languages/esql-cross-clusters.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -470,10 +470,27 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001
470470

471471

472472
## Optional remote clusters [ccq-skip-unavailable-clusters]
473+
```{applies_to}
474+
stack: ga 9.1.0+
475+
```
476+
477+
If the remote cluster is configured with `skip_unavailable: true` (the default setting), the cluster would be set
478+
to `skipped` or `partial` status but the query will not fail, if:
479+
480+
* The remote cluster is disconnected from the querying cluster, either before or during the query.
481+
* The remote cluster does not have the requested index.
482+
* An error happened while processing the query on the remote cluster.
483+
484+
The `partial` status will be used if the remote query was partially successful and some data was returned.
473485

474-
If a remote cluster disconnects from the querying cluster, {{ccs}} for {{esql}} will set it to `skipped`
475-
and continue the query with other clusters, unless the remote cluster's `skip_unavailable` setting is set to `false`,
476-
in which case the query will fail.
486+
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,
487+
or all the indices in the query are missing. For example, the following queries will fail:
488+
489+
```esql
490+
FROM cluster_one:missing-index | LIMIT 10
491+
FROM cluster_one:missing-index* | LIMIT 10
492+
FROM cluster_one:missing-index*,cluster_two:missing-index | LIMIT 10
493+
```
477494

478495
## Query across clusters during an upgrade [ccq-during-upgrade]
479496

0 commit comments

Comments
 (0)