Class: Mongoid::Contextual::Mongo
- Inherits:
-
Object
- Object
- Mongoid::Contextual::Mongo
- Includes:
- Enumerable, Atomic, Aggregable::Mongo, Queryable, Relations::Eager
- Defined in:
- lib/mongoid/contextual/mongo.rb
Constant Summary collapse
- OPTIONS =
Options constant.
[ :hint, :limit, :skip, :sort, :batch_size, :max_scan, :max_time_ms, :snapshot, :comment, :read ].freeze
Constants included from Atomic
Instance Attribute Summary collapse
-
#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.
Attributes included from Relations::Eager
Instance Method Summary collapse
-
#cached? ⇒ true, false
Is the context cached?.
-
#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.
-
#exists? ⇒ true, false
Do any documents exist for the context.
-
#explain ⇒ Hash
Run an explain on the criteria.
-
#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(opts = {}) ⇒ Document
(also: #one)
Get the first document in the database for the criteria’s selector.
-
#geo_near(coordinates) ⇒ GeoNear
Execute a $geoNear command against the database.
-
#initialize(criteria) ⇒ Mongo
constructor
Create the new Mongo context.
-
#last(opts = {}) ⇒ Object
Get the last document in the database for the criteria’s selector.
-
#length ⇒ Integer
(also: #size)
Get’s the number of documents matching the query selector.
-
#limit(value) ⇒ Mongo
Limits the number of documents that are returned from the database.
-
#map(field = nil, &block) ⇒ Array
Invoke the block for each element of Contextual.
-
#map_reduce(map, reduce) ⇒ MapReduce
Initiate a map/reduce operation from the context.
-
#pluck(*fields) ⇒ Array<Object, Array>
Pluck the single field values from the database.
-
#skip(value) ⇒ Mongo
Skips the provided number of documents.
-
#sort(values = nil, &block) ⇒ Mongo
Sorts the documents by the provided spec.
-
#update(attributes = nil) ⇒ nil, false
Update the first matching document atomically.
-
#update_all(attributes = nil) ⇒ nil, false
Update all the matching documents atomically.
Methods included from Queryable
Methods included from Relations::Eager
#eager_load, #eager_load_one, #eager_loadable?, #preload, #with_eager_loading
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.
321 322 323 324 325 326 327 |
# File 'lib/mongoid/contextual/mongo.rb', line 321 def initialize(criteria) @criteria, @klass, @cache = criteria, criteria.klass, criteria.[:cache] @collection = @klass.collection criteria.send(:merge_type_selection) @view = collection.find(criteria.selector) end |
Instance Attribute Details
#view ⇒ Object (readonly)
Returns the value of attribute view.
24 25 26 |
# File 'lib/mongoid/contextual/mongo.rb', line 24 def view @view end |
#view The Mongo collection view.(TheMongocollectionview.) ⇒ Object (readonly)
24 |
# File 'lib/mongoid/contextual/mongo.rb', line 24 attr_reader :view |
Instance Method Details
#cached? ⇒ true, false
Is the context cached?
34 35 36 |
# File 'lib/mongoid/contextual/mongo.rb', line 34 def cached? !!@cache end |
#count(options = {}, &block) ⇒ Integer
Get the number of documents matching the query.
57 58 59 60 |
# File 'lib/mongoid/contextual/mongo.rb', line 57 def count( = {}, &block) return super(&block) if block_given? try_cache(:count) { view.count() } end |
#delete ⇒ nil Also known as: delete_all
Delete all documents in the database that match the selector.
70 71 72 73 74 |
# File 'lib/mongoid/contextual/mongo.rb', line 70 def delete self.count.tap do view.delete_many end end |
#destroy ⇒ nil Also known as: destroy_all
Destroy all documents in the database that match the selector.
85 86 87 88 89 90 91 |
# File 'lib/mongoid/contextual/mongo.rb', line 85 def destroy destroyed = self.count each do |doc| doc.destroy end destroyed end |
#distinct(field) ⇒ Array<Object>
Get the distinct values in the db for the provided field.
104 105 106 107 108 |
# File 'lib/mongoid/contextual/mongo.rb', line 104 def distinct(field) view.distinct(klass.database_field_name(field)).map do |value| value.class.demongoize(value) end end |
#each(&block) ⇒ Enumerator
Iterate over the context. If provided a block, yield to a Mongoid document for each, otherwise return an enum.
121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/mongoid/contextual/mongo.rb', line 121 def each(&block) if block_given? documents_for_iteration.each do |doc| yield_document(doc, &block) end @cache_loaded = true self else to_enum end end |
#exists? ⇒ true, false
We don’t use count here since Mongo does not use counted b-tree indexes, unless a count is already cached then that is used to determine the value.
Do any documents exist for the context.
145 146 147 148 149 150 151 152 |
# File 'lib/mongoid/contextual/mongo.rb', line 145 def exists? return !documents.empty? if cached? && cache_loaded? return @count > 0 if instance_variable_defined?(:@count) try_cache(:exists) do !!(view.projection(_id: 1).limit(1).first) end end |
#explain ⇒ Hash
Run an explain on the criteria.
162 163 164 |
# File 'lib/mongoid/contextual/mongo.rb', line 162 def explain view.explain 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
261 262 263 264 |
# File 'lib/mongoid/contextual/mongo.rb', line 261 def find_first return documents.first if cached? && cache_loaded? with_eager_loading(view.first) end |
#find_one_and_delete ⇒ Document
Execute the find and modify command, used for MongoDB’s $findAndModify. This deletes the found document.
219 220 221 222 223 |
# File 'lib/mongoid/contextual/mongo.rb', line 219 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.
204 205 206 207 208 |
# File 'lib/mongoid/contextual/mongo.rb', line 204 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.
182 183 184 185 186 |
# File 'lib/mongoid/contextual/mongo.rb', line 182 def find_one_and_update(update, = {}) if doc = view.find_one_and_update(update, ) Factory.from_db(klass, doc) end end |
#first(opts = {}) ⇒ Document 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 the option { sort: :none }. Be aware that #first/#last won’t guarantee order in this case.
Get the first document in the database for the criteria’s selector.
244 245 246 247 248 249 250 251 252 253 |
# File 'lib/mongoid/contextual/mongo.rb', line 244 def first(opts = {}) return documents.first if cached? && cache_loaded? try_cache(:first) do if sort = view.sort || ({ _id: 1 } unless opts[:id_sort] == :none) with_eager_loading(view.sort(sort).limit(-1).first) else with_eager_loading(view.limit(-1).first) end end end |
#geo_near(coordinates) ⇒ GeoNear
Execute a $geoNear command against the database.
285 286 287 |
# File 'lib/mongoid/contextual/mongo.rb', line 285 def geo_near(coordinates) GeoNear.new(collection, criteria, coordinates) end |
#last(opts = {}) ⇒ Object
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 the option { sort: :none }. Be aware that #first/#last won’t guarantee order in this case.
Get the last document in the database for the criteria’s selector.
348 349 350 351 352 353 354 |
# File 'lib/mongoid/contextual/mongo.rb', line 348 def last(opts = {}) try_cache(:last) do with_inverse_sorting(opts) do with_eager_loading(view.limit(-1).first) end end end |
#length ⇒ Integer Also known as: size
Get’s the number of documents matching the query selector.
364 365 366 |
# File 'lib/mongoid/contextual/mongo.rb', line 364 def length @length ||= self.count end |
#limit(value) ⇒ Mongo
Limits the number of documents that are returned from the database.
379 380 381 |
# File 'lib/mongoid/contextual/mongo.rb', line 379 def limit(value) @view = view.limit(value) and self end |
#map(field = nil, &block) ⇒ Array
Invoke the block for each element of Contextual. Create a new array containing the values returned by the block.
If the symbol field name is passed instead of the block, additional optimizations would be used.
304 305 306 307 308 309 310 |
# File 'lib/mongoid/contextual/mongo.rb', line 304 def map(field = nil, &block) if block_given? super(&block) else criteria.pluck(field) end end |
#map_reduce(map, reduce) ⇒ MapReduce
Initiate a map/reduce operation from the context.
394 395 396 |
# File 'lib/mongoid/contextual/mongo.rb', line 394 def map_reduce(map, reduce) MapReduce.new(collection, criteria, map, reduce) end |
#pluck(*fields) ⇒ Array<Object, Array>
This method will return the raw db values - it performs no custom serialization.
Pluck the single field values from the database. Will return duplicates if they exist and only works for top level fields.
412 413 414 415 416 417 418 419 420 421 422 423 424 |
# File 'lib/mongoid/contextual/mongo.rb', line 412 def pluck(*fields) normalized_select = fields.inject({}) do |hash, f| hash[klass.database_field_name(f)] = 1 hash end view.projection(normalized_select).reduce([]) do |plucked, doc| values = normalized_select.keys.map do |n| n =~ /\./ ? doc[n.partition('.')[0]] : doc[n] end plucked << (values.size == 1 ? values.first : values) end end |
#skip(value) ⇒ Mongo
Skips the provided number of documents.
436 437 438 |
# File 'lib/mongoid/contextual/mongo.rb', line 436 def skip(value) @view = view.skip(value) and self end |
#sort(values = nil, &block) ⇒ Mongo
Sorts the documents by the provided spec.
451 452 453 454 455 456 457 458 459 460 |
# File 'lib/mongoid/contextual/mongo.rb', line 451 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 |
#update(attributes = nil) ⇒ nil, false
Update the first matching document atomically.
472 473 474 |
# File 'lib/mongoid/contextual/mongo.rb', line 472 def update(attributes = nil) update_documents(attributes) end |
#update_all(attributes = nil) ⇒ nil, false
Update all the matching documents atomically.
486 487 488 |
# File 'lib/mongoid/contextual/mongo.rb', line 486 def update_all(attributes = nil) update_documents(attributes, :update_many) end |