Module: Mongoid::Persistence::ClassMethods

Defined in:
lib/mongoid/persistence.rb

Overview

:nodoc:

Instance Method Summary collapse

Instance Method Details

#create(attributes = {}, options = {}, &block) ⇒ Document

Create a new document. This will instantiate a new document and insert it in a single call. Will always return the document whether save passed or not.

Examples:

Create a new document.

Person.create(:title => "Mr")

Parameters:

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

    The attributes to create with.

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

    A mass-assignment protection options. Supports :as and :without_protection

Returns:

  • (Document) —

    The newly created document.



208
209
210
211
212
 
# File 'lib/mongoid/persistence.rb', line 208

def create(attributes = {}, options = {}, &block)
  _creating do
    new(attributes, options, &block).tap { |doc| doc.save }
  end
end

#create!(attributes = {}, options = {}, &block) ⇒ Document

Create a new document. This will instantiate a new document and insert it in a single call. Will always return the document whether save passed or not, and if validation fails an error will be raise.

Examples:

Create a new document.

Person.create!(:title => "Mr")

Parameters:

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

    The attributes to create with.

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

    A mass-assignment protection options. Supports :as and :without_protection

Returns:

  • (Document) —

    The newly created document.



227
228
229
230
231
232
233
234
 
# File 'lib/mongoid/persistence.rb', line 227

def create!(attributes = {}, options = {}, &block)
  _creating do
    new(attributes, options, &block).tap do |doc|
      fail_validate!(doc) if doc.insert.errors.any?
      fail_callback!(doc, :create!) if doc.new?
    end
  end
end

#delete_all(conditions = nil) ⇒ Integer

Delete all documents given the supplied conditions. If no conditions are passed, the entire collection will be dropped for performance benefits. Does not fire any callbacks.

Examples:

Delete matching documents from the collection.

Person.delete_all(:conditions => { :title => "Sir" })

Delete all documents from the collection.

Person.delete_all

Parameters:

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

    Optional conditions to delete by.

Returns:

  • (Integer) —

    The number of documents deleted.



249
250
251
252
253
254
255
256
257
 
# File 'lib/mongoid/persistence.rb', line 249

def delete_all(conditions = nil)
  conds = conditions || {}
  selector = conds[:conditions] || conds
  selector.merge!(:_type => name) if hereditary?
  collection.find(selector).count.tap do
    collection.remove(selector, Safety.merge_safety_options)
    Threaded.clear_options!
  end
end

#destroy_all(conditions = nil) ⇒ Integer

Delete all documents given the supplied conditions. If no conditions are passed, the entire collection will be dropped for performance benefits. Fires the destroy callbacks if conditions were passed.

Examples:

Destroy matching documents from the collection.

Person.destroy_all(:conditions => { :title => "Sir" })

Destroy all documents from the collection.

Person.destroy_all

Parameters:

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

    Optional conditions to destroy by.

Returns:

  • (Integer) —

    The number of documents destroyed.



272
273
274
275
276
277
278
 
# File 'lib/mongoid/persistence.rb', line 272

def destroy_all(conditions = nil)
  conds = conditions || {}
  documents = where(conds[:conditions] || conds)
  documents.count.tap do
    documents.each { |doc| doc.destroy }
  end
end

#fail_callback!(document, method) ⇒ Object

Raise an error if a callback failed.

Examples:

Raise the callback error.

Person.fail_callback!(person, :create!)

Parameters:

  • document (Document) —

    The document to fail.

  • method (Symbol) —

    The method being called.

Raises:

Since:

  • 2.2.0



299
300
301
 
# File 'lib/mongoid/persistence.rb', line 299

def fail_callback!(document, method)
  raise Errors::Callback.new(document.class, method)
end

#fail_validate!(document) ⇒ Object

Raise an error if validation failed.

Examples:

Raise the validation error.

Person.fail_validate!(person)

Parameters:

  • document (Document) —

    The document to fail.

Raises:



286
287
288
 
# File 'lib/mongoid/persistence.rb', line 286

def fail_validate!(document)
  raise Errors::Validations.new(document)
end