Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

added documentation for collection.revision()

This commit is contained in:
Jan Steemann 2013-01-21 09:19:03 +01:00
parent 3f3987e6a4
commit 08516043eb
2 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
arangod/Documentation/shell-collection.dox
View File

@ -48,20 +48,21 @@
/// <li>@ref ShellCollectionCollectionMethods
/// <ul>
/// <li>@ref ShellCollectionDrop "collection.drop"</li>
/// <li>@ref ShellCollectionTruncate "collection.truncate"</li>
/// <li>@ref ShellCollectionProperties "collection.properties"</li>
/// <li>@ref ShellCollectionFigures "collection.figures"</li>
/// <li>@ref ShellCollectionProperties "collection.properties"</li>
/// <li>@ref ShellCollectionRevision "collection.revision"</li>
/// <li>@ref ShellCollectionLoad "collection.load"</li>
/// <li>@ref ShellCollectionUnload "collection.unload"</li>
/// <li>@ref ShellCollectionUnload "collection.rename"</li>
/// <li>@ref ShellCollectionTruncate "collection.truncate"</li>
/// </ul>
/// </li>
/// <li>@ref ShellCollectionDatabaseMethods
/// <ul>
/// <li>@ref ShellCollectionRead "db._collection"</li>
/// <li>@ref ShellCollectionCreate "db._create"</li>
/// <li>@ref ShellCollectionReadAll "db._collections"</li>
/// <li>@ref ShellCollectionReadShortCut "db.collection-name"</li>
/// <li>@ref ShellCollectionCreate "db._create"</li>
/// <li>@ref ShellCollectionDropDb "db._drop"</li>
/// <li>@ref ShellCollectionTruncateDb "db._truncate"</li>
/// </ul>
@ -114,8 +115,7 @@
///
/// @LIT{db._collection("demo")}
///
/// If no collection with such a name or identifier exists, then
/// @LIT{null} is returned.
/// If no collection with such a name exists, then @LIT{null} is returned.
///
/// There is a short-cut that can be used for non-system collections:
///
@ -156,6 +156,10 @@
/// @copydetails JS_LoadVocbaseCol
///
/// @CLEARPAGE
/// @anchor ShellCollectionRevision
/// @copydetails JS_RevisionVocbaseCol
///
/// @CLEARPAGE
/// @anchor ShellCollectionUnload
/// @copydetails JS_UnloadVocbaseCol
///

15
arangod/V8Server/v8-vocbase.cpp
View File

@ -5000,7 +5000,20 @@ static v8::Handle<v8::Value> JS_StatusVocbaseCol (v8::Arguments const& argv) {
////////////////////////////////////////////////////////////////////////////////
/// @brief returns the revision id of a collection
/// the revision id is updated when the document data in a collection changes
///
/// @FUN{@FA{collection}.revision()}
///
/// Returns the revision id of the collection
///
/// The revision id is updated when the document data is modified, either by
/// inserting, deleting, updating or replacing documents in it.
///
/// The revision id of a collection can be used by clients to check whether
/// data in a collection has changed or if it is still unmodified since a
/// previous fetch of the revision id.
///
/// The revision id returned is a string value. Clients should treat this value
/// as an opaque string, and only use it for equality/non-equality comparisons.
////////////////////////////////////////////////////////////////////////////////
static v8::Handle<v8::Value> JS_RevisionVocbaseCol (v8::Arguments const& argv) {