Method: Chewy::Search::QueryProxy#must

Defined in:

lib/chewy/search/query_proxy.rb

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

Executes Parameters::QueryStorage#must in the scope of newly created request object.

Overloads:

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

  If pure hash is passed it is added to must array of the bool query.

  Examples:

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

  Parameters:

  • query_hash (Hash) —

    pure query hash

  See Also:

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

  If block is passed instead of a pure hash, `elasticsearch-dsl" gem will be used to process it.

  Examples:

  PlacesIndex.query.must { match name: 'Moscow' }.query.must { match name: 'London' }
  # => <PlacesIndex::Query {..., :body=>{:query=>{:bool=>{
  #      :must=>[{:match=>{:name=>"Moscow"}}, {:match=>{:name=>"London"}}]}}}}>

  Yields:

  • the block is processed by elasticsearch-dsl gem

  See Also:

  • https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-dsl

Returns:

• (Chewy::Search::Request)

See Also:

• Parameters::QueryStorage#must

# File 'lib/chewy/search/query_proxy.rb', line 102

%i[must should must_not].each do |method|
  define_method method do |query_hash = nil, &block|
    raise ArgumentError, "Please provide a parameter or a block to `#{method}`" unless query_hash || block

    @request.send(:modify, @parameter_name) { send(method, block || query_hash) }
  end
end