Class: CouchPotato::Database

Inherits:
Object
  • Object
show all
Defined in:
lib/couch_potato/database.rb

Defined Under Namespace

Classes: ValidationsFailedError

Class Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(couchrest_database) ⇒ Database



11
12
13
# File 'lib/couch_potato/database.rb', line 11

def initialize(couchrest_database)
  @couchrest_database = couchrest_database
end

Class Attribute Details

.max_conflict_retriesObject

Returns the value of attribute max_conflict_retries



4
5
6
# File 'lib/couch_potato/database.rb', line 4

def max_conflict_retries
  @max_conflict_retries
end

.max_conflict_sleep_timeObject

Returns the value of attribute max_conflict_sleep_time



4
5
6
# File 'lib/couch_potato/database.rb', line 4

def max_conflict_sleep_time
  @max_conflict_sleep_time
end

Instance Method Details

#couchrest_databaseObject

returns the underlying CouchRest::Database instance



154
155
156
# File 'lib/couch_potato/database.rb', line 154

def couchrest_database
  @couchrest_database
end

#destroy_document(document) ⇒ Object Also known as: destroy



107
108
109
110
111
112
113
# File 'lib/couch_potato/database.rb', line 107

def destroy_document(document)
  begin
    destroy_document_without_conflict_handling document
  rescue RestClient::Conflict
    retry if document = document.reload
  end
end

#first(spec) ⇒ Object

returns the first result from a #view query or nil



65
66
67
68
# File 'lib/couch_potato/database.rb', line 65

def first(spec)
  spec.view_parameters = spec.view_parameters.merge({:limit => 1})
  view(spec).first
end

#first!(spec) ⇒ Object

returns th first result from a #view or raises CouchPotato::NotFound



71
72
73
# File 'lib/couch_potato/database.rb', line 71

def first!(spec)
  first(spec) || raise(CouchPotato::NotFound)
end

#inspectObject

:nodoc:



149
150
151
# File 'lib/couch_potato/database.rb', line 149

def inspect #:nodoc:
  "#<CouchPotato::Database @root=\"#{couchrest_database.root}\">"
end

#load!(id) ⇒ Object

loads one or more documents by its id(s) behaves like #load except it raises a CouchPotato::NotFound if any of the documents could not be found



140
141
142
143
144
145
146
147
# File 'lib/couch_potato/database.rb', line 140

def load!(id)
  doc = load(id)
  if id.is_a?(Array)
    missing_docs = id - doc.map(&:id)
  end
  raise(CouchPotato::NotFound, missing_docs.try(:join, ', ')) if doc.nil? || missing_docs.try(:any?)
  doc
end

#load_document(id) ⇒ Object Also known as: load

loads a document by its id(s) id - either a single id or an array of ids returns either a single document or an array of documents (if an array of ids was passed). returns nil if the single document could not be found. when passing an array and some documents could not be found these are omitted from the returned array



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/couch_potato/database.rb', line 121

def load_document(id)
  raise "Can't load a document without an id (got nil)" if id.nil?

  if id.is_a?(Array)
    bulk_load id
  else
    begin
      instance = couchrest_database.get(id)
      instance.database = self
      instance
    rescue(RestClient::ResourceNotFound)
      nil
    end
  end
end

#save_document(document, validate = true, &block) ⇒ Object Also known as: save

saves a document. returns true on success, false on failure. if passed a block will:

  • yield the object to be saved to the block and run if once before saving

  • on conflict: reload the document, run the block again and retry saving



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/couch_potato/database.rb', line 79

def save_document(document, validate = true, &block)
  retries = 0
  begin
    block.call document if block
    save_document_without_conflict_handling(document, validate)
  rescue RestClient::Conflict => e
    if block
      document = document.reload
      if retries == self.class.max_conflict_retries
        raise CouchPotato::Conflict.new
      else
        retries += 1
        sleep rand * self.class.max_conflict_sleep_time if self.class.max_conflict_sleep_time > 0
        retry
      end
    else
      raise e
    end
  end
end

#save_document!(document) ⇒ Object Also known as: save!

saves a document, raises a CouchPotato::Database::ValidationsFailedError on failure



102
103
104
# File 'lib/couch_potato/database.rb', line 102

def save_document!(document)
  save_document(document) || raise(ValidationsFailedError.new(document.errors.full_messages))
end

#view(spec) ⇒ Object

executes a view and return the results. you pass in a view spec which is usually a result of a SomePersistentClass.some_view call.

Example:

class User
  include CouchPotato::Persistence
  property :age
  view :all, key: :age
end
db = CouchPotato.database

db.view(User.all) # => [user1, user2]

You can pass the usual parameters you can pass to a couchdb view to the view:

db.view(User.all(limit: 5, startkey: 2, reduce: false))

For your convenience when passing a hash with only a key parameter you can just pass in the value

db.view(User.all(key: 1)) == db.view(User.all(1))

Instead of passing a startkey and endkey you can pass in a key with a range:

db.view(User.all(key: 1..20)) == db.view(startkey: 1, endkey: 20) == db.view(User.all(1..20))

You can also pass in multiple keys:

db.view(User.all(keys: [1, 2, 3]))


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/couch_potato/database.rb', line 44

def view(spec)
  results = CouchPotato::View::ViewQuery.new(
    couchrest_database,
    spec.design_document,
    {spec.view_name => {
      :map => spec.map_function,
      :reduce => spec.reduce_function
    }
    },
    ({spec.list_name => spec.list_function} unless spec.list_name.nil?),
    spec.lib,
    spec.language
  ).query_view!(spec.view_parameters)
  processed_results = spec.process_results results
  processed_results.each do |document|
    document.database = self if document.respond_to?(:database=)
  end if processed_results.respond_to?(:each)
  processed_results
end