mirror of https://gitee.com/bigwinds/arangodb
added documentation for new simple methods
This commit is contained in:
parent
f1c3039a08
commit
855c1465fd
|
@ -40,6 +40,10 @@
|
|||
<!-- arangod/V8Server/v8-vocbase.cpp -->
|
||||
@startDocuBlock documentsCollectionExists
|
||||
|
||||
!SUBSECTION Lookup By Keys
|
||||
<!-- arangod/V8Server/v8-query.cpp-->
|
||||
@startDocuBlock collectionLookupByKeys
|
||||
|
||||
!SUBSECTION Insert
|
||||
<!-- arangod/V8Server/v8-vocbase.cpp -->
|
||||
@startDocuBlock documentsCollectionInsert
|
||||
|
@ -56,6 +60,10 @@
|
|||
<!-- arangod/V8Server/v8-vocbase.cpp -->
|
||||
@startDocuBlock documentsCollectionRemove
|
||||
|
||||
!SUBSECTION Remove By Keys
|
||||
<!-- arangod/V8Server/v8-query.cpp-->
|
||||
@startDocuBlock collectionRemoveByKeys
|
||||
|
||||
!SUBSECTION Remove By Example
|
||||
<!-- js/common/modules/org/arangodb/arango-collection-common.js-->
|
||||
@startDocuBlock documentsCollectionRemoveByExample
|
||||
|
|
|
@ -210,7 +210,7 @@ bool RestSimpleHandler::wasCancelled () {
|
|||
/// ~ db._drop(cn);
|
||||
/// db._create(cn);
|
||||
/// keys = [ ];
|
||||
/// for (i = 0; i < 10; ++i) {
|
||||
/// for (var i = 0; i < 10; ++i) {
|
||||
/// db.test.insert({ _key: "test" + i });
|
||||
/// keys.push("test" + i);
|
||||
/// }
|
||||
|
@ -230,7 +230,7 @@ bool RestSimpleHandler::wasCancelled () {
|
|||
/// ~ db._drop(cn);
|
||||
/// db._create(cn);
|
||||
/// keys = [ ];
|
||||
/// for (i = 0; i < 10; ++i) {
|
||||
/// for (var i = 0; i < 10; ++i) {
|
||||
/// db.test.insert({ _key: "test" + i });
|
||||
/// }
|
||||
///
|
||||
|
@ -399,7 +399,7 @@ void RestSimpleHandler::removeByKeys (TRI_json_t const* json) {
|
|||
/// db.test.insert({ _key: "test" + i, value: i });
|
||||
/// }
|
||||
///
|
||||
/// var url = "/_api/simple/remove-by-keys";
|
||||
/// var url = "/_api/simple/lookup-by-keys";
|
||||
/// var data = { keys: [ "foo", "bar", "baz" ], collection: cn };
|
||||
/// var response = logCurlRequest('PUT', url, JSON.stringify(data));
|
||||
///
|
||||
|
|
|
@ -2230,7 +2230,7 @@ static void FulltextQuery (SingleCollectionReadOnlyTransaction& trx,
|
|||
/// @EXAMPLE_ARANGOSH_OUTPUT{collectionFulltext}
|
||||
/// ~ db._drop("emails");
|
||||
/// ~ db._create("emails");
|
||||
/// db.emails.ensureFulltextIndex("content").id;
|
||||
/// db.emails.ensureFulltextIndex("content");
|
||||
/// db.emails.save({ content: "Hello Alice, how are you doing? Regards, Bob" });
|
||||
/// db.emails.save({ content: "Hello Charlie, do Alice and Bob know about it?" });
|
||||
/// db.emails.save({ content: "I think they don't know. Regards, Eve" });
|
||||
|
@ -2586,7 +2586,30 @@ static void JS_WithinQuery (const v8::FunctionCallbackInfo<v8::Value>& args) {
|
|||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief looks up documents by their keys
|
||||
/// @brief fetches multiple documents by their keys
|
||||
/// @startDocuBlock collectionLookupByKeys
|
||||
/// `collection.lookupByKeys(keys)`
|
||||
///
|
||||
/// Looks up the documents in the specified collection using the array of keys
|
||||
/// provided. All documents for which a matching key was specified in the *keys*
|
||||
/// array and that exist in the collection will be returned.
|
||||
/// Keys for which no document can be found in the underlying collection are ignored,
|
||||
/// and no exception will be thrown for them.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @EXAMPLE_ARANGOSH_OUTPUT{collectionLookupByKeys}
|
||||
/// ~ db._drop("example");
|
||||
/// ~ db._create("example");
|
||||
/// keys = [ ];
|
||||
/// | for (var i = 0; i < 10; ++i) {
|
||||
/// | db.example.insert({ _key: "test" + i, value: i });
|
||||
/// | keys.push("test" + i);
|
||||
/// }
|
||||
/// db.example.lookupByKeys(keys);
|
||||
/// ~ db._drop("example");
|
||||
/// @END_EXAMPLE_ARANGOSH_OUTPUT
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
static void JS_LookupByKeys (const v8::FunctionCallbackInfo<v8::Value>& args) {
|
||||
|
@ -2646,7 +2669,34 @@ static void JS_LookupByKeys (const v8::FunctionCallbackInfo<v8::Value>& args) {
|
|||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief looks up documents by their keys
|
||||
/// @brief removes multiple documents by their keys
|
||||
/// @startDocuBlock collectionRemoveByKeys
|
||||
/// `collection.removeByKeys(keys)`
|
||||
///
|
||||
/// Looks up the documents in the specified collection using the array of keys
|
||||
/// provided, and removes all documents from the collection whose keys are
|
||||
/// contained in the *keys* array. Keys for which no document can be found in
|
||||
/// the underlying collection are ignored, and no exception will be thrown for
|
||||
/// them.
|
||||
///
|
||||
/// The method will return an object containing the number of removed documents
|
||||
/// in the *removed* sub-attribute, and the number of not-removed/ignored
|
||||
/// documents in the *ignored* sub-attribute.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
/// @EXAMPLE_ARANGOSH_OUTPUT{collectionRemoveByKeys}
|
||||
/// ~ db._drop("example");
|
||||
/// ~ db._create("example");
|
||||
/// keys = [ ];
|
||||
/// | for (var i = 0; i < 10; ++i) {
|
||||
/// | db.example.insert({ _key: "test" + i, value: i });
|
||||
/// | keys.push("test" + i);
|
||||
/// }
|
||||
/// db.example.removeByKeys(keys);
|
||||
/// ~ db._drop("example");
|
||||
/// @END_EXAMPLE_ARANGOSH_OUTPUT
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
static void JS_RemoveByKeys (const v8::FunctionCallbackInfo<v8::Value>& args) {
|
||||
|
|
Loading…
Reference in New Issue