Module: Mongoid::Finders

Defined in:
lib/mongoid/finders.rb

Overview

:nodoc:

Instance Method Summary collapse

Instance Method Details

#all(*args) ⇒ Object

Find Documents given the conditions.

Options:

args: A Hash with a conditions key and other options

Person.all(:conditions => { :attribute => "value" })



21
22
23
 
# File 'lib/mongoid/finders.rb', line 21

def all(*args)
  find(:all, *args)
end

#count(*args) ⇒ Object

Returns a count of matching records in the database based on the provided arguments.

Person.count(:first, :conditions => { :attribute => "value" })



29
30
31
 
# File 'lib/mongoid/finders.rb', line 29

def count(*args)
  Criteria.translate(self, *args).count
end

#criteria ⇒ Object

Helper to initialize a new Criteria object for this class.

Example:

Person.criteria



38
39
40
 
# File 'lib/mongoid/finders.rb', line 38

def criteria
  Criteria.new(self)
end

#find(*args) ⇒ Object

Find a Document in several different ways.

If a String is provided, it will be assumed that it is a representation of a Mongo::ObjectId and will attempt to find a single Document based on that id. If a Symbol and Hash is provided then it will attempt to find either a single Document or multiples based on the conditions provided and the first parameter.

Person.find(:first, :conditions => { :attribute => "value" })

Person.find(:all, :conditions => { :attribute => "value" })

Person.find(Mongo::ObjectId.new.to_s)

Raises:



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/mongoid/finders.rb', line 55

def find(*args)
  raise Errors::InvalidOptions.new("Calling Document#find with nil is invalid") if args[0].nil?
  type = args.delete_at(0) if args[0].is_a?(Symbol)
  criteria = Criteria.translate(self, *args)
  case type
  when :first then return criteria.one
  when :last then return criteria.last
  else
    return criteria
  end
end

#find_or_create_by(attrs = {}) ⇒ Object

Find the first Document given the conditions, or creates a new document with the conditions that were supplied

Options:

args: A Hash of attributes

Person.find_or_create_by(:attribute => "value")



75
76
77
 
# File 'lib/mongoid/finders.rb', line 75

def find_or_create_by(attrs = {})
  find_or(:create, attrs)
end

#find_or_initialize_by(attrs = {}) ⇒ Object

Find the first Document given the conditions, or instantiates a new document with the conditions that were supplied

Options:

args: A Hash of attributes

Person.find_or_initialize_by(:attribute => "value")



87
88
89
 
# File 'lib/mongoid/finders.rb', line 87

def find_or_initialize_by(attrs = {})
  find_or(:new, attrs)
end

#first(*args) ⇒ Object

Find the first Document given the conditions.

Options:

args: A Hash with a conditions key and other options

Person.first(:conditions => { :attribute => "value" })



98
99
100
 
# File 'lib/mongoid/finders.rb', line 98

def first(*args)
  find(:first, *args)
end

#last(*args) ⇒ Object

Find the last Document given the conditions.

Options:

args: A Hash with a conditions key and other options

Person.last(:conditions => { :attribute => "value" })



109
110
111
 
# File 'lib/mongoid/finders.rb', line 109

def last(*args)
  find(:last, *args)
end

#paginate(params = {}) ⇒ Object

Find all documents in paginated fashion given the supplied arguments. If no parameters are passed just default to offset 0 and limit 20.

Options:

params: A Hash of params to pass to the Criteria API.

Example:

Person.paginate(:conditions => { :field => "Test" }, :page => 1, :per_page => 20)

Returns paginated array of docs.



126
127
128
 
# File 'lib/mongoid/finders.rb', line 126

def paginate(params = {})
  Criteria.translate(self, params).paginate
end