Module: Mongoid::Persistable::Destroyable

Extended by:
ActiveSupport::Concern
Included in:
Mongoid::Persistable
Defined in:
lib/mongoid/persistable/destroyable.rb

Overview

Defines behavior for persistence operations that destroy documents.

Since:

  • 4.0.0

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#destroy(options = nil) ⇒ true, false

Remove the document from the database with callbacks.

Examples:

Destroy a document.

document.destroy

Parameters:

  • options (Hash) (defaults to: nil) —

    Options to pass to destroy.

Returns:

  • (true, false) —

    True if successful, false if not.

Raises:

Since:

  • 1.0.0



23
24
25
26
27
28
29
 
# File 'lib/mongoid/persistable/destroyable.rb', line 23

def destroy(options = nil)
  raise Errors::ReadonlyDocument.new(self.class) if readonly?
  self.flagged_for_destroy = true
  result = run_callbacks(:destroy) { delete(options || {}) }
  self.flagged_for_destroy = false
  result
end

#destroy!(options = {}) ⇒ Object

Since:

  • 4.0.0



31
32
33
 
# File 'lib/mongoid/persistable/destroyable.rb', line 31

def destroy!(options = {})
  destroy || raise(Errors::DocumentNotDestroyed.new(id, self.class))
end