1
0
Fork 0

Add examples to database basics

This commit is contained in:
Willi Goesgens 2015-08-12 11:11:30 +02:00
parent c3c6220eeb
commit e66b5907f6
1 changed files with 24 additions and 0 deletions

View File

@ -2864,6 +2864,12 @@ static void MapGetVocBase (v8::Local<v8::String> const name,
///
/// Returns the server version string. Note that this is not the version of the
/// database.
///
/// @EXAMPLES
///
/// @EXAMPLE_ARANGOSH_OUTPUT{dbVersion}
/// require("internal").db._version();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////
@ -2880,6 +2886,12 @@ static void JS_VersionServer (const v8::FunctionCallbackInfo<v8::Value>& args) {
/// `db._path()`
///
/// Returns the filesystem path of the current database as a string.
///
/// @EXAMPLES
///
/// @EXAMPLE_ARANGOSH_OUTPUT{dbPath}
/// require("internal").db._path();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////
@ -2902,6 +2914,12 @@ static void JS_PathDatabase (const v8::FunctionCallbackInfo<v8::Value>& args) {
/// `db._id()`
///
/// Returns the id of the current database as a string.
///
/// @EXAMPLES
///
/// @EXAMPLE_ARANGOSH_OUTPUT{dbId}
/// require("internal").db._id();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////
@ -2924,6 +2942,12 @@ static void JS_IdDatabase (const v8::FunctionCallbackInfo<v8::Value>& args) {
/// `db._name()`
///
/// Returns the name of the current database as a string.
///
/// @EXAMPLES
///
/// @EXAMPLE_ARANGOSH_OUTPUT{dbName}
/// require("internal").db._name();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// @endDocuBlock
////////////////////////////////////////////////////////////////////////////////