Class: OpenSearch::DSL::Search::Aggregations::Children

Inherits:

Object

• Object
• OpenSearch::DSL::Search::Aggregations::Children

Includes:

BaseAggregationComponent

Defined in:

lib/opensearch/dsl/search/aggregations/children.rb

Overview

A single-bucket aggregation which allows to aggregate from buckets on parent documents to buckets on the children documents

See the integration test for a full example.

Examples:

Return the top commenters per article category

search do
  aggregation :top_categories do
    terms field: 'category' do
      aggregation :comments do
        children type: 'comment' do
          aggregation :top_authors do
            terms field: 'author'
          end
        end
      end
    end
  end
end

See Also:

• http://opensearch.org/guide/en/opensearch/reference/current/search-aggregations-bucket-children-aggregation.html

Method Summary

Methods included from BaseAggregationComponent

included