-
Notifications
You must be signed in to change notification settings - Fork 503
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
Add composite aggregation documentation #7666
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Melissa Vagi <[email protected]>
|
||
The `composite` aggregation is a multi-bucket aggregation that creates composite buckets from different sources. It is useful for efficiently paginating multi-level aggregations and retrieving all buckets. Composite buckets are built from combinations of values extracted from documents for each specified source field. | ||
|
||
## Syntax |
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.
Technical reviewer: Please review this content and confirm the syntax and examples are accurate and relevant to an OpenSearch user. I tested the examples using Dev Tools. If another example is more appropriate, please replace the draft example with your example. Thank you.
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
|
||
## Compatibility and limitations | ||
|
||
<SME: What version of OpenSearch is this compatible with? What are the limitations?> |
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.
Technical reviewer: Please provide information about compatibility and limitations.
|
||
<SME: What version of OpenSearch is this compatible with? What are the limitations?> | ||
|
||
## Performance considerations |
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.
Technical reviewer: Please provide information about performance considerations, if any.
Signed-off-by: Melissa Vagi <[email protected]>
@msfroh @bowenlan-amzn @sandeshkr419 Would one of you be available to technical review this PR or delegate it to another dev? The doc team is closing content gaps for aggregations, so this PR needs a technical review before we can publish. Please note that I used internal tools to assist in code example generation and Dev Tools to test those examples. Thank you |
@sandeshkr419 Thank you for taking this tech review on. We're trying to close content gaps. Will you put this in your queue to review by 10/15? Please verify the code examples are appropriate and accurate. If they aren't please provide examples to replace them. Thank you. |
Description
Closes content gaps for the following bucket aggregations:
Auto-interval date histogram
Children
Composite
Parent
Rare terms
Issues Resolved
#4293
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.