Skip to content

Conversation

smalyshev
Copy link
Contributor

Document allow_partial_results, is_partial and the new way of reporting _clusters.

@smalyshev smalyshev requested review from naj-h and quux00 March 14, 2025 21:48
Copy link
Contributor

Documentation preview:

@smalyshev smalyshev marked this pull request as ready for review March 14, 2025 21:48
@smalyshev smalyshev added v8.19.0 >docs General docs changes :Analytics/ES|QL AKA ESQL labels Mar 14, 2025
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) labels Mar 14, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-analytical-engine (Team:Analytics)

and (3) when `format` of the response is set to JSON (the default), CBOR, SMILE, or YAML.
Metadata about clusters involved in the execution of a query. This field is present in the response in the following cases:
(1) for cross-cluster searches, when `include_ccs_metadata` is sent in the body and set to `true`;
(2) the result is partial (`is_partial` is `true`) and there are failures on some clusters.
Copy link
Contributor

Choose a reason for hiding this comment

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

Question: if all shards were successful in the local cluster, will the _clusters be included in the response if remotes have partial shard failures even if include_ccs_metadata is false?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, if there are any failures that make the response partial, then _clusters will be included together with the failures.

Copy link
Contributor

Choose a reason for hiding this comment

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

Question: metadata would be present if the query is stopped, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, unless there are any failures, it's one of 1) include_ccs_metadata + CSS; or 2) partial + failures. If there are no failures to report then 2) is not activated.

Copy link
Contributor

@pawankartik-elastic pawankartik-elastic left a comment

Choose a reason for hiding this comment

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

Looks good to me in general. I don't have any specific inputs.

@smalyshev smalyshev merged commit d24ca5a into elastic:8.x Mar 18, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Analytics/ES|QL AKA ESQL >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v8.19.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants