Module: Mongoid::Criteria::Queryable::Selectable
- Extended by:
- Macroable
- Defined in:
- build/mongoid-master/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 collapse
- LINE_STRING =
Constant for a LineString $geometry.
"LineString"
- POINT =
Constant for a Point $geometry.
"Point"
- POLYGON =
Constant for a Polygon $geometry.
"Polygon"
Instance Attribute Summary collapse
-
#negating ⇒ Object
Returns the value of attribute negating.
- #negating If the next expression is negated.(Ifthe) ⇒ Object
-
#selector ⇒ Object
Returns the value of attribute selector.
- #selector The query selector.(Thequeryselector.) ⇒ Object
Class Method Summary collapse
-
.forwardables ⇒ Array<Symbol>
Get the methods on the selectable that can be forwarded to from a model.
Instance Method Summary collapse
-
#all(*criteria) ⇒ Selectable
(also: #all_in)
Add the $all criterion.
-
#and(*criteria) ⇒ Selectable
(also: #all_of)
Add the $and criterion.
-
#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.
-
#exists(criterion) ⇒ Selectable
Add the $exists selection.
- #geo_spacial(criterion) ⇒ Object deprecated Deprecated.
-
#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.
-
#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.
-
#negating? ⇒ true, false
Is the current selectable negating the next selection?.
-
#nin(condition) ⇒ Selectable
(also: #not_in)
Adds the $nin selection to the selectable.
-
#nor(*criteria) ⇒ Selectable
Adds $nor selection to the selectable.
-
#not(*criteria) ⇒ Selectable
Negate the arguments, or the next selection if no arguments are given.
-
#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.
Methods included from Macroable
Instance Attribute Details
#negating ⇒ Object
Returns the value of attribute negating.
26 27 28 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 26 def negating @negating end |
#negating If the next expression is negated.(Ifthe) ⇒ Object
26 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 26 attr_accessor :negating, :selector |
#selector ⇒ Object
Returns the value of attribute selector.
26 27 28 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 26 def selector @selector end |
#selector The query selector.(Thequeryselector.) ⇒ Object
26 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 26 attr_accessor :negating, :selector |
Class Method Details
.forwardables ⇒ Array<Symbol>
Get the methods on the selectable that can be forwarded to from a model.
928 929 930 931 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 928 def forwardables public_instance_methods(false) - [ :negating, :negating=, :negating?, :selector, :selector= ] end |
Instance Method Details
#all(*criteria) ⇒ Selectable Also known as: all_in
Add the $all criterion.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 39 def all(*criteria) if criteria.empty? return clone.tap do |query| query.reset_strategies! end end criteria.inject(clone) do |query, condition| if condition.nil? raise Errors::CriteriaArgumentRequired, :all end condition = (condition) if strategy send(strategy, condition, "$all") else condition.inject(query) do |_query, (field, value)| v = {'$all' => value} if negating? v = {'$not' => v} end _query.add_field_expression(field.to_s, v) end end end.reset_strategies! end |
#and(*criteria) ⇒ Selectable Also known as: all_of
Add the $and criterion.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 78 def and(*criteria) _mongoid_flatten_arrays(criteria).inject(self.clone) do |c, new_s| if new_s.is_a?(Selectable) new_s = new_s.selector end 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?('$') } then 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_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 Criteria object, an array of Hash or Criteria objects, or a nested array. Nested arrays will be flattened and can be of any depth. Passing arrays is deprecated.
658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 658 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.
124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 124 def between(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :between end 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.
154 155 156 157 158 159 160 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 154 def elem_match(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :elem_match end __override__(criterion, "$elemMatch") end |
#eq(criterion) ⇒ Selectable
Add the $eq criterion to the selector.
270 271 272 273 274 275 276 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 270 def eq(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :eq end __override__(criterion, "$eq") end |
#exists(criterion) ⇒ Selectable
Add the $exists selection.
177 178 179 180 181 182 183 184 185 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 177 def exists(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :exists end typed_override(criterion, "$exists") do |value| Mongoid::Boolean.evolve(value) end end |
#geo_spacial(criterion) ⇒ Object
Alias for geo_spatial
.
235 236 237 238 239 240 241 242 243 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 235 def geo_spacial(criterion) # Duplicate method body so that we can raise this exception with # geo_spacial as the indicated operator rather than geo_spatial. if criterion.nil? raise Errors::CriteriaArgumentRequired, :geo_spacial end __merge__(criterion) 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: docs.mongodb.com/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.
224 225 226 227 228 229 230 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 224 def geo_spatial(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :geo_spatial end __merge__(criterion) end |
#gt(criterion) ⇒ Selectable
Add the $gt criterion to the selector.
290 291 292 293 294 295 296 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 290 def gt(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :gt end __override__(criterion, "$gt") end |
#gte(criterion) ⇒ Selectable
Add the $gte criterion to the selector.
310 311 312 313 314 315 316 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 310 def gte(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :gte end __override__(criterion, "$gte") end |
#in(condition) ⇒ Selectable Also known as: any_in
Adds the $in selection to the selectable.
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 333 def in(condition) if condition.nil? raise Errors::CriteriaArgumentRequired, :in end condition = (condition) if strategy send(strategy, condition, "$in") else condition.inject(clone) do |query, (field, value)| v = {'$in' => value} if negating? v = {'$not' => v} end query.add_field_expression(field.to_s, v) end.reset_strategies! end end |
#lt(criterion) ⇒ Selectable
Add the $lt criterion to the selector.
366 367 368 369 370 371 372 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 366 def lt(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :lt end __override__(criterion, "$lt") end |
#lte(criterion) ⇒ Selectable
Add the $lte criterion to the selector.
386 387 388 389 390 391 392 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 386 def lte(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :lte end __override__(criterion, "$lte") end |
#max_distance(criterion) ⇒ Selectable
Add a $maxDistance selection to the selectable.
403 404 405 406 407 408 409 410 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 403 def max_distance(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :max_distance end # $maxDistance must be given together with $near __add__(criterion, "$maxDistance") end |
#mod(criterion) ⇒ Selectable
Adds $mod selection to the selectable.
423 424 425 426 427 428 429 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 423 def mod(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :mod end __override__(criterion, "$mod") end |
#ne(criterion) ⇒ Selectable Also known as: excludes
Adds $ne selection to the selectable.
443 444 445 446 447 448 449 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 443 def ne(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :ne end __override__(criterion, "$ne") end |
#near(criterion) ⇒ Selectable
Adds a $near criterion to a geo selection.
464 465 466 467 468 469 470 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 464 def near(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :near end __override__(criterion, "$near") end |
#near_sphere(criterion) ⇒ Selectable
Adds a $nearSphere criterion to a geo selection.
484 485 486 487 488 489 490 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 484 def near_sphere(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :near_sphere end __override__(criterion, "$nearSphere") end |
#negating? ⇒ true, false
Is the current selectable negating the next selection?
548 549 550 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 548 def negating? !!negating end |
#nin(condition) ⇒ Selectable Also known as: not_in
Adds the $nin selection to the selectable.
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 507 def nin(condition) if condition.nil? raise Errors::CriteriaArgumentRequired, :nin end condition = (condition) if strategy send(strategy, condition, "$nin") else condition.inject(clone) do |query, (field, value)| v = {'$nin' => value} if negating? v = {'$not' => v} end query.add_field_expression(field.to_s, v) end.reset_strategies! end end |
#nor(*criteria) ⇒ Selectable
Adds $nor selection to the selectable.
538 539 540 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 538 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.
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 567 def not(*criteria) if criteria.empty? dup.tap { |query| query.negating = true } else criteria.compact.inject(self.clone) do |c, new_s| if new_s.is_a?(Selectable) new_s = new_s.selector end (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') else if v.is_a?(Hash) c = c.send(:__multi__, [{'$nor' => [{k => v}]}], '$and') else if v.is_a?(Regexp) negated_operator = '$not' else negated_operator = '$ne' end c = c.send(:__override__, {k => v}, negated_operator) end end end c end end end |
#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 Criteria object, an array of Hash or Criteria objects, or a nested array. Nested arrays will be flattened and can be of any depth. Passing arrays is deprecated.
628 629 630 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 628 def or(*criteria) _mongoid_add_top_level_operation('$or', criteria) end |
#text_search(terms, opts = nil) ⇒ Selectable
Per docs.mongodb.com/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.
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 760 def text_search(terms, opts = nil) if terms.nil? raise Errors::CriteriaArgumentRequired, :terms end clone.tap do |query| criterion = {'$text' => { '$search' => terms }} criterion['$text'].merge!(opts) if opts if query.selector['$text'] # Per https://docs.mongodb.com/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 |
#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.
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 795 def where(*criteria) criteria.inject(clone) do |query, criterion| if criterion.nil? raise Errors::CriteriaArgumentRequired, :where end # 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) js_query(criterion) else expr_query(criterion) end end.reset_strategies! 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.
702 703 704 705 706 707 708 709 710 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 702 def with_size(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :with_size end 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.
728 729 730 731 732 733 734 735 736 |
# File 'build/mongoid-master/lib/mongoid/criteria/queryable/selectable.rb', line 728 def with_type(criterion) if criterion.nil? raise Errors::CriteriaArgumentRequired, :with_type end typed_override(criterion, "$type") do |value| ::Integer.evolve(value) end end |