Class: OpenSearch::DSL::Search::Queries::Bool

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

Overview

A compound query which matches documents based on combinations of queries

See the integration test for a working example.

Examples:

Defining a bool query with multiple conditions


search do
  query do
    bool do
      must do
        term category: 'men'
      end

      must do
        term size:  'xxl'
      end

      should do
        term color: 'red'
      end

      must_not do
        term manufacturer: 'evil'
      end
    end
  end
end

See Also:

Instance Method Summary collapse

Methods included from BaseComponent

included, #initialize

Instance Method Details

#filter(*args, &block) ⇒ Object 



88
89
90
91
92
93
94
 
# File 'lib/opensearch/dsl/search/queries/bool.rb', line 88

def filter(*args, &block)
  @hash[name][:filter] ||= []
  if (filter = block ? Filter.new(*args, &block) : args.first)
    @hash[name][:filter] << filter.to_hash
  end
  self
end

#must(*args, &block) ⇒ Object 



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

def must(*args, &block)
  @hash[name][:must] ||= []
  value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
  @hash[name][:must].push(value).flatten! unless @hash[name][:must].include?(value)
  self
end

#must_not(*args, &block) ⇒ Object 



74
75
76
77
78
79
 
# File 'lib/opensearch/dsl/search/queries/bool.rb', line 74

def must_not(*args, &block)
  @hash[name][:must_not] ||= []
  value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
  @hash[name][:must_not].push(value).flatten! unless @hash[name][:must_not].include?(value)
  self
end

#should(*args, &block) ⇒ Object 



81
82
83
84
85
86
 
# File 'lib/opensearch/dsl/search/queries/bool.rb', line 81

def should(*args, &block)
  @hash[name][:should] ||= []
  value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
  @hash[name][:should].push(value).flatten! unless @hash[name][:should].include?(value)
  self
end

#to_hash ⇒ Object 



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/opensearch/dsl/search/queries/bool.rb', line 96

def to_hash
  @hash[name].update(@args.to_hash) if @args.respond_to?(:to_hash)

  if @block
    call
  else
    @hash[name] = @args unless @args.nil? || @args.empty?
  end
  @hash
end