Skip to content

Commit 0eefd1a

Browse files
[ESQL] Improve skip_unavailable description in CCS doc (#1919)
Improve the description to match 9.1 GA semantics --------- Co-authored-by: Liam Thompson <[email protected]>
1 parent 5c81765 commit 0eefd1a

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

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

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,11 +469,38 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001
469469
```
470470

471471

472-
## Optional remote clusters [ccq-skip-unavailable-clusters]
472+
## Skipping problematic remote clusters [ccq-skip-unavailable-clusters]
473473

474+
{{ccs-cap}} for {{esql}} behavior when there are problems connecting to or running query on remote clusters differs between versions.
475+
476+
::::{tab-set}
477+
478+
:::{tab-item} 9.1
479+
Remote clusters are configured with the `skip_unavailable: true` setting by default. With this setting, clusters are marked as `skipped` or `partial` rather than causing queries to fail in the following scenarios:
480+
481+
* The remote cluster is disconnected from the querying cluster, either before or during the query execution.
482+
* The remote cluster does not have the requested index, or it is not accessible due to security settings.
483+
* An error happened while processing the query on the remote cluster.
484+
485+
The `partial` status means the remote query either has errors or was interrupted by an explicit user action, but some data may be returned.
486+
487+
Queries will still fail when `skip_unavailable` is set `true`, if none of the specified indices exist. For example, the
488+
following queries will fail:
489+
490+
```esql
491+
FROM cluster_one:missing-index | LIMIT 10
492+
FROM cluster_one:missing-index* | LIMIT 10
493+
FROM cluster_one:missing-index*,cluster_two:missing-index | LIMIT 10
494+
```
495+
:::
496+
497+
:::{tab-item} 9.0
474498
If a remote cluster disconnects from the querying cluster, {{ccs}} for {{esql}} will set it to `skipped`
475499
and continue the query with other clusters, unless the remote cluster's `skip_unavailable` setting is set to `false`,
476500
in which case the query will fail.
501+
:::
502+
503+
::::
477504

478505
## Query across clusters during an upgrade [ccq-during-upgrade]
479506

0 commit comments

Comments
 (0)