Class: Mongoid::Contextual::Mongo
- Inherits:
-
Object
- Object
- Mongoid::Contextual::Mongo
- Extended by:
- Forwardable
- Includes:
- Enumerable, Association::EagerLoadable, Atomic, Aggregable::Mongo, Queryable
- Defined in:
- build/mongoid-master/lib/mongoid/contextual/mongo.rb,
build/mongoid-master/lib/mongoid/contextual/mongo/documents_loader.rb
Defined Under Namespace
Classes: DocumentsLoader
Constant Summary collapse
- OPTIONS =
Options constant.
[ :hint, :limit, :skip, :sort, :batch_size, :max_scan, :max_time_ms, :snapshot, :comment, :read, :cursor_type, :collation ].freeze
Constants included from Atomic
Instance Attribute Summary collapse
-
#documents_loader ⇒ Object
readonly
Returns the value of attribute documents_loader.
-
#view ⇒ Object
readonly
Returns the value of attribute view.
- #view The Mongo collection view.(TheMongocollectionview.) ⇒ Object readonly
Attributes included from Queryable
#collection, #collection The collection to query against., #criteria, #criteria The criteria for the context., #klass, #klass The klass for the criteria.
Instance Method Summary collapse
-
#count(options = {}, &block) ⇒ Integer
Get the number of documents matching the query.
-
#delete ⇒ nil
(also: #delete_all)
Delete all documents in the database that match the selector.
-
#destroy ⇒ nil
(also: #destroy_all)
Destroy all documents in the database that match the selector.
-
#distinct(field) ⇒ Array<Object>
Get the distinct values in the db for the provided field.
-
#each(&block) ⇒ Enumerator
Iterate over the context.
-
#estimated_count(options = {}) ⇒ Integer
Get the estimated number of documents matching the query.
-
#exists?(id_or_conditions = :none) ⇒ true | false
Do any documents exist for the context.
-
#explain ⇒ Hash
Run an explain on the criteria.
-
#fifth ⇒ Document | nil
Get the fifth document in the database for the criteria’s selector.
-
#fifth! ⇒ Document
Get the fifth document in the database for the criteria’s selector or raise an error if none is found.
-
#find_first ⇒ Object
private
Return the first result without applying sort.
-
#find_one_and_delete ⇒ Document
Execute the find and modify command, used for MongoDB’s $findAndModify.
-
#find_one_and_replace(replacement, options = {}) ⇒ Document
Execute the find and modify command, used for MongoDB’s $findAndModify.
-
#find_one_and_update(update, options = {}) ⇒ Document
Execute the find and modify command, used for MongoDB’s $findAndModify.
-
#first(limit = nil) ⇒ Document | nil
(also: #one)
Get the first document in the database for the criteria’s selector.
-
#first! ⇒ Document
Get the first document in the database for the criteria’s selector or raise an error if none is found.
-
#fourth ⇒ Document | nil
Get the fourth document in the database for the criteria’s selector.
-
#fourth! ⇒ Document
Get the fourth document in the database for the criteria’s selector or raise an error if none is found.
- #geo_near(coordinates) ⇒ GeoNear deprecated Deprecated.
-
#initialize(criteria) ⇒ Mongo
constructor
Create the new Mongo context.
-
#last(limit = nil) ⇒ Document | nil
Get the last document in the database for the criteria’s selector.
-
#last! ⇒ Document
Get the last document in the database for the criteria’s selector or raise an error if none is found.
-
#length ⇒ Integer
(also: #size)
Returns the number of documents in the database matching the query selector.
-
#limit(value) ⇒ Mongo
Limits the number of documents that are returned from the database.
-
#load_async ⇒ Object
private
Schedule a task to load documents for the context.
-
#map_reduce(map, reduce) ⇒ MapReduce
Initiate a map/reduce operation from the context.
-
#pick(*fields) ⇒ Object | Array<Object>
Pick the single field values from the database.
-
#pluck(*fields) ⇒ Array<Object> | Array<Array<Object>>
Pluck the field value(s) from the database.
-
#second ⇒ Document | nil
Get the second document in the database for the criteria’s selector.
-
#second! ⇒ Document
Get the second document in the database for the criteria’s selector or raise an error if none is found.
-
#second_to_last ⇒ Document | nil
Get the second to last document in the database for the criteria’s selector.
-
#second_to_last! ⇒ Document
Get the second to last document in the database for the criteria’s selector or raise an error if none is found.
-
#skip(value) ⇒ Mongo
Skips the provided number of documents.
-
#sort(values = nil, &block) ⇒ Mongo
Sorts the documents by the provided spec.
-
#take(limit = nil) ⇒ Document | Array<Document>
Take the given number of documents from the database.
-
#take! ⇒ Document
Take one document from the database and raise an error if there are none.
-
#tally(field) ⇒ Hash
Get a hash of counts for the values of a single field.
-
#third ⇒ Document | nil
Get the third document in the database for the criteria’s selector.
-
#third! ⇒ Document
Get the third document in the database for the criteria’s selector or raise an error if none is found.
-
#third_to_last ⇒ Document | nil
Get the third to last document in the database for the criteria’s selector.
-
#third_to_last! ⇒ Document
Get the third to last document in the database for the criteria’s selector or raise an error if none is found.
-
#update(attributes = nil, opts = {}) ⇒ nil | false
Update the first matching document atomically.
-
#update_all(attributes = nil, opts = {}) ⇒ nil | false
Update all the matching documents atomically.
Methods included from Queryable
Methods included from Association::EagerLoadable
#eager_load, #eager_loadable?, #preload
Methods included from Atomic
#add_atomic_pull, #add_atomic_unset, #atomic_array_add_to_sets, #atomic_array_pulls, #atomic_array_pushes, #atomic_attribute_name, #atomic_delete_modifier, #atomic_insert_modifier, #atomic_path, #atomic_paths, #atomic_position, #atomic_pulls, #atomic_pushes, #atomic_sets, #atomic_unsets, #atomic_updates, #delayed_atomic_pulls, #delayed_atomic_sets, #delayed_atomic_unsets, #flag_as_destroyed, #flagged_destroys, #process_flagged_destroys
Methods included from Aggregable::Mongo
#aggregates, #avg, #max, #min, #sum
Constructor Details
#initialize(criteria) ⇒ Mongo
Create the new Mongo context. This delegates operations to the underlying driver.
291 292 293 294 295 296 297 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 291 def initialize(criteria) @criteria, @klass = criteria, criteria.klass @collection = @klass.collection criteria.send(:merge_type_selection) @view = collection.find(criteria.selector, session: _session) end |
Instance Attribute Details
#documents_loader ⇒ Object (readonly)
Returns the value of attribute documents_loader.
41 42 43 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 41 def documents_loader @documents_loader end |
#view ⇒ Object (readonly)
Returns the value of attribute view.
39 40 41 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 39 def view @view end |
#view The Mongo collection view.(TheMongocollectionview.) ⇒ Object (readonly)
39 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 39 attr_reader :view |
Instance Method Details
#count(options = {}, &block) ⇒ Integer
Get the number of documents matching the query.
60 61 62 63 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 60 def count( = {}, &block) return super(&block) if block_given? view.count_documents() end |
#delete ⇒ nil Also known as: delete_all
Delete all documents in the database that match the selector.
94 95 96 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 94 def delete view.delete_many.deleted_count end |
#destroy ⇒ nil Also known as: destroy_all
Destroy all documents in the database that match the selector.
105 106 107 108 109 110 111 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 105 def destroy each.inject(0) do |count, doc| doc.destroy count += 1 if acknowledged_write? count end end |
#distinct(field) ⇒ Array<Object>
Get the distinct values in the db for the provided field.
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 122 def distinct(field) name = if Mongoid.legacy_pluck_distinct klass.database_field_name(field) else klass.cleanse_localized_field_names(field) end view.distinct(name).map do |value| if Mongoid.legacy_pluck_distinct value.class.demongoize(value) else is_translation = "#{name}_translations" == field.to_s recursive_demongoize(name, value, is_translation) end end end |
#each(&block) ⇒ Enumerator
Iterate over the context. If provided a block, yield to a Mongoid document for each, otherwise return an enum.
148 149 150 151 152 153 154 155 156 157 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 148 def each(&block) if block_given? documents_for_iteration.each do |doc| yield_document(doc, &block) end self else to_enum end end |
#estimated_count(options = {}) ⇒ Integer
Get the estimated number of documents matching the query.
Unlike count, estimated_count does not take a block because it is not traditionally defined (with a block) on Enumarable like count is.
77 78 79 80 81 82 83 84 85 86 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 77 def estimated_count( = {}) unless self.criteria.selector.empty? if klass.default_scoping? raise Mongoid::Errors::InvalidEstimatedCountScoping.new(self.klass) else raise Mongoid::Errors::InvalidEstimatedCountCriteria.new(self.klass) end end view.estimated_document_count() end |
#exists?(id_or_conditions = :none) ⇒ true | false
We don’t use count here since Mongo does not use counted b-tree indexes.
Do any documents exist for the context.
178 179 180 181 182 183 184 185 186 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 178 def exists?(id_or_conditions = :none) return false if self.view.limit == 0 case id_or_conditions when :none then !!(view.projection(_id: 1).limit(1).first) when nil, false then false when Hash then Mongo.new(criteria.where(id_or_conditions)).exists? else Mongo.new(criteria.where(_id: id_or_conditions)).exists? end end |
#explain ⇒ Hash
Run an explain on the criteria.
194 195 196 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 194 def explain view.explain end |
#fifth ⇒ Document | nil
Get the fifth document in the database for the criteria’s selector.
729 730 731 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 729 def fifth retrieve_nth(4) end |
#fifth! ⇒ Document
Get the fifth document in the database for the criteria’s selector or raise an error if none is found.
743 744 745 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 743 def fifth! fifth || raise_document_not_found_error end |
#find_first ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Return the first result without applying sort
254 255 256 257 258 259 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 254 def find_first if raw_doc = view.first doc = Factory.from_db(klass, raw_doc, criteria) eager_load([doc]).first end end |
#find_one_and_delete ⇒ Document
Execute the find and modify command, used for MongoDB’s $findAndModify. This deletes the found document.
245 246 247 248 249 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 245 def find_one_and_delete if doc = view.find_one_and_delete Factory.from_db(klass, doc) end end |
#find_one_and_replace(replacement, options = {}) ⇒ Document
Execute the find and modify command, used for MongoDB’s $findAndModify.
232 233 234 235 236 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 232 def find_one_and_replace(replacement, = {}) if doc = view.find_one_and_replace(replacement, ) Factory.from_db(klass, doc) end end |
#find_one_and_update(update, options = {}) ⇒ Document
Execute the find and modify command, used for MongoDB’s $findAndModify.
212 213 214 215 216 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 212 def find_one_and_update(update, = {}) if doc = view.find_one_and_update(update, ) Factory.from_db(klass, doc) end end |
#first(limit = nil) ⇒ Document | nil Also known as: one
Automatically adding a sort on _id when no other sort is defined on the criteria has the potential to cause bad performance issues. If you experience unexpected poor performance when using #first or #last and have no sort defined on the criteria, use #take instead. Be aware that #take won’t guarantee order.
Get the first document in the database for the criteria’s selector.
580 581 582 583 584 585 586 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 580 def first(limit = nil) if limit.nil? retrieve_nth(0) else retrieve_nth_with_limit(0, limit) end end |
#first! ⇒ Document
Automatically adding a sort on _id when no other sort is defined on the criteria has the potential to cause bad performance issues. If you experience unexpected poor performance when using #first! or #last! and have no sort defined on the criteria, use #take! instead. Be aware that #take! won’t guarantee order.
Get the first document in the database for the criteria’s selector or raise an error if none is found.
605 606 607 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 605 def first! first || raise_document_not_found_error end |
#fourth ⇒ Document | nil
Get the fourth document in the database for the criteria’s selector.
705 706 707 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 705 def fourth retrieve_nth(3) end |
#fourth! ⇒ Document
Get the fourth document in the database for the criteria’s selector or raise an error if none is found.
719 720 721 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 719 def fourth! fourth || raise_document_not_found_error end |
#geo_near(coordinates) ⇒ GeoNear
Execute a $geoNear command against the database.
280 281 282 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 280 def geo_near(coordinates) GeoNear.new(collection, criteria, coordinates) end |
#last(limit = nil) ⇒ Document | nil
Automatically adding a sort on _id when no other sort is defined on the criteria has the potential to cause bad performance issues. If you experience unexpected poor performance when using #first or #last and have no sort defined on the criteria, use #take instead. Be aware that #take won’t guarantee order.
Get the last document in the database for the criteria’s selector.
623 624 625 626 627 628 629 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 623 def last(limit = nil) if limit.nil? retrieve_nth_to_last(0) else retrieve_nth_to_last_with_limit(0, limit) end end |
#last! ⇒ Document
Automatically adding a sort on _id when no other sort is defined on the criteria has the potential to cause bad performance issues. If you experience unexpected poor performance when using #first! or #last! and have no sort defined on the criteria, use #take! instead. Be aware that #take! won’t guarantee order.
Get the last document in the database for the criteria’s selector or raise an error if none is found.
647 648 649 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 647 def last! last || raise_document_not_found_error end |
#length ⇒ Integer Also known as: size
Returns the number of documents in the database matching the query selector.
308 309 310 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 308 def length self.count end |
#limit(value) ⇒ Mongo
Limits the number of documents that are returned from the database.
321 322 323 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 321 def limit(value) @view = view.limit(value) and self end |
#load_async ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Schedule a task to load documents for the context.
Depending on the Mongoid configuration, the scheduled task can be executed immediately on the caller’s thread, or can be scheduled for an asynchronous execution.
806 807 808 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 806 def load_async @documents_loader ||= DocumentsLoader.new(view, klass, criteria) end |
#map_reduce(map, reduce) ⇒ MapReduce
Initiate a map/reduce operation from the context.
334 335 336 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 334 def map_reduce(map, reduce) MapReduce.new(collection, criteria, map, reduce) end |
#pick(*fields) ⇒ Object | Array<Object>
Pick the single field values from the database.
391 392 393 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 391 def pick(*fields) limit(1).pluck(*fields).first end |
#pluck(*fields) ⇒ Array<Object> | Array<Array<Object>>
Pluck the field value(s) from the database. Returns one result for each document found in the database for the context. The results are normalized according to their Mongoid field types. Note that the results may include duplicates and nil values.
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 354 def pluck(*fields) # Multiple fields can map to the same field name. For example, plucking # a field and its _translations field map to the same field in the database. # because of this, we need to keep track of the fields requested. normalized_field_names = [] normalized_select = fields.inject({}) do |hash, f| db_fn = klass.database_field_name(f) normalized_field_names.push(db_fn) if Mongoid.legacy_pluck_distinct hash[db_fn] = true else hash[klass.cleanse_localized_field_names(f)] = true end hash end view.projection(normalized_select).reduce([]) do |plucked, doc| values = normalized_field_names.map do |n| if Mongoid.legacy_pluck_distinct n.include?('.') ? doc[n.partition('.')[0]] : doc[n] else extract_value(doc, n) end end plucked << (values.size == 1 ? values.first : values) end end |
#second ⇒ Document | nil
Get the second document in the database for the criteria’s selector.
657 658 659 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 657 def second retrieve_nth(1) end |
#second! ⇒ Document
Get the second document in the database for the criteria’s selector or raise an error if none is found.
671 672 673 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 671 def second! second || raise_document_not_found_error end |
#second_to_last ⇒ Document | nil
Get the second to last document in the database for the criteria’s selector.
is found.
755 756 757 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 755 def second_to_last retrieve_nth_to_last(1) end |
#second_to_last! ⇒ Document
Get the second to last document in the database for the criteria’s selector or raise an error if none is found.
769 770 771 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 769 def second_to_last! second_to_last || raise_document_not_found_error end |
#skip(value) ⇒ Mongo
Skips the provided number of documents.
510 511 512 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 510 def skip(value) @view = view.skip(value) and self end |
#sort(values = nil, &block) ⇒ Mongo
Sorts the documents by the provided spec.
523 524 525 526 527 528 529 530 531 532 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 523 def sort(values = nil, &block) if block_given? super(&block) else # update the criteria @criteria = criteria.order_by(values) apply_option(:sort) self end end |
#take(limit = nil) ⇒ Document | Array<Document>
Take the given number of documents from the database.
404 405 406 407 408 409 410 411 412 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 404 def take(limit = nil) if limit limit(limit).to_a else # Do to_a first so that the Mongo#first method is not used and the # result is not sorted. limit(1).to_a.first end end |
#take! ⇒ Document
Take one document from the database and raise an error if there are none.
423 424 425 426 427 428 429 430 431 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 423 def take! # Do to_a first so that the Mongo#first method is not used and the # result is not sorted. if fst = limit(1).to_a.first fst else raise Errors::DocumentNotFound.new(klass, nil, nil) end end |
#tally(field) ⇒ Hash
Get a hash of counts for the values of a single field. For example, if the following documents were in the database:
{ _id: 1, age: 21 }
{ _id: 2, age: 21 }
{ _id: 3, age: 22 }
Model.tally("age")
would yield the following result:
{ 21 => 2, 22 => 1 }
When tallying a field inside an array or embeds_many association:
{ _id: 1, array: [ { x: 1 }, { x: 2 } ] }
{ _id: 2, array: [ { x: 1 }, { x: 2 } ] }
{ _id: 3, array: [ { x: 1 }, { x: 3 } ] }
Model.tally("array.x")
The keys of the resulting hash are arrays:
{ [ 1, 2 ] => 2, [ 1, 3 ] => 1 }
Note that if tallying an element in an array of hashes, and the key doesn’t exist in some of the hashes, tally will not include those nil keys in the resulting hash:
{ _id: 1, array: [ { x: 1 }, { x: 2 }, { y: 3 } ] }
Model.tally("array.x")
# => { [ 1, 2 ] => 1 }
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 470 def tally(field) name = klass.cleanse_localized_field_names(field) fld = klass.traverse_association_tree(name) pipeline = [ { "$group" => { _id: "$#{name}", counts: { "$sum": 1 } } } ] pipeline.unshift("$match" => view.filter) unless view.filter.blank? collection.aggregate(pipeline).reduce({}) do |tallies, doc| is_translation = "#{name}_translations" == field.to_s val = doc["_id"] key = if val.is_a?(Array) val.map do |v| demongoize_with_field(fld, v, is_translation) end else demongoize_with_field(fld, val, is_translation) end # The only time where a key will already exist in the tallies hash # is when the values are stored differently in the database, but # demongoize to the same value. A good example of when this happens # is when using localized fields. While the server query won't group # together hashes that have other values in different languages, the # demongoized value is just the translation in the current locale, # which can be the same across multiple of those unequal hashes. tallies[key] ||= 0 tallies[key] += doc["counts"] tallies end end |
#third ⇒ Document | nil
Get the third document in the database for the criteria’s selector.
681 682 683 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 681 def third retrieve_nth(2) end |
#third! ⇒ Document
Get the third document in the database for the criteria’s selector or raise an error if none is found.
695 696 697 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 695 def third! third || raise_document_not_found_error end |
#third_to_last ⇒ Document | nil
Get the third to last document in the database for the criteria’s selector.
is found.
781 782 783 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 781 def third_to_last retrieve_nth_to_last(2) end |
#third_to_last! ⇒ Document
Get the third to last document in the database for the criteria’s selector or raise an error if none is found.
795 796 797 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 795 def third_to_last! third_to_last || raise_document_not_found_error end |
#update(attributes = nil, opts = {}) ⇒ nil | false
Update the first matching document atomically.
546 547 548 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 546 def update(attributes = nil, opts = {}) update_documents(attributes, :update_one, opts) end |
#update_all(attributes = nil, opts = {}) ⇒ nil | false
Update all the matching documents atomically.
562 563 564 |
# File 'build/mongoid-master/lib/mongoid/contextual/mongo.rb', line 562 def update_all(attributes = nil, opts = {}) update_documents(attributes, :update_many, opts) end |