Class: OpenSearch::DSL::Search::Queries::Nested

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

Overview

A query which returns the root documents for nested documents matching the specified query

Examples:

Return articles where John has commented


search do
  query do
    nested do
      path 'comments'
      query do
        match user: 'John'
      end
    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) 


60
61
62
63
 
# File 'lib/opensearch/dsl/search/queries/nested.rb', line 60

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) 


69
70
71
72
73
74
75
76
 
# File 'lib/opensearch/dsl/search/queries/nested.rb', line 69

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