Method: Chewy::Search::Request#filter

Defined in:

lib/chewy/search/request.rb

#filter(query_hash) ⇒ Chewy::Search::Request #filter { ... } ⇒ Chewy::Search::Request #filter ⇒ Chewy::Search::QueryProxy

Adds filter context of the query parameter at the search request body.

Overloads:

• #filter(query_hash) ⇒ Chewy::Search::Request

  If pure hash is passed it goes straight to the filter context of the query parameter storage. Acts exactly the same way as QueryProxy#must.

  Examples:

  PlacesIndex.filter(match: {name: 'Moscow'})
  # => <PlacesIndex::Query {..., :body=>{:query=>{:bool=>{
  #      :filter=>{:match=>{:name=>"Moscow"}}}}}}>

  Parameters:

  • query_hash (Hash) —

    pure query hash

  Returns:

  • (Chewy::Search::Request)

  See Also:

  • https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
• #filter { ... } ⇒ Chewy::Search::Request

  If block is passed instead of a pure hash, `elasticsearch-dsl" gem will be used to process it. Acts exactly the same way as QueryProxy#must with a block.

  Examples:

  PlacesIndex.filter { match name: 'Moscow' }
  # => <PlacesIndex::Query {..., :body=>{:query=>{:bool=>{
  #      :filter=>{:match=>{:name=>"Moscow"}}}}}}>

  Yields:

  • the block is processed by elasticsearch-dsl gem

  Returns:

  • (Chewy::Search::Request)

  See Also:

  • https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-dsl
• #filter ⇒ Chewy::Search::QueryProxy

  If nothing is passed it returns a proxy for additional parameter manipulations.

  Examples:

  PlacesIndex.filter.should(match: {name: 'Moscow'}).filter.not(match: {name: 'London'})
  # => <PlacesIndex::Query {..., :body=>{:query=>{:bool=>{
  #      :filter=>{:bool=>{:should=>{:match=>{:name=>"Moscow"}},
  #      :must_not=>{:match=>{:name=>"London"}}}}}}}}>

  Returns:

  • (Chewy::Search::QueryProxy)

  See Also:

  • QueryProxy

Returns:

• (Chewy::Search::Request, Chewy::Search::QueryProxy)

See Also:

• https://www.elastic.co/guide/en/elasticsearch/reference/current/query-filter-context.html
• Parameters::Filter

# File 'lib/chewy/search/request.rb', line 261

%i[query filter post_filter].each do |name|
  define_method name do |query_hash = UNDEFINED, &block|
    if block || query_hash != UNDEFINED
      modify(name) { must(block || query_hash) }
    else
      Chewy::Search::QueryProxy.new(name, self)
    end
  end
end