Class: OpenSearch::DSL::Search::Queries::TopChildren

Inherits:
Object
  • Object
show all
Includes:
BaseComponent
Defined in:
lib/opensearch/dsl/search/queries/top_children.rb

Overview

A filter which returns parent documents for children documents matching a query

Examples:

Return articles with comments mentioning ‘twitter’, summing the score


search do
  query do
    top_children do
      type  'comment'
      query match: { body: 'twitter' }
      score 'sum'
    end
  end
end

See Also:

Instance Method Summary collapse

Methods included from BaseComponent

included, #initialize

Instance Method Details

#query(*args, &block) ⇒ self

DSL method for building the ‘query` part of the query definition

Returns:

  • (self) 


62
63
64
65
 
# File 'lib/opensearch/dsl/search/queries/top_children.rb', line 62

def query(*args, &block)
  @query = block ? @query = Query.new(*args, &block) : args.first
  self
end

#to_hash ⇒ Hash

Converts the query definition to a Hash

Returns:

  • (Hash) 


71
72
73
74
75
76
77
78
 
# File 'lib/opensearch/dsl/search/queries/top_children.rb', line 71

def to_hash
  hash = super
  if @query
    _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
    hash[self.name].update(query: _query)
  end
  hash
end