Skip to content

Commit 41e187f

Browse files
authored
Update skip_unavailable docs for ESQL (#1285)
1 parent ac24291 commit 41e187f

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

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

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ PUT _cluster/settings
169169
}
170170
```
171171

172-
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.
172+
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.
173173

174174

175175

@@ -284,7 +284,7 @@ Which returns:
284284
```
285285

286286
1. How long the entire search (across all clusters) took, in milliseconds.
287-
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).
287+
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).
288288
3. The `_clusters/details` section shows metadata about the search on each cluster.
289289
4. If you included indices from the local cluster you sent the request to in your {{ccs}}, it is identified as "(local)".
290290
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.
@@ -469,10 +469,9 @@ FROM my-index-000001,cluster*:my-index-*,cluster_three:-my-index-000001
469469

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

472-
{{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.
473-
474-
We are actively working to align the behavior of {{ccs}} for {{esql}} with other {{ccs}} APIs.
475-
472+
If a remote cluster disconnects from the querying cluster, {ccs-cap} for {esql} will set it to `skipped`
473+
and continue the query with other clusters, unless the remote cluster's `skip_unavailable` setting is set to `false`,
474+
in which case the query will fail.
476475

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

0 commit comments

Comments
 (0)