Class: CouchRest::Document

Inherits:
Response show all
Includes:
Mixins::Attachments
Defined in:
lib/couchrest/core/document.rb

Direct Known Subclasses

Design, ExtendedDocument

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from Mixins::Attachments

#delete_attachment, #fetch_attachment, #put_attachment

Methods inherited from Response

#[], #[]=, #initialize

Methods inherited from Hash

===

Constructor Details

This class inherits a constructor from CouchRest::Response

Instance Attribute Details

- (Object) database

Returns the document's database



78
79
80
# File 'lib/couchrest/core/document.rb', line 78

def database
  @database
end

Class Method Details

+ (Object) use_database(db)

override the CouchRest::Model-wide default_database This is not a thread safe operation, do not change the model database at runtime.



13
14
15
# File 'lib/couchrest/core/document.rb', line 13

def self.use_database(db)
  self.database = db
end

Instance Method Details

- (Object) copy(dest)

copies the document to a new id. If the destination id currently exists, a rev must be provided. dest can take one of two forms if overwriting: “id_to_overwrite?rev=revision” or the actual doc hash with a '_rev' key

Raises:

  • (ArgumentError)


59
60
61
62
63
# File 'lib/couchrest/core/document.rb', line 59

def copy(dest)
  raise ArgumentError, "doc.database required to copy" unless database
  result = database.copy_doc(self, dest)
  result['ok']
end

- (Object) destroy(bulk = false)

Deletes the document from the database. Runs the :delete callbacks. Removes the _id and _rev fields, preparing the document to be saved to a new _id. If bulk is true (defaults to false) the document won't actually be deleted from the db until bulk save.

Raises:

  • (ArgumentError)


46
47
48
49
50
51
52
53
54
# File 'lib/couchrest/core/document.rb', line 46

def destroy(bulk = false)
  raise ArgumentError, "doc.database required to destroy" unless database
  result = database.delete_doc(self, bulk)
  if result['ok']
    self['_rev'] = nil
    self['_id'] = nil
  end
  result['ok']
end

- (Object) id



17
18
19
# File 'lib/couchrest/core/document.rb', line 17

def id
  self['_id']
end

- (Boolean) new? Also known as: new_document?

returns true if the document has never been saved

Returns:

  • (Boolean)


26
27
28
# File 'lib/couchrest/core/document.rb', line 26

def new?
  !rev
end

- (Object) rev



21
22
23
# File 'lib/couchrest/core/document.rb', line 21

def rev
  self['_rev']
end

- (Object) save(bulk = false)

Saves the document to the db using create or update. Also runs the :save callbacks. Sets the _id and _rev fields based on CouchDB's response. If bulk is true (defaults to false) the document is cached for bulk save.

Raises:

  • (ArgumentError)


35
36
37
38
39
# File 'lib/couchrest/core/document.rb', line 35

def save(bulk = false)
  raise ArgumentError, "doc.database required for saving" unless database
  result = database.save_doc self, bulk
  result['ok']
end

- (Object) uri(append_rev = false)

Returns the CouchDB uri for the document



66
67
68
69
70
71
72
73
74
75
# File 'lib/couchrest/core/document.rb', line 66

def uri(append_rev = false)
  return nil if new?
  couch_uri = "#{database.root}/#{CGI.escape(id)}"
  if append_rev == true
    couch_uri << "?rev=#{rev}"
  elsif append_rev.kind_of?(Integer)
    couch_uri << "?rev=#{append_rev}"
  end
  couch_uri
end