class Elasticsearch::DSL::Search::Queries::Filtered

A query which allows to combine a query with a filter

@note It's possible and common to define just the `filter` part of the search definition,

for a structured search use case.

@example 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 www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-filtered-query.html

Public Instance Methods

filter(*args, &block) click to toggle source

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

@return [self]

# File lib/elasticsearch/dsl/search/queries/filtered.rb, line 68
def filter(*args, &block)
  @filter = block ? Filter.new(*args, &block) : args.first
  self
end
query(*args, &block) click to toggle source

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

@return [self]

# File lib/elasticsearch/dsl/search/queries/filtered.rb, line 59
def query(*args, &block)
  @query = block ? @query = Query.new(*args, &block) : args.first
  self
end
to_hash() click to toggle source

Converts the query definition to a Hash

@return [Hash]

Calls superclass method
# File lib/elasticsearch/dsl/search/queries/filtered.rb, line 77
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