Module: Mongoid::Criteria::Queryable::Selectable
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
self,
Macroable
|
|
| Defined in: | lib/mongoid/criteria/queryable/selectable.rb |
Overview
An queryable selectable is selectable, in that it has the ability to select document from the database. The selectable module brings all functionality to the selectable that has to do with building MongoDB selectors.
Constant Summary
-
LINE_STRING =
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 13
Constant for a LineString $geometry.
'LineString' -
POINT =
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 16
Constant for a Point $geometry.
'Point' -
POLYGON =
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 19
Constant for a Polygon $geometry.
'Polygon'
Class Method Summary
-
.forwardables ⇒ Array<Symbol>
Get the methods on the selectable that can be forwarded to from a model.
Macroable - Extended
Instance Attribute Summary
- #negating rw
- #negating If the next expression is negated.(If the next expression is negated.) rw
-
#negating? ⇒ true | false
rw
Is the current selectable negating the next selection?
- #selector rw
- #selector The query selector.(The query selector.) rw
Instance Method Summary
-
#all(*criteria) ⇒ Selectable
(also: #all_in)
Add the $all criterion.
-
#all_in(*criteria)
Alias for #all.
-
#all_of(*criteria)
Alias for #and.
-
#and(*criteria) ⇒ Selectable
(also: #all_of)
Add the $and criterion.
-
#any_in(condition)
Alias for #in.
-
#any_of(*criteria) ⇒ Selectable
Adds a disjunction of the arguments as an additional constraint to the criteria already existing in the receiver.
-
#between(criterion) ⇒ Selectable
Add the range selection.
-
#elem_match(criterion) ⇒ Selectable
Select with an $elemMatch.
-
#eq(criterion) ⇒ Selectable
Add the $eq criterion to the selector.
-
#excludes(criterion)
Alias for #ne.
-
#exists(criterion) ⇒ Selectable
Add the $exists selection.
-
#expr_query(criterion) ⇒ Selectable
Internal use only
Internal use only
Adds the specified expression to the query.
-
#geo_spatial(criterion) ⇒ Selectable
Add a $geoIntersects or $geoWithin selection.
-
#gt(criterion) ⇒ Selectable
Add the $gt criterion to the selector.
-
#gte(criterion) ⇒ Selectable
Add the $gte criterion to the selector.
-
#in(condition) ⇒ Selectable
(also: #any_in)
Adds the $in selection to the selectable.
-
#js_query(criterion) ⇒ Selectable
Internal use only
Internal use only
Create a javascript selection.
-
#lt(criterion) ⇒ Selectable
Add the $lt criterion to the selector.
-
#lte(criterion) ⇒ Selectable
Add the $lte criterion to the selector.
-
#max_distance(criterion) ⇒ Selectable
Add a $maxDistance selection to the selectable.
-
#mod(criterion) ⇒ Selectable
Adds $mod selection to the selectable.
-
#ne(criterion) ⇒ Selectable
(also: #excludes)
Adds $ne selection to the selectable.
-
#near(criterion) ⇒ Selectable
Adds a $near criterion to a geo selection.
-
#near_sphere(criterion) ⇒ Selectable
Adds a $nearSphere criterion to a geo selection.
-
#nin(condition) ⇒ Selectable
(also: #not_in)
Adds the $nin selection to the selectable.
-
#none_of(*criteria) ⇒ Selectable
Negate the arguments, constraining the query to only those documents that do NOT match the arguments.
-
#nor(*criteria) ⇒ Selectable
Adds $nor selection to the selectable.
-
#not(*criteria) ⇒ Selectable
Negate the arguments, or the next selection if no arguments are given.
-
#not_in(condition)
Alias for #nin.
-
#or(*criteria) ⇒ Selectable
Creates a disjunction using $or from the existing criteria in the receiver and the provided arguments.
-
#text_search(terms, opts = nil) ⇒ Selectable
Construct a text search selector.
-
#where(*criteria) ⇒ Selectable
This is the general entry point for most MongoDB queries.
-
#with_size(criterion) ⇒ Selectable
Add a $size selection for array fields.
-
#with_type(criterion) ⇒ Selectable
Adds a $type selection to the selectable.
-
#selection(criterion = nil) ⇒ Selectable
private
Internal use only
Internal use only
Take the provided criterion and store it as a selection in the query selector.
-
#typed_override(criterion, operator, &block)
private
Internal use only
Internal use only
Force the values of the criterion to be evolved.
Class Method Details
.forwardables ⇒ Array<Symbol>
Get the methods on the selectable that can be forwarded to from a model.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 883
def forwardables public_instance_methods(false) - %i[negating negating= negating? selector selector=] end
Instance Attribute Details
#negating (rw)
[ GitHub ]# File 'lib/mongoid/criteria/queryable/selectable.rb', line 23
attr_accessor :negating, :selector
#negating If the next expression is negated.(If the next expression is negated.) (rw)
[ GitHub ]
#negating? ⇒ true | false (rw)
Is the current selectable negating the next selection?
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 490
def negating? !!negating end
#selector (rw)
[ GitHub ]# File 'lib/mongoid/criteria/queryable/selectable.rb', line 23
attr_accessor :negating, :selector
#selector The query selector.(The query selector.) (rw)
[ GitHub ]Instance Method Details
#all(*criteria) ⇒ Selectable
Also known as: #all_in
Add the $all criterion.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 36
def all(*criteria) if criteria.empty? return clone.tap do |query| query.reset_strategies! end end criteria.inject(clone) do |query, condition| raise Errors::CriteriaArgumentRequired, :all if condition.nil? condition = (condition) if strategy send(strategy, condition, '$all') else condition.inject(query) do |_query, (field, value)| v = { '$all' => value } v = { '$not' => v } if negating? _query.add_field_expression(field.to_s, v) end end end.reset_strategies! end
#all_in(*criteria)
Alias for #all.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 59
alias all_in all
#all_of(*criteria)
Alias for #and.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 102
alias all_of and
#and(*criteria) ⇒ Selectable
Also known as: #all_of
Add the $and criterion.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 72
def and(*criteria) _mongoid_flatten_arrays(criteria).inject(clone) do |c, new_s| new_s = new_s.selector if new_s.is_a?(Selectable) normalized = (new_s) normalized.each do |k, v| k = k.to_s if c.selector[k] # There is already a condition on k. # If v is an operator, and all existing conditions are # also operators, and v isn't present in existing conditions, # we can add to existing conditions. # Otherwise use $and. if v.is_a?(Hash) && v.length == 1 && (new_k = v.keys.first).start_with?('$') && (existing_kv = c.selector[k]).is_a?(Hash) && !existing_kv.key?(new_k) && existing_kv.keys.all? { |sub_k| sub_k.start_with?('$') } merged_v = c.selector[k].merge(v) c.selector.store(k, merged_v) else c = c.send(:__multi__, [ { k => v } ], '$and') end else c.selector.store(k, v) end end c end end
#any_in(condition)
Alias for #in.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 312
alias any_in in
#any_of(*criteria) ⇒ Selectable
Adds a disjunction of the arguments as an additional constraint to the criteria already existing in the receiver.
Use #or to make the receiver one of the disjunction operands.
Each argument can be a ::Hash, a ::Mongoid::Criteria object, an array of ::Hash or ::Mongoid::Criteria objects, or a nested array. Nested arrays will be flattened and can be of any depth. Passing arrays is deprecated.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 625
def any_of(*criteria) criteria = _mongoid_flatten_arrays(criteria) case criteria.length when 0 clone when 1 # When we have a single criteria, any_of behaves like and. # Note: criteria can be a Query object, which #where method does # not support. self.and(*criteria) else # When we have multiple criteria, combine them all with $or # and add the result to self. exprs = criteria.map do |criterion| if criterion.is_a?(Selectable) (criterion.selector) else Hash[criterion.map do |k, v| if k.is_a?(Symbol) [ k.to_s, v ] else [ k, v ] end end] end end self.and('$or' => exprs) end end
#between(criterion) ⇒ Selectable
Add the range selection.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 115
def between(criterion) raise Errors::CriteriaArgumentRequired, :between if criterion.nil? selection(criterion) do |selector, field, value| selector.store( field, { '$gte' => value.min, '$lte' => value.max } ) end end
#elem_match(criterion) ⇒ Selectable
Select with an $elemMatch.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 143
def elem_match(criterion) raise Errors::CriteriaArgumentRequired, :elem_match if criterion.nil? and_with_operator(criterion, '$elemMatch') end
#eq(criterion) ⇒ Selectable
Add the $eq criterion to the selector.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 240
def eq(criterion) raise Errors::CriteriaArgumentRequired, :eq if criterion.nil? and_with_operator(criterion, '$eq') end
#excludes(criterion)
Alias for #ne.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 400
alias excludes ne
#exists(criterion) ⇒ Selectable
Add the $exists selection.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 164
def exists(criterion) raise Errors::CriteriaArgumentRequired, :exists if criterion.nil? typed_override(criterion, '$exists') do |value| Mongoid::Boolean.evolve(value) end end
#expr_query(criterion) ⇒ Selectable
Adds the specified expression to the query.
Criterion must be a hash in one of the following forms:
-
value -
=> value -
value -
=> operator_value_expression
Field name and operator may be given as either strings or symbols.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 795
def expr_query(criterion) raise ArgumentError, 'Criterion cannot be nil here' if criterion.nil? unless criterion.is_a?(Hash) raise Errors::InvalidQuery, "Expression must be a Hash: #{Errors::InvalidQuery.truncate_expr(criterion)}" end normalized = (criterion) clone.tap do |query| normalized.each do |field, value| field_s = field.to_s if field_s.start_with?('$') # Query expression-level operator, like $and or $where query.add_operator_expression(field_s, value) else query.add_field_expression(field, value) end end query.reset_strategies! end end
#geo_spatial(criterion) ⇒ Selectable
The only valid geometry shapes for a $geoIntersects are: :intersects_line, :intersects_point, and :intersects_polygon.
The only valid options for a $geoWithin query are the geometry shape :within_polygon and the operator :within_box.
The :within_box operator for the $geoWithin query expects the lower left (south west) coordinate pair as the first argument and the upper right (north east) as the second argument. Important: When latitude and longitude are passed, longitude is expected as the first element of the coordinate pair. Source: www.mongodb.com/docs/manual/reference/operator/query/box/
Add a $geoIntersects or $geoWithin selection. ::Symbol operators must be used as shown in the examples to expand the criteria.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 209
def geo_spatial(criterion) raise Errors::CriteriaArgumentRequired, :geo_spatial if criterion.nil? __merge__(criterion) end
#gt(criterion) ⇒ Selectable
Add the $gt criterion to the selector.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 258
def gt(criterion) raise Errors::CriteriaArgumentRequired, :gt if criterion.nil? and_with_operator(criterion, '$gt') end
#gte(criterion) ⇒ Selectable
Add the $gte criterion to the selector.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 276
def gte(criterion) raise Errors::CriteriaArgumentRequired, :gte if criterion.nil? and_with_operator(criterion, '$gte') end
#in(condition) ⇒ Selectable
Also known as: #any_in
Adds the $in selection to the selectable.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 297
def in(condition) raise Errors::CriteriaArgumentRequired, :in if condition.nil? condition = (condition) if strategy send(strategy, condition, '$in') else condition.inject(clone) do |query, (field, value)| v = { '$in' => value } v = { '$not' => v } if negating? query.add_field_expression(field.to_s, v) end.reset_strategies! end end
#js_query(criterion) ⇒ Selectable
Create a javascript selection.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 826
def js_query(criterion) clone.tap do |query| if negating? query.add_operator_expression('$and', [ { '$nor' => [ { '$where' => criterion } ] } ]) else query.add_operator_expression('$where', criterion) end query.reset_strategies! end end
#lt(criterion) ⇒ Selectable
Add the $lt criterion to the selector.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 326
def lt(criterion) raise Errors::CriteriaArgumentRequired, :lt if criterion.nil? and_with_operator(criterion, '$lt') end
#lte(criterion) ⇒ Selectable
Add the $lte criterion to the selector.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 344
def lte(criterion) raise Errors::CriteriaArgumentRequired, :lte if criterion.nil? and_with_operator(criterion, '$lte') end
#max_distance(criterion) ⇒ Selectable
Add a $maxDistance selection to the selectable.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 359
def max_distance(criterion) raise Errors::CriteriaArgumentRequired, :max_distance if criterion.nil? # $maxDistance must be given together with $near __add__(criterion, '$maxDistance') end
#mod(criterion) ⇒ Selectable
Adds $mod selection to the selectable.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 377
def mod(criterion) raise Errors::CriteriaArgumentRequired, :mod if criterion.nil? and_with_operator(criterion, '$mod') end
#ne(criterion) ⇒ Selectable
Also known as: #excludes
Adds $ne selection to the selectable.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 395
def ne(criterion) raise Errors::CriteriaArgumentRequired, :ne if criterion.nil? and_with_operator(criterion, '$ne') end
#near(criterion) ⇒ Selectable
Adds a $near criterion to a geo selection.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 414
def near(criterion) raise Errors::CriteriaArgumentRequired, :near if criterion.nil? and_with_operator(criterion, '$near') end
#near_sphere(criterion) ⇒ Selectable
Adds a $nearSphere criterion to a geo selection.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 432
def near_sphere(criterion) raise Errors::CriteriaArgumentRequired, :near_sphere if criterion.nil? and_with_operator(criterion, '$nearSphere') end
#nin(condition) ⇒ Selectable
Also known as: #not_in
Adds the $nin selection to the selectable.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 453
def nin(condition) raise Errors::CriteriaArgumentRequired, :nin if condition.nil? condition = (condition) if strategy send(strategy, condition, '$nin') else condition.inject(clone) do |query, (field, value)| v = { '$nin' => value } v = { '$not' => v } if negating? query.add_field_expression(field.to_s, v) end.reset_strategies! end end
#none_of(*criteria) ⇒ Selectable
Negate the arguments, constraining the query to only those documents that do NOT match the arguments.
#nor(*criteria) ⇒ Selectable
Adds $nor selection to the selectable.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 480
def nor(*criteria) _mongoid_add_top_level_operation('$nor', criteria) end
#not(*criteria) ⇒ Selectable
Negate the arguments, or the next selection if no arguments are given.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 509
def not(*criteria) if criteria.empty? dup.tap { |query| query.negating = !query.negating } else criteria.compact.inject(clone) do |c, new_s| new_s = new_s.selector if new_s.is_a?(Selectable) (new_s).each do |k, v| k = k.to_s if c.selector[k] || k.start_with?('$') c = c.send(:__multi__, [ { '$nor' => [ { k => v } ] } ], '$and') elsif v.is_a?(Hash) c = c.send(:__multi__, [ { '$nor' => [ { k => v } ] } ], '$and') else negated_operator = if v.is_a?(Regexp) '$not' else '$ne' end c = c.send(:__override__, { k => v }, negated_operator) end end c end end end
#not_in(condition)
Alias for #nin.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 468
alias not_in nin
#or(*criteria) ⇒ Selectable
Creates a disjunction using $or from the existing criteria in the receiver and the provided arguments.
This behavior (receiver becoming one of the disjunction operands) matches ActiveRecord’s or behavior.
Use #any_of to add a disjunction of the arguments as an additional constraint to the criteria already existing in the receiver.
Each argument can be a ::Hash, a ::Mongoid::Criteria object, an array of ::Hash or ::Mongoid::Criteria objects, or a nested array. Nested arrays will be flattened and can be of any depth. Passing arrays is deprecated.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 595
def or(*criteria) _mongoid_add_top_level_operation('$or', criteria) end
#selection(criterion = nil) ⇒ Selectable (private)
Take the provided criterion and store it as a selection in the query selector.
#text_search(terms, opts = nil) ⇒ Selectable
Per www.mongodb.com/docs/manual/reference/operator/query/text/ it is not currently possible to supply multiple text search conditions in a query. ::Mongoid will build such a query but the server will return an error when trying to execute it.
Construct a text search selector.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 723
def text_search(terms, opts = nil) raise Errors::CriteriaArgumentRequired, :terms if terms.nil? clone.tap do |query| criterion = { '$text' => { '$search' => terms } } criterion['$text'].merge!(opts) if opts if query.selector['$text'] # Per https://www.mongodb.com/docs/manual/reference/operator/query/text/ # multiple $text expressions are not currently supported by # MongoDB server, but build the query correctly instead of # overwriting previous text search condition with the currently # given one. Mongoid.logger.warn('Multiple $text expressions per query are not currently supported by the server') query.selector = { '$and' => [ query.selector ] }.merge(criterion) else query.selector = query.selector.merge(criterion) end end end
#typed_override(criterion, operator, &block) (private)
Force the values of the criterion to be evolved.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 850
def typed_override(criterion, operator, &block) criterion.transform_values!(&block) if criterion __override__(criterion, operator) end
#where(*criteria) ⇒ Selectable
This is the general entry point for most MongoDB queries. This either creates a standard field: value selection, and expanded selection with the use of hash methods, or a $where selection if a string is provided.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 757
def where(*criteria) return clone.reset_strategies! if criteria.empty? criteria.inject(self) do |query, criterion| raise Errors::CriteriaArgumentRequired, :where if criterion.nil? # We need to save the criterion in an instance variable so # Modifiable methods know how to create a polymorphic object. # Note that this method in principle accepts multiple criteria, # but only the first one will be stored in @criterion. This # works out to be fine because first_or_create etc. methods # only ever specify one criterion to #where. @criterion = criterion if criterion.is_a?(String) query.js_query(criterion) else query.expr_query(criterion) end end end
#with_size(criterion) ⇒ Selectable
This method is named #with_size not to conflict with any existing #size method on enumerables or symbols.
Add a $size selection for array fields.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 669
def with_size(criterion) raise Errors::CriteriaArgumentRequired, :with_size if criterion.nil? typed_override(criterion, '$size') do |value| ::Integer.evolve(value) end end
#with_type(criterion) ⇒ Selectable
vurl.me/PGOU contains a list of all types.
Adds a $type selection to the selectable.
# File 'lib/mongoid/criteria/queryable/selectable.rb', line 693
def with_type(criterion) raise Errors::CriteriaArgumentRequired, :with_type if criterion.nil? typed_override(criterion, '$type') do |value| ::Integer.evolve(value) end end