Module: Mongoid::Atomic

Extended by:
ActiveSupport::Concern
Included in:
Components, Contextual::Mongo
Defined in:
lib/mongoid/atomic.rb,
lib/mongoid/atomic/modifiers.rb,
lib/mongoid/atomic/paths/root.rb,
lib/mongoid/atomic/paths/embedded.rb,
lib/mongoid/atomic/paths/embedded/one.rb,
lib/mongoid/atomic/paths/embedded/many.rb

Overview

This module contains the logic for supporting atomic operations against the database.

Defined Under Namespace

Modules: Paths Classes: Modifiers

Constant Summary collapse

UPDATES = 
[
  :atomic_array_pushes,
  :atomic_array_pulls,
  :atomic_array_add_to_sets,
  :atomic_pulls,
  :delayed_atomic_sets,
  :delayed_atomic_pulls,
  :delayed_atomic_unsets
]

Instance Method Summary collapse

Instance Method Details

#add_atomic_pull(document) ⇒ Object

Add the document as an atomic pull.

Examples:

Add the atomic pull.

person.add_atomic_pull(address)

Parameters:

  • The (Document) —

    embedded document to pull.

Since:

  • 2.2.0



37
38
39
40
 
# File 'lib/mongoid/atomic.rb', line 37

def add_atomic_pull(document)
  document.flagged_for_destroy = true
  (delayed_atomic_pulls[document.metadata_name.to_s] ||= []).push(document)
end

#add_atomic_unset(document) ⇒ Array<Document>

Add an atomic unset for the document.

Examples:

Add an atomic unset.

document.add_atomic_unset(doc)

Parameters:

  • document (Document) —

    The child document.

Returns:

Since:

  • 3.0.0



52
53
54
55
 
# File 'lib/mongoid/atomic.rb', line 52

def add_atomic_unset(document)
  document.flagged_for_destroy = true
  (delayed_atomic_unsets[document.metadata_name.to_s] ||= []).push(document)
end

#atomic_array_add_to_sets ⇒ Hash

For array fields these are the unique adds that need to happen.

Examples:

Get the array unique adds.

person.atomic_array_add_to_sets

Returns:

  • (Hash) —

    The array add_to_sets.

Since:

  • 2.4.0



89
90
91
 
# File 'lib/mongoid/atomic.rb', line 89

def atomic_array_add_to_sets
  @atomic_array_add_to_sets ||= {}
end

#atomic_array_pulls ⇒ Hash

For array fields these are the pulls that need to happen.

Examples:

Get the array pulls.

person.atomic_array_pulls

Returns:

  • (Hash) —

    The array pulls.

Since:

  • 2.4.0



77
78
79
 
# File 'lib/mongoid/atomic.rb', line 77

def atomic_array_pulls
  @atomic_array_pulls ||= {}
end

#atomic_array_pushes ⇒ Hash

For array fields these are the pushes that need to happen.

Examples:

Get the array pushes.

person.atomic_array_pushes

Returns:

  • (Hash) —

    The array pushes.

Since:

  • 2.4.0



65
66
67
 
# File 'lib/mongoid/atomic.rb', line 65

def atomic_array_pushes
  @atomic_array_pushes ||= {}
end

#atomic_attribute_name(name) ⇒ String

Returns path of the attribute for modification

Examples:

Get path of the attribute

address.atomic_attribute_name(:city)

Returns:

  • (String) —

    The path to the document attribute in the database



175
176
177
 
# File 'lib/mongoid/atomic.rb', line 175

def atomic_attribute_name(name)
  embedded? ? "#{atomic_position}.#{name}" : name
end

#atomic_delete_modifier ⇒ String

Get the removal modifier for the document. Will be nil on root documents, $unset on embeds_one, $set on embeds_many.

Examples:

Get the removal operator.

name.atomic_delete_modifier

Returns:

  • (String) —

    The pull or unset operation.



133
134
135
 
# File 'lib/mongoid/atomic.rb', line 133

def atomic_delete_modifier
  atomic_paths.delete_modifier
end

#atomic_insert_modifier ⇒ String

Get the insertion modifier for the document. Will be nil on root documents, $set on embeds_one, $push on embeds_many.

Examples:

Get the insert operation.

name.atomic_insert_modifier

Returns:

  • (String) —

    The pull or set operator.



144
145
146
 
# File 'lib/mongoid/atomic.rb', line 144

def atomic_insert_modifier
  atomic_paths.insert_modifier
end

#atomic_path ⇒ String

Return the path to this Document in JSON notation, used for atomic updates via $set in MongoDB.

Examples:

Get the path to this document.

address.atomic_path

Returns:

  • (String) —

    The path to the document in the database.



155
156
157
 
# File 'lib/mongoid/atomic.rb', line 155

def atomic_path
  atomic_paths.path
end

#atomic_position ⇒ String

Returns the positional operator of this document for modification.

Examples:

Get the positional operator.

address.atomic_position

Returns:

  • (String) —

    The positional operator with indexes.



165
166
167
 
# File 'lib/mongoid/atomic.rb', line 165

def atomic_position
  atomic_paths.position
end

#atomic_pulls ⇒ Array<Hash>

Get all the attributes that need to be pulled.

Examples:

Get the pulls.

person.atomic_pulls

Returns:

  • (Array<Hash>) —

    The $pullAll operations.

Since:

  • 2.2.0



187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/mongoid/atomic.rb', line 187

def atomic_pulls
  pulls = {}
  delayed_atomic_pulls.each_pair do |_, docs|
    path = nil
    ids = docs.map do |doc|
      path ||= doc.flag_as_destroyed
      doc.id
    end
    pulls[path] = { "_id" => { "$in" => ids }} and path = nil
  end
  pulls
end

#atomic_pushes ⇒ Hash

Get all the push attributes that need to occur.

Examples:

Get the pushes.

person.atomic_pushes

Returns:

  • (Hash) —

    The $pushAll operations.

Since:

  • 2.1.0



208
209
210
 
# File 'lib/mongoid/atomic.rb', line 208

def atomic_pushes
  pushable? ? { atomic_path => as_document } : {}
end

#atomic_selector ⇒ String

Return the selector for this document to be matched exactly for use with MongoDB’s $ operator.

Examples:

Get the selector.

address.atomic_selector

Returns:

  • (String) —

    The exact selector for this document.



219
220
221
 
# File 'lib/mongoid/atomic.rb', line 219

def atomic_selector
  atomic_paths.selector
end

#atomic_sets ⇒ Hash

Get all the attributes that need to be set.

Examples:

Get the sets.

person.atomic_sets

Returns:

  • (Hash) —

    The $set operations.

Since:

  • 2.1.0



231
232
233
 
# File 'lib/mongoid/atomic.rb', line 231

def atomic_sets
  updateable? ? setters : settable? ? { atomic_path => as_document } : {}
end

#atomic_unsets ⇒ Array<Hash>

Get all the attributes that need to be unset.

Examples:

Get the unsets.

person.atomic_unsets

Returns:

  • (Array<Hash>) —

    The $unset operations.

Since:

  • 2.2.0



243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/mongoid/atomic.rb', line 243

def atomic_unsets
  unsets = []
  delayed_atomic_unsets.each_pair do |name, docs|
    path = nil
    docs.each do |doc|
      path ||= doc.flag_as_destroyed
    end
    unsets.push(path || name)
  end
  unsets
end

#atomic_updates ⇒ Hash Also known as: _updates

Note:

MongoDB does not allow “conflicting modifications” to be performed in a single operation. Conflicting modifications are detected by the ‘haveConflictingMod’ function in MongoDB. Examination of the code suggests that two modifications (a $set and a $pushAll, for example) conflict if:

(1) the key paths being modified are equal.
(2) one key path is a prefix of the other.

So a $set of ‘addresses.0.street’ will conflict with a $pushAll to ‘addresses’, and we will need to split our update into two pieces. We do not, however, attempt to match MongoDB’s logic exactly. Instead, we assume that two updates conflict if the first component of the two key paths matches.

Get all the atomic updates that need to happen for the current Document. This includes all changes that need to happen in the entire hierarchy that exists below where the save call was made.

Examples:

Get the updates that need to occur.

person.atomic_updates(children)

Returns:

  • (Hash) —

    The updates and their modifiers.

Since:

  • 2.1.0



116
117
118
119
120
121
122
123
 
# File 'lib/mongoid/atomic.rb', line 116

def atomic_updates
  mods = Modifiers.new
  generate_atomic_updates(mods, self)
  _children.each do |child|
    generate_atomic_updates(mods, child)
  end
  mods
end

#delayed_atomic_pulls ⇒ Hash

Get a hash of atomic pulls that are pending.

Examples:

Get the atomic pulls.

document.delayed_atomic_pulls

Returns:

  • (Hash) —

    name/document pairs.

Since:

  • 2.3.2



275
276
277
 
# File 'lib/mongoid/atomic.rb', line 275

def delayed_atomic_pulls
  @delayed_atomic_pulls ||= {}
end

#delayed_atomic_sets ⇒ Hash

Get all the atomic sets that have had their saves delayed.

Examples:

Get the delayed atomic sets.

person.delayed_atomic_sets

Returns:

  • (Hash) —

    The delayed $sets.

Since:

  • 2.3.0



263
264
265
 
# File 'lib/mongoid/atomic.rb', line 263

def delayed_atomic_sets
  @delayed_atomic_sets ||= {}
end

#delayed_atomic_unsets ⇒ Hash

Get the delayed atomic unsets.

Examples:

Get the delayed atomic unsets.

document.delayed_atomic_unsets

Returns:

  • (Hash) —

    The atomic unsets

Since:

  • 3.0.0



287
288
289
 
# File 'lib/mongoid/atomic.rb', line 287

def delayed_atomic_unsets
  @delayed_atomic_unsets ||= {}
end

#flag_as_destroyed ⇒ String

Flag the document as destroyed and return the atomic path.

Examples:

Flag destroyed and return path.

document.flag_as_destroyed

Returns:

  • (String) —

    The atomic path.

Since:

  • 3.0.0



299
300
301
302
303
 
# File 'lib/mongoid/atomic.rb', line 299

def flag_as_destroyed
  self.destroyed = true
  self.flagged_for_destroy = false
  atomic_path
end