-
Notifications
You must be signed in to change notification settings - Fork 25.5k
Document changes in partial result reporting #124928
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
Conversation
Documentation preview: |
Pinging @elastic/es-docs (Team:Docs) |
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this 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.
Document
allow_partial_results
,is_partial
and the new way of reporting_clusters
.