Module: Mongoid::Persistence

Extended by:
ActiveSupport::Concern
Includes:
Atomic
Included in:
Components
Defined in:
lib/mongoid/persistence.rb,
lib/mongoid/persistence/atomic.rb,
lib/mongoid/persistence/deletion.rb,
lib/mongoid/persistence/insertion.rb,
lib/mongoid/persistence/atomic/inc.rb,
lib/mongoid/persistence/atomic/bit.rb,
lib/mongoid/persistence/atomic/pop.rb,
lib/mongoid/persistence/operations.rb,
lib/mongoid/persistence/atomic/push.rb,
lib/mongoid/persistence/atomic/sets.rb,
lib/mongoid/persistence/atomic/pull.rb,
lib/mongoid/persistence/modification.rb,
lib/mongoid/persistence/atomic/unset.rb,
lib/mongoid/persistence/atomic/rename.rb,
lib/mongoid/persistence/atomic/pull_all.rb,
lib/mongoid/persistence/atomic/push_all.rb,
lib/mongoid/persistence/atomic/operation.rb,
lib/mongoid/persistence/operations/remove.rb,
lib/mongoid/persistence/atomic/add_to_set.rb,
lib/mongoid/persistence/operations/update.rb,
lib/mongoid/persistence/operations/insert.rb,
lib/mongoid/persistence/operations/embedded/insert.rb,
lib/mongoid/persistence/operations/embedded/remove.rb

Overview

The persistence module is a mixin to provide database accessor methods for the document. These correspond to the appropriate accessors on a mongo collection and retain the same DSL.

Examples:

Sample persistence operations.

document.insert
document.update
document.upsert

Defined Under Namespace

Modules: Atomic, ClassMethods, Deletion, Insertion, Modification, Operations

Constant Summary

Constant Summary

Constants included from Atomic

Atomic::UPDATES

Instance Method Summary (collapse)

Methods included from Atomic

#add_atomic_pull, #atomic_array_add_to_sets, #atomic_array_pulls, #atomic_array_pushes, #atomic_attribute_name, #atomic_delete_modifier, #atomic_insert_modifier, #atomic_path, #atomic_position, #atomic_pulls, #atomic_pushes, #atomic_selector, #atomic_sets, #atomic_unsets, #atomic_updates, #delayed_atomic_pulls, #delayed_atomic_sets

Instance Method Details

- (true, false) destroy(options = {})

Remove the document from the database with callbacks.

Examples:

Destroy a document.

document.destroy

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to pass to destroy.

Returns:

  • (true, false) —

    True if successful, false if not.



30
31
32
33
34
35
36
37
 
# File 'lib/mongoid/persistence.rb', line 30

def destroy(options = {})
  self.flagged_for_destroy = true
  result = run_callbacks(:destroy) do
    remove(options)
  end
  self.flagged_for_destroy = false
  result
end

- (Document) insert(options = {})

Insert a new document into the database. Will return the document itself whether or not the save was successful.

Examples:

Insert a document.

document.insert

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to pass to insert.

Returns:

  • (Document) —

    The persisted document.



48
49
50
 
# File 'lib/mongoid/persistence.rb', line 48

def insert(options = {})
  Operations.insert(self, options).persist
end

- (TrueClass) remove(options = {}) Also known as: delete

Remove the document from the database.

Examples:

Remove the document.

document.remove

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to pass to remove.

Returns:

  • (TrueClass) —

    True.



60
61
62
 
# File 'lib/mongoid/persistence.rb', line 60

def remove(options = {})
  Operations.remove(self, options).persist
end

- (true, false) save!(options = {})

Save the document - will perform an insert if the document is new, and update if not. If a validation error occurs an error will get raised.

Examples:

Save the document.

document.save!

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to pass to the save.

Returns:

  • (true, false) —

    True if validation passed.



74
75
76
77
78
79
80
 
# File 'lib/mongoid/persistence.rb', line 74

def save!(options = {})
  unless upsert(options)
    self.class.fail_validate!(self) if errors.any?
    self.class.fail_callback!(self, :save!)
  end
  return true
end

- (true) touch(field = nil)

Note:

This will not autobuild relations if those options are set.

Touch the document, in effect updating it's updated_at timestamp and optionally the provided field to the current time. If any belongs_to relations exist with a touch option, they will be updated as well.

Examples:

Update the updated_at timestamp.

document.touch

Update the updated_at and provided timestamps.

document.touch(:audited)

Parameters:

  • field (Symbol) (defaults to: nil) —

    The name of an additional field to update.

Returns:

  • (true) —

    true.

Since:

  • 3.0.0



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/mongoid/persistence.rb', line 99

def touch(field = nil)
  current = Time.now
  write_attribute(:updated_at, current) if fields["updated_at"]
  write_attribute(field, current) if field
  collection.find(atomic_selector).update(atomic_updates)
  without_autobuild do
    touchables.each { |name| send(name).try(:touch) }
  end
  move_changes and true
end

- (true, false) update(options = {})

Update the document in the database.

Examples:

Update an existing document.

document.update

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to pass to update.

Returns:

  • (true, false) —

    True if succeeded, false if not.



118
119
120
 
# File 'lib/mongoid/persistence.rb', line 118

def update(options = {})
  Operations.update(self, options).persist
end

- (true, false) update_attribute(name, value)

Update a single attribute and persist the entire document. This skips validation but fires the callbacks.

Examples:

Update the attribute.

person.update_attribute(:title, "Sir")

Parameters:

  • name (Symbol, String) —

    The name of the attribute.

  • value (Object) —

    The new value of the attribute.a

Returns:

  • (true, false) —

    True if save was successfull, false if not.

Raises:

Since:

  • 2.0.0.rc.6



137
138
139
140
141
142
143
 
# File 'lib/mongoid/persistence.rb', line 137

def update_attribute(name, value)
  unless attribute_writable?(name.to_s)
    raise Errors::ReadonlyAttribute.new(name, value)
  end
  write_attribute(name, value)
  save(validate: false)
end

- (true, false) update_attributes(attributes = {}, options = {})

Update the document attributes in the database.

Examples:

Update the document's attributes

document.update_attributes(:title => "Sir")

Parameters:

  • attributes (Hash) (defaults to: {}) —

    The attributes to update.

Returns:

  • (true, false) —

    True if validation passed, false if not.



153
154
155
 
# File 'lib/mongoid/persistence.rb', line 153

def update_attributes(attributes = {}, options = {})
  assign_attributes(attributes, options); save
end

- (true, false) update_attributes!(attributes = {}, options = {})

Update the document attributes in the database and raise an error if validation failed.

Examples:

Update the document's attributes.

document.update_attributes(:title => "Sir")

Parameters:

  • attributes (Hash) (defaults to: {}) —

    The attributes to update.

Returns:

  • (true, false) —

    True if validation passed.

Raises:



168
169
170
171
172
173
174
175
 
# File 'lib/mongoid/persistence.rb', line 168

def update_attributes!(attributes = {}, options = {})
  result = update_attributes(attributes, options)
  unless result
    self.class.fail_validate!(self) if errors.any?
    self.class.fail_callback!(self, :update_attributes!)
  end
  result
end

- (true, false) upsert(options = {}) Also known as: save

Upsert the document - will perform an insert if the document is new, and update if not.

Examples:

Upsert the document.

document.upsert

Parameters:

  • options (Hash) (defaults to: {}) —

    Options to pass to the upsert.

Returns:

  • (true, false) —

    True is success, false if not.



186
187
188
189
190
191
192
 
# File 'lib/mongoid/persistence.rb', line 186

def upsert(options = {})
  if new_record?
    insert(options).persisted?
  else
    update(options)
  end
end