Module: CouchRest::Mixins::DocumentQueries::ClassMethods

Defined in:
lib/couchrest/mixins/document_queries.rb

Instance Method Summary collapse

Instance Method Details

#all(opts = {}, &block) ⇒ Object

Load all documents that have the “couchrest-type” field equal to the name of the current class. Take the standard set of CouchRest::Database#view options.



14
15
16
 
# File 'lib/couchrest/mixins/document_queries.rb', line 14

def all(opts = {}, &block)
  view(:all, opts, &block)
end

#first(opts = {}) ⇒ Object

Load the first document that have the “couchrest-type” field equal to the name of the current class.

Returns

Object

The first object instance available

or

Nil

if no instances available

Parameters

opts<Hash>

View options, see CouchRest::Database#view options for more info.



29
30
31
32
 
# File 'lib/couchrest/mixins/document_queries.rb', line 29

def first(opts = {})
  first_instance = self.all(opts.merge!(:limit => 1))
  first_instance.empty? ? nil : first_instance.first
end

#get(id, db = database) ⇒ Object

Load a document from the database by id



35
36
37
38
 
# File 'lib/couchrest/mixins/document_queries.rb', line 35

def get(id, db = database)
  doc = db.get id
  new(doc)
end