Class: Mongoid::Persistence::Update

Inherits:
Command show all
Defined in:
lib/mongoid/persistence/update.rb

Overview

Update is a persistence command responsible for taking a document that has already been saved to the database and saving it, depending on whether or not the document has been modified.

Before persisting the command will check via dirty attributes if the document has changed, if not, it will simply return true. If it has it will go through the validation steps, run callbacks, and set the changed fields atomically on the document. The underlying query resembles the following MongoDB query:

collection.update(
  { "_id" : 1,
  { "$set" : { "field" : "value" },
  false,
  false
);

For embedded documents it will use the positional locator:

collection.update(
  { "_id" : 1, "addresses._id" : 2 },
  { "$set" : { "addresses.$.field" : "value" },
  false,
  false
);

Instance Attribute Summary

Attributes inherited from Command

#collection, #document, #klass, #options, #selector, #validate

Instance Method Summary collapse

Methods inherited from Command

#initialize

Constructor Details

This class inherits a constructor from Mongoid::Persistence::Command

Instance Method Details

#persist ⇒ Object

Persist the document that is to be updated to the database. This will only write changed fields via MongoDB’s $set modifier operation.

Example:

Update.persist

Returns:

true or false, depending on validation.



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/mongoid/persistence/update.rb', line 41

def persist
  return false if validate && !@document.valid?
  @document.run_callbacks(:before_save)
  @document.run_callbacks(:before_update)
  if update
    @document.move_changes
    @document.run_callbacks(:after_save)
    @document.run_callbacks(:after_update)
  else
    return false
  end; true
end