Skip to content

Better description of skip-un funciton in 8.19 #130043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 26, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions docs/reference/esql/esql-across-clusters.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -523,9 +523,24 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001
[[ccq-skip-unavailable-clusters]]
==== Optional remote clusters

{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.
If the remote cluster is configured with `skip_unavailable: true` (the default setting), the cluster would be set
to `skipped` or `partial` status but the query will not fail, if:

* The remote cluster is disconnected from the querying cluster, either before or during the query.
* The remote cluster does not have the requested index.
* An error happened while processing the query on the remote cluster.

The `partial` status will be used if the remote query was partially successful and some data was returned.

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,
or all the indices in the query are missing. For example, the following queries will fail:

[source,esql]
----
FROM cluster_one:missing-index | LIMIT 10
FROM cluster_one:missing-index* | LIMIT 10
FROM cluster_one:missing-index*,cluster_two:missing-index | LIMIT 10
----

[discrete]
[[ccq-during-upgrade]]
Expand Down