Class: OpenSearch::DSL::Search::Queries::Filtered
- Inherits:
-
Object
- Object
- OpenSearch::DSL::Search::Queries::Filtered
- 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
Instance Method Summary collapse
-
#filter(*args, &block) ⇒ self
DSL method for building the ‘filter` part of the query definition.
-
#query(*args, &block) ⇒ self
DSL method for building the ‘query` part of the query definition.
-
#to_hash ⇒ Hash
Converts the query definition to a Hash.
Methods included from BaseComponent
Instance Method Details
#filter(*args, &block) ⇒ self
DSL method for building the ‘filter` part of the query definition
76 77 78 79 |
# File 'lib/opensearch/dsl/search/queries/filtered.rb', line 76 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
67 68 69 70 |
# File 'lib/opensearch/dsl/search/queries/filtered.rb', line 67 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
85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/opensearch/dsl/search/queries/filtered.rb', line 85 def to_hash hash = super if @query _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query hash[name].update(query: _query) end if @filter _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter hash[name].update(filter: _filter) end hash end |