Skip to content

Update skip_unavailable docs for ESQL #1285

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.

Sign up for GitHub

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 3 commits into from
Apr 28, 2025
Merged

Update skip_unavailable docs for ESQL #1285

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b521e4
Update skip_unavailable docs for ESQL
smalyshev Apr 28, 2025
583dd88
Reformulate
smalyshev Apr 28, 2025
d00aee2
Merge branch 'main' into skip-un-esql-update
smalyshev Apr 28, 2025
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
11 changes: 5 additions & 6 deletions explore-analyze/query-filter/languages/esql-cross-clusters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ PUT _cluster/settings
}
```

1. Since `skip_unavailable` was not set on `cluster_three`, it uses the default of `false`. See the [Optional remote clusters](#ccq-skip-unavailable-clusters) section for details.
1. Since `skip_unavailable` was not set on `cluster_three`, it uses the default of `true`. See the [Optional remote clusters](#ccq-skip-unavailable-clusters) section for details.



Expand Down Expand Up @@ -284,7 +284,7 @@ Which returns:
```

1. How long the entire search (across all clusters) took, in milliseconds.
2. This section of counters shows all possible cluster search states and how many cluster searches are currently in that state. The clusters can have one of the following statuses: **running**, **successful** (searches on all shards were successful), **skipped** (the search failed on a cluster marked with `skip_unavailable`=`true`), **failed** (the search failed on a cluster marked with `skip_unavailable`=`false`) or **partial** (the search was [interrupted](https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-stop-api.html) before finishing).
2. This section of counters shows all possible cluster search states and how many cluster searches are currently in that state. The clusters can have one of the following statuses: **running**, **successful** (searches on all shards were successful), **skipped** (the search failed on a cluster marked with `skip_unavailable`=`true`), **failed** (the search failed on a cluster marked with `skip_unavailable`=`false`) or **partial** (the search was [interrupted](https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-stop-api.html) before finishing or has partially failed).
3. The `_clusters/details` section shows metadata about the search on each cluster.
4. If you included indices from the local cluster you sent the request to in your {{ccs}}, it is identified as "(local)".
5. How long (in milliseconds) the search took on each cluster. This can be useful to determine which clusters have slower response times than others.
Expand Down Expand Up @@ -469,10 +469,9 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001

## Optional remote clusters [ccq-skip-unavailable-clusters]

{{ccs-cap}} for {{esql}} currently does not respect the `skip_unavailable` setting. As a result, if a remote cluster specified in the request is unavailable or failed, {{ccs}} for {{esql}} queries will fail regardless of the setting.

We are actively working to align the behavior of {{ccs}} for {{esql}} with other {{ccs}} APIs.

{ccs-cap} for {esql} will set the remote cluster which is disconnected from the querying cluster to `skipped`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: had to read it twice to understand, maybe add commas like:

{ccs-cap} for {esql} will set the remote cluster, which is disconnected from the querying cluster, to skipped ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Restructured it to be clearer, thanks.

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.

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

Expand Down
Loading