Class: OpenSearch::DSL::Search::Queries::Filtered

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

Overview

Note:

It’s possible and common to define just the ‘filter` part of the search definition, for a structured search use case.

A query which allows to combine a query with a filter

Examples:

Find documents about Twitter published last month


search do
  query do
    filtered do
      query do
        multi_match do
          query 'twitter'
          fields [ :title, :abstract, :content ]
        end
      end
      filter do
        range :published_on do
          gte 'now-1M/M'
        end
      end
    end
  end
end

See Also:

Instance Method Summary collapse

Methods included from BaseComponent

included, #initialize

Instance Method Details

#filter(*args, &block) ⇒ self

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

Returns:

  • (self) 


77
78
79
80
 
# File 'lib/opensearch/dsl/search/queries/filtered.rb', line 77

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

#query(*args, &block) ⇒ self

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

Returns:

  • (self) 


68
69
70
71
 
# File 'lib/opensearch/dsl/search/queries/filtered.rb', line 68

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) 


86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/opensearch/dsl/search/queries/filtered.rb', line 86

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