Module: Mongoid::Persistable::Destroyable

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

Overview

Defines behaviour for persistence operations that destroy documents.

Since:

  • 4.0.0

Defined Under Namespace

Modules: ClassMethods

Instance Method Summary collapse

Instance Method Details

#destroy(options = {}) ⇒ true, false

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.

Since:

  • 1.0.0



21
22
23
24
25
26
 
# File 'lib/mongoid/persistable/destroyable.rb', line 21

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