deac/couchrest_model
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

documentation for Document#copy and #move, copied from Database

Browse source
This commit is contained in:
Matt Lyon 2009-02-01 23:34:30 -08:00 committed by Chris Anderson
parent 571cd257e0
commit 9b3b56bbf5
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/couchrest/core/document.rb
View file

@ -57,12 +57,18 @@ module CouchRest
result['ok'] result['ok']
end end
# copies the document to a new id. If the destination id currently exists, a rev must be provided.
# <tt>dest</tt> can take one of two forms if overwriting: "id_to_overwrite?rev=revision" or the actual doc
# hash with a '_rev' key
def copy(dest) def copy(dest)
raise ArgumentError, "doc.database required to copy" unless database raise ArgumentError, "doc.database required to copy" unless database
result = database.copy(self, dest) result = database.copy(self, dest)
result['ok'] result['ok']
end end
# moves the document to a new id. If the destination id currently exists, a rev must be provided.
# <tt>dest</tt> can take one of two forms if overwriting: "id_to_overwrite?rev=revision" or the actual doc
# hash with a '_rev' key
def move(dest) def move(dest)
raise ArgumentError, "doc.database required to copy" unless database raise ArgumentError, "doc.database required to copy" unless database
result = database.move(self, dest) result = database.move(self, dest)