From be81400ac001a0da72870bc8078c32e0744cd19b Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:31:45 +0200 Subject: [PATCH 01/33] Update ViewAccess.md --- docs/Drivers/Java/Reference/Database/ViewAccess.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Drivers/Java/Reference/Database/ViewAccess.md b/docs/Drivers/Java/Reference/Database/ViewAccess.md index 1118dc4fc..691c1b50d 100644 --- a/docs/Drivers/Java/Reference/Database/ViewAccess.md +++ b/docs/Drivers/Java/Reference/Database/ViewAccess.md @@ -1,7 +1,7 @@ -# Accessing views +# Accessing Views These functions implement the -[HTTP API for accessing view](https://docs.arangodb.com/latest/HTTP/Views/Getting.html). +[HTTP API for accessing View](https://docs.arangodb.com/latest/HTTP/Views/index.html). ## ArangoDatabase.view From bb5db75e21d34cadd8938955a13be7078a231ca0 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:32:56 +0200 Subject: [PATCH 02/33] Update Serialization.md --- docs/Drivers/Java/Reference/Serialization.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/Drivers/Java/Reference/Serialization.md b/docs/Drivers/Java/Reference/Serialization.md index 27126ff77..42cf616ee 100644 --- a/docs/Drivers/Java/Reference/Serialization.md +++ b/docs/Drivers/Java/Reference/Serialization.md @@ -7,7 +7,8 @@ registering additional `VPackModule`s on `ArangoDB.Builder`. ### Java 8 types -GitHub: https://github.com/arangodb/java-velocypack-module-jdk8 +GitHub: +[github.com/arangodb/java-velocypack-module-jdk8](https://github.com/arangodb/java-velocypack-module-jdk8) Added support for: @@ -38,7 +39,8 @@ ArangoDB arangoDB = new ArangoDB.Builder().registerModule(new VPackJdk8Module()) ### Scala types -GitHub: https://github.com/arangodb/java-velocypack-module-scala +GitHub: +[github.com/arangodb/java-velocypack-module-scala](https://github.com/arangodb/java-velocypack-module-scala) Added support for: @@ -64,7 +66,8 @@ val arangoDB: ArangoDB = new ArangoDB.Builder().registerModule(new VPackScalaMod ### Joda-Time -GitHub: https://github.com/arangodb/java-velocypack-module-joda +GitHub: +[github.com/arangodb/java-velocypack-module-joda](https://github.com/arangodb/java-velocypack-module-joda) Added support for: From 52272fd8f7fc79cee4d065d889462f3d0ad1f713 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:34:26 +0200 Subject: [PATCH 03/33] Rename ArangoSearch.md to Arangosearch.md --- .../Java/Reference/View/{ArangoSearch.md => Arangosearch.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/Drivers/Java/Reference/View/{ArangoSearch.md => Arangosearch.md} (100%) diff --git a/docs/Drivers/Java/Reference/View/ArangoSearch.md b/docs/Drivers/Java/Reference/View/Arangosearch.md similarity index 100% rename from docs/Drivers/Java/Reference/View/ArangoSearch.md rename to docs/Drivers/Java/Reference/View/Arangosearch.md From 234012b18e575212493f9674cef7ebbe1638744f Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:35:04 +0200 Subject: [PATCH 04/33] Fix link View/Arangosearch.md --- docs/Drivers/Java/Reference/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/README.md b/docs/Drivers/Java/Reference/README.md index ea6307f54..e782786f7 100644 --- a/docs/Drivers/Java/Reference/README.md +++ b/docs/Drivers/Java/Reference/README.md @@ -18,7 +18,7 @@ - [Bulk Import](Collection/BulkImport.md) - [View](View/README.md) - [View Manipulation](View/ViewManipulation.md) - - [ArangoSearch Views](View/ArangoSearch.md) + - [ArangoSearch Views](View/Arangosearch.md) - [Analyzers](View/Analyzers.md) - [Cursor](Cursor.md) - [Graph](Graph/README.md) From 5474c837b54076544b83d836706072c1af66a37c Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:37:39 +0200 Subject: [PATCH 05/33] Update ViewManipulation.md --- docs/Drivers/Java/Reference/View/ViewManipulation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Drivers/Java/Reference/View/ViewManipulation.md b/docs/Drivers/Java/Reference/View/ViewManipulation.md index e995f3bcf..1faecb2bb 100644 --- a/docs/Drivers/Java/Reference/View/ViewManipulation.md +++ b/docs/Drivers/Java/Reference/View/ViewManipulation.md @@ -1,7 +1,7 @@ -# Manipulating the view +# Manipulating the View -These functions implement -[the HTTP API for modifying views](https://docs.arangodb.com/latest/HTTP/Views/Modifying.html). +These functions implement the +[HTTP API for modifying Views](https://www.arangodb.com/docs/devel/http/views.html). ## ArangoDatabase.createView From 2a3f19a6b20629d229e962692077add6d972357a Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:38:55 +0200 Subject: [PATCH 06/33] Update README.md --- docs/Drivers/Java/Reference/View/README.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/Drivers/Java/Reference/View/README.md b/docs/Drivers/Java/Reference/View/README.md index 82e99e6b8..4dcae6432 100644 --- a/docs/Drivers/Java/Reference/View/README.md +++ b/docs/Drivers/Java/Reference/View/README.md @@ -1,14 +1,10 @@ # View API These functions implement the -[HTTP API for views](https://docs.arangodb.com/latest/HTTP/Views/index.html). +[HTTP API for Views](https://www.arangodb.com/docs/devel/http/views.html). ## Getting information about the view -See -[the HTTP API documentation](https://docs.arangodb.com/latest/HTTP/Views/Getting.html) -for details. - ## ArangoView.exists `ArangoView.exists() : boolean` From aace56e51664a3355e8eefe363c3ddd081c3723f Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:39:39 +0200 Subject: [PATCH 07/33] 6_3 -> 6_4 --- docs/Drivers/Java/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/README.md b/docs/Drivers/Java/README.md index c0251f8ae..1c19b3c15 100644 --- a/docs/Drivers/Java/README.md +++ b/docs/Drivers/Java/README.md @@ -16,5 +16,5 @@ driver in version 6.2.0. See - [ChangeLog](https://raw.githubusercontent.com/arangodb/arangodb-java-driver/master/ChangeLog.md) - [Examples](https://github.com/arangodb/arangodb-java-driver/tree/master/src/test/java/com/arangodb/example) - [Tutorial](https://www.arangodb.com/tutorials/tutorial-sync-java-driver/) -- [JavaDoc](http://arangodb.github.io/arangodb-java-driver/javadoc-6_3/index.html) +- [JavaDoc](http://arangodb.github.io/arangodb-java-driver/javadoc-6_4/index.html) - [JavaDoc VelocyPack](http://arangodb.github.io/java-velocypack/javadoc-1_0/index.html) From 5b4d27b88ec9bdcdce2b5563e116bd18db0bffae Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:41:05 +0200 Subject: [PATCH 08/33] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 409cd1aa3..a36b89a27 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![ArangoDB-Logo](https://docs.arangodb.com/assets/arangodb_logo_2016_inverted.png) +![ArangoDB-Logo](https://www.arangodb.com/docs/assets/arangodb_logo_2016_inverted.png) # ArangoDB Java Driver @@ -17,4 +17,4 @@ The official ArangoDB Java Driver. - [Examples](src/test/java/com/arangodb/example) - [Examples Async](src/test/java/com/arangodb/async/example) - [Tutorial](https://www.arangodb.com/tutorials/tutorial-sync-java-driver/) -- [JavaDoc](http://arangodb.github.io/arangodb-java-driver/javadoc-6_4) +- [JavaDoc](http://arangodb.github.io/arangodb-java-driver/javadoc-6_4/) From d5b070bd4bd8e7612a1df6cf86fcb9abb953d57f Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:42:47 +0200 Subject: [PATCH 09/33] Update README.md --- docs/Drivers/Java/Reference/Collection/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Drivers/Java/Reference/Collection/README.md b/docs/Drivers/Java/Reference/Collection/README.md index 43de5a013..076c0f6d2 100644 --- a/docs/Drivers/Java/Reference/Collection/README.md +++ b/docs/Drivers/Java/Reference/Collection/README.md @@ -1,7 +1,7 @@ # Collection API These functions implement the -[HTTP API for collections](https://docs.arangodb.com/latest/HTTP/Collection/index.html). +[HTTP API for collections](https://www.arangodb.com/docs/devel/http/collection.html). The _ArangoCollection_ API is used for all collections, regardless of their specific type (document/edge collection). @@ -9,7 +9,7 @@ their specific type (document/edge collection). ## Getting information about the collection See -[the HTTP API documentation](https://docs.arangodb.com/latest/HTTP/Collection/Getting.html) +[the HTTP API documentation](https://www.arangodb.com/docs/devel/http/collection-getting.html) for details. ## ArangoCollection.exists From f040c3f7b042f44222203c1dbd9e74c49585ac50 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:43:41 +0200 Subject: [PATCH 10/33] Update DatabaseManipulation.md --- docs/Drivers/Java/Reference/Database/DatabaseManipulation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md b/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md index 71b5024ab..aae7c6783 100644 --- a/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md +++ b/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md @@ -1,7 +1,7 @@ # Manipulation databases These functions implement the -[HTTP API for manipulating databases](https://docs.arangodb.com/latest/HTTP/Database/index.html). +[HTTP API for manipulating databases](https://www.arangodb.com/docs/devel/http/database.html). ## ArangoDB.createDatabase From 93d10097566d7c84ae8a624d84b7056f1c392a6b Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:44:14 +0200 Subject: [PATCH 11/33] Update AqlUserFunctions.md --- docs/Drivers/Java/Reference/Database/AqlUserFunctions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md b/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md index 586634691..dc4321e49 100644 --- a/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md +++ b/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md @@ -1,7 +1,7 @@ # Managing AQL user functions These functions implement the -[HTTP API for managing AQL user functions](https://docs.arangodb.com/latest/HTTP/AqlUserFunctions/index.html). +[HTTP API for managing AQL user functions](https://www.arangodb.com/docs/devel/http/aql-user-functions.html). ## ArangoDatabase.getAqlFunctions From 6d855fd520427aeec840fc01de08e2cc6d7dfaaf Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:44:37 +0200 Subject: [PATCH 12/33] Update CollectionAccess.md --- docs/Drivers/Java/Reference/Database/CollectionAccess.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Database/CollectionAccess.md b/docs/Drivers/Java/Reference/Database/CollectionAccess.md index 48cb8fcac..48cfe5c01 100644 --- a/docs/Drivers/Java/Reference/Database/CollectionAccess.md +++ b/docs/Drivers/Java/Reference/Database/CollectionAccess.md @@ -1,7 +1,7 @@ # Accessing collections These functions implement the -[HTTP API for accessing collections](https://docs.arangodb.com/latest/HTTP/Collection/Getting.html). +[HTTP API for accessing collections](https://www.arangodb.com/docs/devel/http/collection-getting.html). ## ArangoDatabase.collection From 22f84ac271d499c7a163518adeb85ce643759f36 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:45:01 +0200 Subject: [PATCH 13/33] Update GraphAccess.md --- docs/Drivers/Java/Reference/Database/GraphAccess.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Database/GraphAccess.md b/docs/Drivers/Java/Reference/Database/GraphAccess.md index a1e74f48b..2afdd283c 100644 --- a/docs/Drivers/Java/Reference/Database/GraphAccess.md +++ b/docs/Drivers/Java/Reference/Database/GraphAccess.md @@ -1,7 +1,7 @@ # Accessing graphs These functions implement the -[HTTP API for accessing general graphs](https://docs.arangodb.com/latest/HTTP/Gharial/index.html). +[HTTP API for accessing general graphs](https://www.arangodb.com/docs/devel/http/gharial.html). ## ArangoDatabase.graph From c8c82486dec8c97e2bb95d347318c86f533e365f Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:45:34 +0200 Subject: [PATCH 14/33] Update Queries.md --- docs/Drivers/Java/Reference/Database/Queries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Database/Queries.md b/docs/Drivers/Java/Reference/Database/Queries.md index 4dd437fa7..e7e152260 100644 --- a/docs/Drivers/Java/Reference/Database/Queries.md +++ b/docs/Drivers/Java/Reference/Database/Queries.md @@ -1,7 +1,7 @@ # Queries This function implements the -[HTTP API for single roundtrip AQL queries](https://docs.arangodb.com/latest/HTTP/AqlQueryCursor/QueryResults.html). +[HTTP API for single roundtrip AQL queries](https://www.arangodb.com/docs/devel/http/aql-query-cursor-query-results.html). ## ArangoDatabase.query From 88d2ad70eb10d5b10ee991159c34378d638e95a5 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:46:01 +0200 Subject: [PATCH 15/33] Update StreamTransactions.md --- docs/Drivers/Java/Reference/Database/StreamTransactions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Database/StreamTransactions.md b/docs/Drivers/Java/Reference/Database/StreamTransactions.md index dfd6f2e18..3c69500a6 100644 --- a/docs/Drivers/Java/Reference/Database/StreamTransactions.md +++ b/docs/Drivers/Java/Reference/Database/StreamTransactions.md @@ -1,6 +1,6 @@ # Transactions -See [HTTP Interface for Stream Transactions](https://docs.arangodb.com/latest/HTTP/transaction-stream-transaction.html). +See [HTTP Interface for Stream Transactions](https://www.arangodb.com/docs/devel/http/transaction-stream-transaction.html). ## ArangoDatabase.beginStreamTransaction From a22d460ae6082bd771b3304c73c03f68455231e0 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:46:20 +0200 Subject: [PATCH 16/33] Update Transactions.md --- docs/Drivers/Java/Reference/Database/Transactions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Database/Transactions.md b/docs/Drivers/Java/Reference/Database/Transactions.md index 118d5c1d7..1e8f16fb7 100644 --- a/docs/Drivers/Java/Reference/Database/Transactions.md +++ b/docs/Drivers/Java/Reference/Database/Transactions.md @@ -1,7 +1,7 @@ # Transactions This function implements the -[HTTP API for transactions](https://docs.arangodb.com/latest/HTTP/Transaction/index.html). +[HTTP API for transactions](https://www.arangodb.com/docs/devel/http/transaction.html). ## ArangoDatabase.transaction From ffcbfdaee71615471004a02d3c27c701ed02ba53 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:46:40 +0200 Subject: [PATCH 17/33] Update ViewAccess.md --- docs/Drivers/Java/Reference/Database/ViewAccess.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Database/ViewAccess.md b/docs/Drivers/Java/Reference/Database/ViewAccess.md index 691c1b50d..ce4bda679 100644 --- a/docs/Drivers/Java/Reference/Database/ViewAccess.md +++ b/docs/Drivers/Java/Reference/Database/ViewAccess.md @@ -1,7 +1,7 @@ # Accessing Views These functions implement the -[HTTP API for accessing View](https://docs.arangodb.com/latest/HTTP/Views/index.html). +[HTTP API for accessing View](https://www.arangodb.com/docs/devel/http/views.html). ## ArangoDatabase.view From 879d39ebae1f1ccce3e0dfde01ca3bf4efdc0591 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:47:23 +0200 Subject: [PATCH 18/33] Update BulkImport.md --- docs/Drivers/Java/Reference/Collection/BulkImport.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Collection/BulkImport.md b/docs/Drivers/Java/Reference/Collection/BulkImport.md index 43325e7f8..066c9554b 100644 --- a/docs/Drivers/Java/Reference/Collection/BulkImport.md +++ b/docs/Drivers/Java/Reference/Collection/BulkImport.md @@ -1,7 +1,7 @@ # Bulk importing documents This function implements the -[HTTP API for bulk imports](https://docs.arangodb.com/latest/HTTP/BulkImports/index.html). +[HTTP API for bulk imports](https://www.arangodb.com/docs/devel/http/bulk-imports.html). ## ArangoCollection.importDocuments From 45fb7317a462d5487c55dd82ff59b575db4ead6a Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:47:44 +0200 Subject: [PATCH 19/33] Update CollectionManipulation.md --- .../Drivers/Java/Reference/Collection/CollectionManipulation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md index 1c3a7de26..8bf0135ef 100644 --- a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md +++ b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md @@ -1,7 +1,7 @@ # Manipulating the collection These functions implement -[the HTTP API for modifying collections](https://docs.arangodb.com/latest/HTTP/Collection/Modifying.html). +[the HTTP API for modifying collections](https://www.arangodb.com/docs/devel/http/collection-modifying.html). ## ArangoDatabase.createCollection From db852f6e0d5032c9524c22cda86aab532b52598d Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:48:06 +0200 Subject: [PATCH 20/33] Update DocumentManipulation.md --- docs/Drivers/Java/Reference/Collection/DocumentManipulation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md b/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md index 9468b0866..3058e3ef5 100644 --- a/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md +++ b/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md @@ -1,7 +1,7 @@ # Manipulating documents These functions implement the -[HTTP API for manipulating documents](https://docs.arangodb.com/latest/HTTP/Document/index.html). +[HTTP API for manipulating documents](https://www.arangodb.com/docs/devel/http/document.html). ## ArangoCollection.documentExists From 7f2e6f4194868382fc824b1251a9500f140ff1e1 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:48:29 +0200 Subject: [PATCH 21/33] Update Indexes.md --- docs/Drivers/Java/Reference/Collection/Indexes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Collection/Indexes.md b/docs/Drivers/Java/Reference/Collection/Indexes.md index d54c1e5a7..3433ead47 100644 --- a/docs/Drivers/Java/Reference/Collection/Indexes.md +++ b/docs/Drivers/Java/Reference/Collection/Indexes.md @@ -1,7 +1,7 @@ # Manipulating indexes These functions implement the -[HTTP API for manipulating indexes](https://docs.arangodb.com/latest/HTTP/Indexes/index.html). +[HTTP API for manipulating indexes](https://www.arangodb.com/docs/devel/http/indexes.html). ## ArangoCollection.ensureHashIndex From 99d4e857b85d3d0a286160df36f9c358efcca93c Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:49:11 +0200 Subject: [PATCH 22/33] Update README.md --- docs/Drivers/Java/Reference/Graph/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/Graph/README.md b/docs/Drivers/Java/Reference/Graph/README.md index 1270c8613..edb5616c5 100644 --- a/docs/Drivers/Java/Reference/Graph/README.md +++ b/docs/Drivers/Java/Reference/Graph/README.md @@ -1,7 +1,7 @@ # Graph API These functions implement the -[HTTP API for manipulating graphs](https://docs.arangodb.com/latest/HTTP/Gharial/index.html). +[HTTP API for manipulating graphs](https://www.arangodb.com/docs/devel/http/gharial.html). ## ArangoDatabase.createGraph From 66a3924b40a0cbc15ab0e56bb48877be1f9cf12f Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:50:09 +0200 Subject: [PATCH 23/33] Update Arangosearch.md --- docs/Drivers/Java/Reference/View/Arangosearch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/View/Arangosearch.md b/docs/Drivers/Java/Reference/View/Arangosearch.md index d4092cfac..399271f94 100644 --- a/docs/Drivers/Java/Reference/View/Arangosearch.md +++ b/docs/Drivers/Java/Reference/View/Arangosearch.md @@ -1,7 +1,7 @@ # ArangoSearch API These functions implement the -[HTTP API for ArangoSearch views](https://docs.arangodb.com/latest/HTTP/Views/ArangoSearch.html). +[HTTP API for ArangoSearch Views](https://www.arangodb.com/docs/devel/http/views-arangosearch.html). ## ArangoDatabase.createArangoSearch From 5e275e737939597b55b49fd892681486ea259bfd Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:52:05 +0200 Subject: [PATCH 24/33] Update ChangeLog.md --- ChangeLog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ChangeLog.md b/ChangeLog.md index 007bfb92d..93869e213 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -123,7 +123,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added -- added dirty read support ([reading from followers](https://docs.arangodb.com/current/Manual/Administration/ActiveFailover/#reading-from-follower)) +- added dirty read support ([reading from followers](https://www.arangodb.com/docs/devel/administration-active-failover.html#reading-from-follower)) - added option `AqlQueryOptions#allowDirtyRead` for `ArangoDatabase#query`. - added option `DocumentReadOptions#allowDirtyRead` for `ArangoCollection#getDocument` From c5a68399d2986a6d93b9129af400f9a07f3bb162 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 18:58:59 +0200 Subject: [PATCH 25/33] Update README.md --- docs/Drivers/Java/Reference/View/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Drivers/Java/Reference/View/README.md b/docs/Drivers/Java/Reference/View/README.md index 4dcae6432..f9e2173a7 100644 --- a/docs/Drivers/Java/Reference/View/README.md +++ b/docs/Drivers/Java/Reference/View/README.md @@ -3,7 +3,7 @@ These functions implement the [HTTP API for Views](https://www.arangodb.com/docs/devel/http/views.html). -## Getting information about the view +## Getting information about the View ## ArangoView.exists From 3ad5f536a16e93237c545710b8df89c10f013ab4 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 19:00:11 +0200 Subject: [PATCH 26/33] Update Analyzers.md --- docs/Drivers/Java/Reference/View/Analyzers.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/Drivers/Java/Reference/View/Analyzers.md b/docs/Drivers/Java/Reference/View/Analyzers.md index 543a9bd48..d9a886212 100644 --- a/docs/Drivers/Java/Reference/View/Analyzers.md +++ b/docs/Drivers/Java/Reference/View/Analyzers.md @@ -9,11 +9,11 @@ - **name**: `String` - The analyzer name. + The Analyzer name. - **type**: `AnalyzerType` - The analyzer type. Can be one of: `identity`, `delimiter`, `stem`, `norm`, `ngram`, `text` + The Analyzer type. Can be one of: `identity`, `delimiter`, `stem`, `norm`, `ngram`, `text` - **properties**: `Map` @@ -21,7 +21,7 @@ - **features**: `Set` - The set of features to set on the analyzer generated fields. The default value is an empty array. + The set of features to set on the Analyzer generated fields. The default value is an empty array. Values can be: `frequency`, `norm`, `position` @@ -42,14 +42,14 @@ Gets information about an Analyzer - **name**: `String` - The name of the analyzer + The name of the Analyzer ## ArangoDatabase.getAnalyzers `ArangoDatabase.getAnalyzers() : Collection` -Retrieves all analyzers definitions. +Retrieves all Analyzers definitions. ## ArangoDatabase.deleteAnalyzer @@ -62,7 +62,7 @@ Deletes an Analyzer. - **name**: `String` - The name of the analyzer + The name of the Analyzer ## ArangoDatabase.deleteAnalyzer @@ -75,10 +75,10 @@ Deletes an Analyzer. - **name**: `String` - The name of the analyzer + The name of the Analyzer - **options**: `AnalyzerDeleteOptions` - **force**: `Boolean` - The analyzer configuration should be removed even if it is in-use. The default value is false. + The Analyzer configuration should be removed even if it is in-use. The default value is false. From d87f345236a0a8ffc1cc10cb7728cedcfd97ebc0 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 19:01:23 +0200 Subject: [PATCH 27/33] Update Arangosearch.md --- .../Java/Reference/View/Arangosearch.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/Drivers/Java/Reference/View/Arangosearch.md b/docs/Drivers/Java/Reference/View/Arangosearch.md index 399271f94..a9af16f22 100644 --- a/docs/Drivers/Java/Reference/View/Arangosearch.md +++ b/docs/Drivers/Java/Reference/View/Arangosearch.md @@ -7,28 +7,28 @@ These functions implement the `ArangoDatabase.createArangoSearch(String name, ArangoSearchCreateOptions options) : ViewEntity` -Creates a ArangoSearch view with the given _options_, then returns -view information from the server. +Creates a ArangoSearch View with the given _options_, then returns +View information from the server. **Arguments** - **name**: `String` - The name of the view + The name of the View - **options**: `ArangoSearchCreateOptions` - **commitIntervalMsec**: `Long` - Wait at least this many milliseconds between committing view data store changes + Wait at least this many milliseconds between committing View data store changes and making documents visible to queries (default: 1000, to disable use: 0). For the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and memory usage would continue to grow. For the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each commit call without any added - benefits. Background: For data retrieval ArangoSearch views follow the concept + benefits. Background: For data retrieval ArangoSearch Views follow the concept of "eventually-consistent", i.e. eventually all the data in ArangoDB will be - matched by corresponding query expressions. The concept of ArangoSearch view + matched by corresponding query expressions. The concept of ArangoSearch View "commit" operation is introduced to control the upper-bound on the time until document addition/removals are actually reflected by corresponding query expressions. Once a "commit" operation is complete all documents added/removed @@ -87,14 +87,14 @@ view information from the server. ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); db.createArangoSearch("potatoes", new ArangoSearchPropertiesOptions()); -// the ArangoSearch view "potatoes" now exists +// the ArangoSearch View "potatoes" now exists ``` ## ArangoSearch.create `ArangoSearch.create(ArangoSearchCreateOptions options) : ViewEntity` -Creates a ArangoSearch view with the given _options_, then returns view information from the server. +Creates a ArangoSearch View with the given _options_, then returns View information from the server. Alternative for `ArangoDatabase.createArangoSearch`. @@ -157,7 +157,7 @@ view.create(new ArangoSearchPropertiesOptions()); `ArangoSearch.getProperties() : ArangoSearchPropertiesEntity` -Reads the properties of the specified view. +Reads the properties of the specified View. **Examples** @@ -173,7 +173,7 @@ ArangoSearchPropertiesEntity properties = view.getProperties(); `ArangoSearch.updateProperties(ArangoSearchPropertiesOptions options) : ArangoSearchPropertiesEntity` -Partially changes properties of the view. +Partially changes properties of the View. **Arguments** @@ -236,7 +236,7 @@ view.updateProperties( `ArangoSearch.replaceProperties(ArangoSearchPropertiesOptions options) : ArangoSearchPropertiesEntity` -Changes properties of the view. +Changes properties of the View. **Arguments** From 06fb8e8125ff1cdcf414e982b29f6024fb427c05 Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 19:01:41 +0200 Subject: [PATCH 28/33] Update README.md --- docs/Drivers/Java/Reference/View/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Drivers/Java/Reference/View/README.md b/docs/Drivers/Java/Reference/View/README.md index f9e2173a7..ef88b412a 100644 --- a/docs/Drivers/Java/Reference/View/README.md +++ b/docs/Drivers/Java/Reference/View/README.md @@ -9,7 +9,7 @@ These functions implement the `ArangoView.exists() : boolean` -Checks whether the view exists +Checks whether the View exists **Examples** @@ -25,7 +25,7 @@ boolean exists = view.exists(); `ArangoView.getInfo() : ViewEntity` -Returns information about the view. +Returns information about the View. **Examples** From b7ac01b6d4a29f45170c07f79487b486e1baa97c Mon Sep 17 00:00:00 2001 From: Simran Date: Wed, 16 Oct 2019 19:02:17 +0200 Subject: [PATCH 29/33] Update ViewManipulation.md --- .../Java/Reference/View/ViewManipulation.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/Drivers/Java/Reference/View/ViewManipulation.md b/docs/Drivers/Java/Reference/View/ViewManipulation.md index 1faecb2bb..25da82aab 100644 --- a/docs/Drivers/Java/Reference/View/ViewManipulation.md +++ b/docs/Drivers/Java/Reference/View/ViewManipulation.md @@ -7,17 +7,17 @@ These functions implement the `ArangoDatabase.createView(String name, ViewType type) : ViewEntity` -Creates a view of the given _type_, then returns view information from the server. +Creates a View of the given _type_, then returns View information from the server. **Arguments** - **name**: `String` - The name of the view + The name of the View - **type**: `ViewType` - The type of the view + The type of the View **Examples** @@ -32,7 +32,7 @@ db.createView("myView", ViewType.ARANGO_SEARCH); `ArangoView.rename(String newName) : ViewEntity` -Renames the view. +Renames the View. **Arguments** @@ -49,14 +49,14 @@ ArangoView view = db.view("some-view"); ViewEntity result = view.rename("new-view-name") assertThat(result.getName(), is("new-view-name"); -// result contains additional information about the view +// result contains additional information about the View ``` ## ArangoView.drop `ArangoView.drop() : void` -Deletes the view from the database. +Deletes the View from the database. **Examples** @@ -66,5 +66,5 @@ ArangoDatabase db = arango.db("myDB"); ArangoView view = db.view("some-view"); view.drop(); -// the view "some-view" no longer exists +// the View "some-view" no longer exists ``` From 0ce2eb17c2887835e8804571da721c39675eb2fd Mon Sep 17 00:00:00 2001 From: Simran Brucherseifer Date: Mon, 21 Oct 2019 15:52:02 +0200 Subject: [PATCH 30/33] /docs/devel --> /docs/stable --- ChangeLog.md | 2 +- docs/Drivers/Java/Reference/Collection/BulkImport.md | 2 +- .../Java/Reference/Collection/CollectionManipulation.md | 4 ++-- .../Drivers/Java/Reference/Collection/DocumentManipulation.md | 2 +- docs/Drivers/Java/Reference/Collection/Indexes.md | 2 +- docs/Drivers/Java/Reference/Collection/README.md | 4 ++-- docs/Drivers/Java/Reference/Database/AqlUserFunctions.md | 2 +- docs/Drivers/Java/Reference/Database/CollectionAccess.md | 2 +- docs/Drivers/Java/Reference/Database/DatabaseManipulation.md | 2 +- docs/Drivers/Java/Reference/Database/GraphAccess.md | 2 +- docs/Drivers/Java/Reference/Database/Queries.md | 2 +- docs/Drivers/Java/Reference/Database/StreamTransactions.md | 2 +- docs/Drivers/Java/Reference/Database/Transactions.md | 2 +- docs/Drivers/Java/Reference/Database/ViewAccess.md | 2 +- docs/Drivers/Java/Reference/Graph/README.md | 2 +- docs/Drivers/Java/Reference/View/Analyzers.md | 2 +- docs/Drivers/Java/Reference/View/Arangosearch.md | 2 +- docs/Drivers/Java/Reference/View/README.md | 2 +- docs/Drivers/Java/Reference/View/ViewManipulation.md | 2 +- 19 files changed, 21 insertions(+), 21 deletions(-) diff --git a/ChangeLog.md b/ChangeLog.md index 93869e213..704b9f4dc 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -123,7 +123,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added -- added dirty read support ([reading from followers](https://www.arangodb.com/docs/devel/administration-active-failover.html#reading-from-follower)) +- added dirty read support ([reading from followers](https://www.arangodb.com/docs/stable/administration-active-failover.html#reading-from-follower)) - added option `AqlQueryOptions#allowDirtyRead` for `ArangoDatabase#query`. - added option `DocumentReadOptions#allowDirtyRead` for `ArangoCollection#getDocument` diff --git a/docs/Drivers/Java/Reference/Collection/BulkImport.md b/docs/Drivers/Java/Reference/Collection/BulkImport.md index 066c9554b..c5cad27f1 100644 --- a/docs/Drivers/Java/Reference/Collection/BulkImport.md +++ b/docs/Drivers/Java/Reference/Collection/BulkImport.md @@ -1,7 +1,7 @@ # Bulk importing documents This function implements the -[HTTP API for bulk imports](https://www.arangodb.com/docs/devel/http/bulk-imports.html). +[HTTP API for bulk imports](https://www.arangodb.com/docs/stable/http/bulk-imports.html). ## ArangoCollection.importDocuments diff --git a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md index 8bf0135ef..74fff2a30 100644 --- a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md +++ b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md @@ -1,7 +1,7 @@ # Manipulating the collection These functions implement -[the HTTP API for modifying collections](https://www.arangodb.com/docs/devel/http/collection-modifying.html). +[the HTTP API for modifying collections](https://www.arangodb.com/docs/stable/http/collection-modifying.html). ## ArangoDatabase.createCollection @@ -290,7 +290,7 @@ Changes the properties of the collection. - **options**: `CollectionPropertiesEntity` For information on the _properties_ argument see - [the HTTP API for modifying collections](https://docs.arangodb.com/latest/HTTP/Collection/Modifying.html). + [the HTTP API for modifying collections](https://www.arangodb.com/docs/stable/http/collection-modifying.html). **Examples** diff --git a/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md b/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md index 3058e3ef5..7ebcb6a49 100644 --- a/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md +++ b/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md @@ -1,7 +1,7 @@ # Manipulating documents These functions implement the -[HTTP API for manipulating documents](https://www.arangodb.com/docs/devel/http/document.html). +[HTTP API for manipulating documents](https://www.arangodb.com/docs/stable/http/document.html). ## ArangoCollection.documentExists diff --git a/docs/Drivers/Java/Reference/Collection/Indexes.md b/docs/Drivers/Java/Reference/Collection/Indexes.md index 3433ead47..93be685af 100644 --- a/docs/Drivers/Java/Reference/Collection/Indexes.md +++ b/docs/Drivers/Java/Reference/Collection/Indexes.md @@ -1,7 +1,7 @@ # Manipulating indexes These functions implement the -[HTTP API for manipulating indexes](https://www.arangodb.com/docs/devel/http/indexes.html). +[HTTP API for manipulating indexes](https://www.arangodb.com/docs/stable/http/indexes.html). ## ArangoCollection.ensureHashIndex diff --git a/docs/Drivers/Java/Reference/Collection/README.md b/docs/Drivers/Java/Reference/Collection/README.md index 076c0f6d2..6f393cadf 100644 --- a/docs/Drivers/Java/Reference/Collection/README.md +++ b/docs/Drivers/Java/Reference/Collection/README.md @@ -1,7 +1,7 @@ # Collection API These functions implement the -[HTTP API for collections](https://www.arangodb.com/docs/devel/http/collection.html). +[HTTP API for collections](https://www.arangodb.com/docs/stable/http/collection.html). The _ArangoCollection_ API is used for all collections, regardless of their specific type (document/edge collection). @@ -9,7 +9,7 @@ their specific type (document/edge collection). ## Getting information about the collection See -[the HTTP API documentation](https://www.arangodb.com/docs/devel/http/collection-getting.html) +[the HTTP API documentation](https://www.arangodb.com/docs/stable/http/collection-getting.html) for details. ## ArangoCollection.exists diff --git a/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md b/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md index dc4321e49..4b2eda694 100644 --- a/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md +++ b/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md @@ -1,7 +1,7 @@ # Managing AQL user functions These functions implement the -[HTTP API for managing AQL user functions](https://www.arangodb.com/docs/devel/http/aql-user-functions.html). +[HTTP API for managing AQL user functions](https://www.arangodb.com/docs/stable/http/aql-user-functions.html). ## ArangoDatabase.getAqlFunctions diff --git a/docs/Drivers/Java/Reference/Database/CollectionAccess.md b/docs/Drivers/Java/Reference/Database/CollectionAccess.md index 48cfe5c01..29eef18dc 100644 --- a/docs/Drivers/Java/Reference/Database/CollectionAccess.md +++ b/docs/Drivers/Java/Reference/Database/CollectionAccess.md @@ -1,7 +1,7 @@ # Accessing collections These functions implement the -[HTTP API for accessing collections](https://www.arangodb.com/docs/devel/http/collection-getting.html). +[HTTP API for accessing collections](https://www.arangodb.com/docs/stable/http/collection-getting.html). ## ArangoDatabase.collection diff --git a/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md b/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md index aae7c6783..19ddf68c7 100644 --- a/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md +++ b/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md @@ -1,7 +1,7 @@ # Manipulation databases These functions implement the -[HTTP API for manipulating databases](https://www.arangodb.com/docs/devel/http/database.html). +[HTTP API for manipulating databases](https://www.arangodb.com/docs/stable/http/database.html). ## ArangoDB.createDatabase diff --git a/docs/Drivers/Java/Reference/Database/GraphAccess.md b/docs/Drivers/Java/Reference/Database/GraphAccess.md index 2afdd283c..eacd46297 100644 --- a/docs/Drivers/Java/Reference/Database/GraphAccess.md +++ b/docs/Drivers/Java/Reference/Database/GraphAccess.md @@ -1,7 +1,7 @@ # Accessing graphs These functions implement the -[HTTP API for accessing general graphs](https://www.arangodb.com/docs/devel/http/gharial.html). +[HTTP API for accessing general graphs](https://www.arangodb.com/docs/stable/http/gharial.html). ## ArangoDatabase.graph diff --git a/docs/Drivers/Java/Reference/Database/Queries.md b/docs/Drivers/Java/Reference/Database/Queries.md index e7e152260..a4761e8c0 100644 --- a/docs/Drivers/Java/Reference/Database/Queries.md +++ b/docs/Drivers/Java/Reference/Database/Queries.md @@ -1,7 +1,7 @@ # Queries This function implements the -[HTTP API for single roundtrip AQL queries](https://www.arangodb.com/docs/devel/http/aql-query-cursor-query-results.html). +[HTTP API for single roundtrip AQL queries](https://www.arangodb.com/docs/stable/http/aql-query-cursor-query-results.html). ## ArangoDatabase.query diff --git a/docs/Drivers/Java/Reference/Database/StreamTransactions.md b/docs/Drivers/Java/Reference/Database/StreamTransactions.md index 3c69500a6..d0a016a0d 100644 --- a/docs/Drivers/Java/Reference/Database/StreamTransactions.md +++ b/docs/Drivers/Java/Reference/Database/StreamTransactions.md @@ -1,6 +1,6 @@ # Transactions -See [HTTP Interface for Stream Transactions](https://www.arangodb.com/docs/devel/http/transaction-stream-transaction.html). +See [HTTP Interface for Stream Transactions](https://www.arangodb.com/docs/stable/http/transaction-stream-transaction.html). ## ArangoDatabase.beginStreamTransaction diff --git a/docs/Drivers/Java/Reference/Database/Transactions.md b/docs/Drivers/Java/Reference/Database/Transactions.md index 1e8f16fb7..aaf7a866e 100644 --- a/docs/Drivers/Java/Reference/Database/Transactions.md +++ b/docs/Drivers/Java/Reference/Database/Transactions.md @@ -1,7 +1,7 @@ # Transactions This function implements the -[HTTP API for transactions](https://www.arangodb.com/docs/devel/http/transaction.html). +[HTTP API for transactions](https://www.arangodb.com/docs/stable/http/transaction.html). ## ArangoDatabase.transaction diff --git a/docs/Drivers/Java/Reference/Database/ViewAccess.md b/docs/Drivers/Java/Reference/Database/ViewAccess.md index ce4bda679..148d752e9 100644 --- a/docs/Drivers/Java/Reference/Database/ViewAccess.md +++ b/docs/Drivers/Java/Reference/Database/ViewAccess.md @@ -1,7 +1,7 @@ # Accessing Views These functions implement the -[HTTP API for accessing View](https://www.arangodb.com/docs/devel/http/views.html). +[HTTP API for accessing View](https://www.arangodb.com/docs/stable/http/views.html). ## ArangoDatabase.view diff --git a/docs/Drivers/Java/Reference/Graph/README.md b/docs/Drivers/Java/Reference/Graph/README.md index edb5616c5..ec51ac1fd 100644 --- a/docs/Drivers/Java/Reference/Graph/README.md +++ b/docs/Drivers/Java/Reference/Graph/README.md @@ -1,7 +1,7 @@ # Graph API These functions implement the -[HTTP API for manipulating graphs](https://www.arangodb.com/docs/devel/http/gharial.html). +[HTTP API for manipulating graphs](https://www.arangodb.com/docs/stable/http/gharial.html). ## ArangoDatabase.createGraph diff --git a/docs/Drivers/Java/Reference/View/Analyzers.md b/docs/Drivers/Java/Reference/View/Analyzers.md index d9a886212..b58c317cc 100644 --- a/docs/Drivers/Java/Reference/View/Analyzers.md +++ b/docs/Drivers/Java/Reference/View/Analyzers.md @@ -1,6 +1,6 @@ # Analyzers -[HTTP Interface for Analyzers](https://www.arangodb.com/docs/devel/http/analyzers.html). +[HTTP Interface for Analyzers](https://www.arangodb.com/docs/stable/http/analyzers.html). ## Types diff --git a/docs/Drivers/Java/Reference/View/Arangosearch.md b/docs/Drivers/Java/Reference/View/Arangosearch.md index a9af16f22..4bb572303 100644 --- a/docs/Drivers/Java/Reference/View/Arangosearch.md +++ b/docs/Drivers/Java/Reference/View/Arangosearch.md @@ -1,7 +1,7 @@ # ArangoSearch API These functions implement the -[HTTP API for ArangoSearch Views](https://www.arangodb.com/docs/devel/http/views-arangosearch.html). +[HTTP API for ArangoSearch Views](https://www.arangodb.com/docs/stable/http/views-arangosearch.html). ## ArangoDatabase.createArangoSearch diff --git a/docs/Drivers/Java/Reference/View/README.md b/docs/Drivers/Java/Reference/View/README.md index ef88b412a..ecb4c3f3e 100644 --- a/docs/Drivers/Java/Reference/View/README.md +++ b/docs/Drivers/Java/Reference/View/README.md @@ -1,7 +1,7 @@ # View API These functions implement the -[HTTP API for Views](https://www.arangodb.com/docs/devel/http/views.html). +[HTTP API for Views](https://www.arangodb.com/docs/stable/http/views.html). ## Getting information about the View diff --git a/docs/Drivers/Java/Reference/View/ViewManipulation.md b/docs/Drivers/Java/Reference/View/ViewManipulation.md index 25da82aab..f963e27ba 100644 --- a/docs/Drivers/Java/Reference/View/ViewManipulation.md +++ b/docs/Drivers/Java/Reference/View/ViewManipulation.md @@ -1,7 +1,7 @@ # Manipulating the View These functions implement the -[HTTP API for modifying Views](https://www.arangodb.com/docs/devel/http/views.html). +[HTTP API for modifying Views](https://www.arangodb.com/docs/stable/http/views.html). ## ArangoDatabase.createView From 803be6d5ac07cefe80c0fe7a8ecd29d7920d6959 Mon Sep 17 00:00:00 2001 From: Simran Brucherseifer Date: Tue, 22 Oct 2019 16:22:56 +0200 Subject: [PATCH 31/33] Update links docs.arangodb.com -> www.arangodb.com/docs --- .../Java/Reference/Database/Transactions.md | 2 +- .../java/com/arangodb/ArangoCollection.java | 100 +++++++-------- src/main/java/com/arangodb/ArangoDB.java | 28 ++--- .../java/com/arangodb/ArangoDatabase.java | 116 +++++++++--------- .../com/arangodb/ArangoEdgeCollection.java | 22 ++-- src/main/java/com/arangodb/ArangoGraph.java | 24 ++-- src/main/java/com/arangodb/ArangoSearch.java | 12 +- .../com/arangodb/ArangoVertexCollection.java | 24 ++-- src/main/java/com/arangodb/ArangoView.java | 8 +- .../arangodb/async/ArangoCollectionAsync.java | 100 +++++++-------- .../com/arangodb/async/ArangoDBAsync.java | 26 ++-- .../arangodb/async/ArangoDatabaseAsync.java | 116 +++++++++--------- .../async/ArangoEdgeCollectionAsync.java | 22 ++-- .../com/arangodb/async/ArangoGraphAsync.java | 24 ++-- .../com/arangodb/async/ArangoSearchAsync.java | 12 +- .../async/ArangoVertexCollectionAsync.java | 24 ++-- .../com/arangodb/async/ArangoViewAsync.java | 8 +- .../entity/AqlExecutionExplainEntity.java | 2 +- .../arangodb/entity/AqlFunctionEntity.java | 2 +- .../com/arangodb/entity/AqlParseEntity.java | 2 +- .../com/arangodb/entity/ArangoDBEngine.java | 2 +- .../com/arangodb/entity/ArangoDBVersion.java | 2 +- .../com/arangodb/entity/CollectionEntity.java | 2 +- .../entity/CollectionPropertiesEntity.java | 2 +- .../entity/CollectionRevisionEntity.java | 2 +- .../com/arangodb/entity/CursorEntity.java | 2 +- .../com/arangodb/entity/DatabaseEntity.java | 2 +- .../arangodb/entity/DocumentCreateEntity.java | 2 +- .../arangodb/entity/DocumentDeleteEntity.java | 2 +- .../arangodb/entity/DocumentUpdateEntity.java | 2 +- .../com/arangodb/entity/EdgeDefinition.java | 2 +- .../com/arangodb/entity/EdgeUpdateEntity.java | 2 +- .../java/com/arangodb/entity/GraphEntity.java | 2 +- .../java/com/arangodb/entity/LogEntity.java | 2 +- .../java/com/arangodb/entity/PathEntity.java | 2 +- .../entity/QueryCachePropertiesEntity.java | 2 +- .../com/arangodb/entity/ShardingStrategy.java | 2 +- .../entity/StreamTransactionEntity.java | 2 +- .../arangodb/entity/TransactionEntity.java | 2 +- .../com/arangodb/entity/TraversalEntity.java | 2 +- .../java/com/arangodb/entity/UserEntity.java | 2 +- .../internal/InternalArangoDatabase.java | 4 +- .../model/AqlFunctionCreateOptions.java | 2 +- .../model/AqlFunctionDeleteOptions.java | 2 +- .../arangodb/model/AqlFunctionGetOptions.java | 2 +- .../model/AqlQueryExplainOptions.java | 2 +- .../com/arangodb/model/AqlQueryOptions.java | 4 +- .../arangodb/model/AqlQueryParseOptions.java | 2 +- .../model/CollectionCreateOptions.java | 2 +- .../model/CollectionPropertiesOptions.java | 2 +- .../model/CollectionsReadOptions.java | 2 +- .../arangodb/model/DocumentCreateOptions.java | 2 +- .../arangodb/model/DocumentDeleteOptions.java | 2 +- .../arangodb/model/DocumentExistsOptions.java | 2 +- .../arangodb/model/DocumentReadOptions.java | 4 +- .../model/DocumentReplaceOptions.java | 2 +- .../arangodb/model/DocumentUpdateOptions.java | 2 +- .../com/arangodb/model/EdgeCreateOptions.java | 2 +- .../com/arangodb/model/EdgeDeleteOptions.java | 2 +- .../arangodb/model/EdgeReplaceOptions.java | 2 +- .../com/arangodb/model/EdgeUpdateOptions.java | 2 +- .../arangodb/model/FulltextIndexOptions.java | 2 +- .../com/arangodb/model/GeoIndexOptions.java | 2 +- .../arangodb/model/GraphCreateOptions.java | 2 +- .../model/GraphDocumentReadOptions.java | 2 +- .../com/arangodb/model/HashIndexOptions.java | 2 +- .../java/com/arangodb/model/LogOptions.java | 2 +- .../model/PersistentIndexOptions.java | 2 +- .../arangodb/model/SkiplistIndexOptions.java | 2 +- .../model/StreamTransactionOptions.java | 2 +- .../arangodb/model/TransactionOptions.java | 2 +- .../com/arangodb/model/TraversalOptions.java | 2 +- .../com/arangodb/model/UserCreateOptions.java | 2 +- .../com/arangodb/model/UserUpdateOptions.java | 2 +- .../arangodb/model/VertexCreateOptions.java | 2 +- .../arangodb/model/VertexDeleteOptions.java | 2 +- .../arangodb/model/VertexReplaceOptions.java | 2 +- .../arangodb/model/VertexUpdateOptions.java | 2 +- .../graph/AQLActorsAndMoviesExample.java | 20 +-- .../graph/GraphTraversalsInAQLExample.java | 2 +- .../graph/ShortestPathInAQLExample.java | 2 +- .../graph/AQLActorsAndMoviesExample.java | 20 +-- .../graph/GraphTraversalsInAQLExample.java | 2 +- .../graph/ShortestPathInAQLExample.java | 2 +- 84 files changed, 422 insertions(+), 422 deletions(-) diff --git a/docs/Drivers/Java/Reference/Database/Transactions.md b/docs/Drivers/Java/Reference/Database/Transactions.md index aaf7a866e..0242a2654 100644 --- a/docs/Drivers/Java/Reference/Database/Transactions.md +++ b/docs/Drivers/Java/Reference/Database/Transactions.md @@ -1,7 +1,7 @@ # Transactions This function implements the -[HTTP API for transactions](https://www.arangodb.com/docs/stable/http/transaction.html). +[HTTP API for JS transactions](https://www.arangodb.com/docs/stable/http/transaction-js-transaction.html). ## ArangoDatabase.transaction diff --git a/src/main/java/com/arangodb/ArangoCollection.java b/src/main/java/com/arangodb/ArangoCollection.java index 517cb8fc8..9a5ca3b0e 100644 --- a/src/main/java/com/arangodb/ArangoCollection.java +++ b/src/main/java/com/arangodb/ArangoCollection.java @@ -31,8 +31,8 @@ * @author Mark Vollmary * @author Heiko Kernbach * @author Michele Rastelli - * @see Collection API Documentation - * @see Documents API Documentation + * @see Collection API Documentation + * @see Documents API Documentation */ @SuppressWarnings("UnusedReturnValue") public interface ArangoCollection extends ArangoSerializationAccessor { @@ -58,7 +58,7 @@ public interface ArangoCollection extends ArangoSerializationAccessor { * @param value A representation of a single document (POJO, VPackSlice or String for JSON) * @return information about the document * @throws ArangoDBException - * @see API + * @see API * Documentation */ DocumentCreateEntity insertDocument(T value) throws ArangoDBException; @@ -71,7 +71,7 @@ public interface ArangoCollection extends ArangoSerializationAccessor { * @param options Additional options, can be null * @return information about the document * @throws ArangoDBException - * @see API + * @see API * Documentation */ DocumentCreateEntity insertDocument(T value, DocumentCreateOptions options) throws ArangoDBException; @@ -83,7 +83,7 @@ public interface ArangoCollection extends ArangoSerializationAccessor { * @param values A List of documents (POJO, VPackSlice or String for JSON) * @return information about the documents * @throws ArangoDBException - * @see API + * @see API * Documentation */ MultiDocumentEntity> insertDocuments(Collection values) throws ArangoDBException; @@ -96,7 +96,7 @@ public interface ArangoCollection extends ArangoSerializationAccessor { * @param options Additional options, can be null * @return information about the documents * @throws ArangoDBException - * @see API + * @see API * Documentation */ MultiDocumentEntity> insertDocuments( @@ -147,7 +147,7 @@ MultiDocumentEntity> insertDocuments( * @param type The type of the document (POJO class, VPackSlice or String for JSON) * @return the document identified by the key * @throws ArangoDBException - * @see API + * @see API * Documentation */ T getDocument(String key, Class type) throws ArangoDBException; @@ -160,7 +160,7 @@ MultiDocumentEntity> insertDocuments( * @param options Additional options, can be null * @return the document identified by the key * @throws ArangoDBException - * @see API + * @see API * Documentation */ T getDocument(String key, Class type, DocumentReadOptions options) throws ArangoDBException; @@ -195,7 +195,7 @@ MultiDocumentEntity getDocuments(Collection keys, Class type, * @param value A representation of a single document (POJO, VPackSlice or String for JSON) * @return information about the document * @throws ArangoDBException - * @see API + * @see API * Documentation */ DocumentUpdateEntity replaceDocument(String key, T value) throws ArangoDBException; @@ -209,7 +209,7 @@ MultiDocumentEntity getDocuments(Collection keys, Class type, * @param options Additional options, can be null * @return information about the document * @throws ArangoDBException - * @see API + * @see API * Documentation */ DocumentUpdateEntity replaceDocument(String key, T value, DocumentReplaceOptions options) @@ -222,7 +222,7 @@ DocumentUpdateEntity replaceDocument(String key, T value, DocumentReplace * @param values A List of documents (POJO, VPackSlice or String for JSON) * @return information about the documents * @throws ArangoDBException - * @see API + * @see API * Documentation */ MultiDocumentEntity> replaceDocuments(Collection values) throws ArangoDBException; @@ -235,7 +235,7 @@ DocumentUpdateEntity replaceDocument(String key, T value, DocumentReplace * @param options Additional options, can be null * @return information about the documents * @throws ArangoDBException - * @see API + * @see API * Documentation */ MultiDocumentEntity> replaceDocuments( @@ -250,7 +250,7 @@ MultiDocumentEntity> replaceDocuments( * @param value A representation of a single document (POJO, VPackSlice or String for JSON) * @return information about the document * @throws ArangoDBException - * @see API + * @see API * Documentation */ DocumentUpdateEntity updateDocument(String key, T value) throws ArangoDBException; @@ -265,7 +265,7 @@ MultiDocumentEntity> replaceDocuments( * @param options Additional options, can be null * @return information about the document * @throws ArangoDBException - * @see API + * @see API * Documentation */ DocumentUpdateEntity updateDocument(String key, T value, DocumentUpdateOptions options) @@ -280,7 +280,7 @@ DocumentUpdateEntity updateDocument(String key, T value, DocumentUpdateOp * @param values A list of documents (POJO, VPackSlice or String for JSON) * @return information about the documents * @throws ArangoDBException - * @see API + * @see API * Documentation */ MultiDocumentEntity> updateDocuments(Collection values) throws ArangoDBException; @@ -295,7 +295,7 @@ DocumentUpdateEntity updateDocument(String key, T value, DocumentUpdateOp * @param options Additional options, can be null * @return information about the documents * @throws ArangoDBException - * @see API + * @see API * Documentation */ MultiDocumentEntity> updateDocuments( @@ -307,7 +307,7 @@ MultiDocumentEntity> updateDocuments( * @param key The key of the document * @return information about the document * @throws ArangoDBException - * @see API + * @see API * Documentation */ DocumentDeleteEntity deleteDocument(String key) throws ArangoDBException; @@ -321,7 +321,7 @@ MultiDocumentEntity> updateDocuments( * @param options Additional options, can be null * @return information about the document * @throws ArangoDBException - * @see API + * @see API * Documentation */ DocumentDeleteEntity deleteDocument(String key, Class type, DocumentDeleteOptions options) @@ -334,7 +334,7 @@ DocumentDeleteEntity deleteDocument(String key, Class type, DocumentDe * @return information about the documents * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#removes-multiple-documents">API * Documentation */ MultiDocumentEntity> deleteDocuments(Collection values) throws ArangoDBException; @@ -349,7 +349,7 @@ DocumentDeleteEntity deleteDocument(String key, Class type, DocumentDe * @return information about the documents * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#removes-multiple-documents">API * Documentation */ MultiDocumentEntity> deleteDocuments( @@ -361,7 +361,7 @@ MultiDocumentEntity> deleteDocuments( * @param key The key of the document * @return true if the document was found, otherwise false * @see API + * "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#read-document-header">API * Documentation */ Boolean documentExists(String key); @@ -374,7 +374,7 @@ MultiDocumentEntity> deleteDocuments( * @return true if the document was found, otherwise false * @throws ArangoDBException only thrown when {@link DocumentExistsOptions#isCatchException()} == false * @see API + * "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#read-document-header">API * Documentation */ Boolean documentExists(String key, DocumentExistsOptions options) throws ArangoDBException; @@ -385,7 +385,7 @@ MultiDocumentEntity> deleteDocuments( * @param id The index-handle * @return information about the index * @throws ArangoDBException - * @see API Documentation + * @see API Documentation */ IndexEntity getIndex(String id) throws ArangoDBException; @@ -395,7 +395,7 @@ MultiDocumentEntity> deleteDocuments( * @param id The index-handle * @return the id of the index * @throws ArangoDBException - * @see API Documentation + * @see API Documentation */ String deleteIndex(String id) throws ArangoDBException; @@ -406,7 +406,7 @@ MultiDocumentEntity> deleteDocuments( * @param options Additional options, can be null * @return information about the index * @throws ArangoDBException - * @see API Documentation + * @see API Documentation */ IndexEntity ensureHashIndex(Iterable fields, HashIndexOptions options) throws ArangoDBException; @@ -417,7 +417,7 @@ MultiDocumentEntity> deleteDocuments( * @param options Additional options, can be null * @return information about the index * @throws ArangoDBException - * @see API + * @see API * Documentation */ IndexEntity ensureSkiplistIndex(Iterable fields, SkiplistIndexOptions options) throws ArangoDBException; @@ -429,7 +429,7 @@ MultiDocumentEntity> deleteDocuments( * @param options Additional options, can be null * @return information about the index * @throws ArangoDBException - * @see API + * @see API * Documentation */ IndexEntity ensurePersistentIndex(Iterable fields, PersistentIndexOptions options) throws ArangoDBException; @@ -441,7 +441,7 @@ MultiDocumentEntity> deleteDocuments( * @param options Additional options, can be null * @return information about the index * @throws ArangoDBException - * @see API + * @see API * Documentation */ IndexEntity ensureGeoIndex(Iterable fields, GeoIndexOptions options) throws ArangoDBException; @@ -453,7 +453,7 @@ MultiDocumentEntity> deleteDocuments( * @param options Additional options, can be null * @return information about the index * @throws ArangoDBException - * @see API + * @see API * Documentation */ IndexEntity ensureFulltextIndex(Iterable fields, FulltextIndexOptions options) throws ArangoDBException; @@ -476,7 +476,7 @@ MultiDocumentEntity> deleteDocuments( * @return information about the indexes * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/indexes-working-with.html#read-all-indexes-of-a-collection">API * Documentation */ Collection getIndexes() throws ArangoDBException; @@ -493,7 +493,7 @@ MultiDocumentEntity> deleteDocuments( * * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionEntity truncate() throws ArangoDBException; @@ -504,7 +504,7 @@ MultiDocumentEntity> deleteDocuments( * @param options * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation * @since ArangoDB 3.5.0 */ @@ -516,7 +516,7 @@ MultiDocumentEntity> deleteDocuments( * @return information about the collection, including the number of documents * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/collection-getting.html#return-number-of-documents-in-a-collection">API * Documentation */ CollectionPropertiesEntity count() throws ArangoDBException; @@ -528,7 +528,7 @@ MultiDocumentEntity> deleteDocuments( * @return information about the collection, including the number of documents * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/collection-getting.html#return-number-of-documents-in-a-collection">API * Documentation * @since ArangoDB 3.5.0 */ @@ -539,7 +539,7 @@ MultiDocumentEntity> deleteDocuments( * * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionEntity create() throws ArangoDBException; @@ -551,7 +551,7 @@ MultiDocumentEntity> deleteDocuments( * @param options Additional options, can be null * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionEntity create(CollectionCreateOptions options) throws ArangoDBException; @@ -560,7 +560,7 @@ MultiDocumentEntity> deleteDocuments( * Deletes the collection from the database. * * @throws ArangoDBException - * @see API + * @see API * Documentation */ void drop() throws ArangoDBException; @@ -571,7 +571,7 @@ MultiDocumentEntity> deleteDocuments( * @param isSystem Whether or not the collection to drop is a system collection. This parameter must be set to true in * order to drop a system collection. * @throws ArangoDBException - * @see API + * @see API * Documentation * @since ArangoDB 3.1.0 */ @@ -582,7 +582,7 @@ MultiDocumentEntity> deleteDocuments( * * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionEntity load() throws ArangoDBException; @@ -593,7 +593,7 @@ MultiDocumentEntity> deleteDocuments( * * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionEntity unload() throws ArangoDBException; @@ -604,7 +604,7 @@ MultiDocumentEntity> deleteDocuments( * @return information about the collection * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/collection-getting.html#return-information-about-a-collection">API * Documentation */ CollectionEntity getInfo() throws ArangoDBException; @@ -615,7 +615,7 @@ MultiDocumentEntity> deleteDocuments( * @return properties of the collection * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/collection-getting.html#read-properties-of-a-collection">API * Documentation */ CollectionPropertiesEntity getProperties() throws ArangoDBException; @@ -627,7 +627,7 @@ MultiDocumentEntity> deleteDocuments( * @return properties of the collection * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/collection-modifying.html#change-properties-of-a-collection">API * Documentation */ CollectionPropertiesEntity changeProperties(CollectionPropertiesOptions options) throws ArangoDBException; @@ -638,7 +638,7 @@ MultiDocumentEntity> deleteDocuments( * @param newName The new name * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionEntity rename(String newName) throws ArangoDBException; @@ -651,7 +651,7 @@ MultiDocumentEntity> deleteDocuments( * which the responsible shard should be determined * @return information about the responsible shard * @throws ArangoDBException - * @see + * @see * API Documentation * @since ArangoDB 3.5.0 */ @@ -662,7 +662,7 @@ MultiDocumentEntity> deleteDocuments( * * @return information about the collection, including the collections revision * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionRevisionEntity getRevision() throws ArangoDBException; @@ -675,7 +675,7 @@ MultiDocumentEntity> deleteDocuments( * @param permissions The permissions the user grant * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/user-management.html#set-the-collection-access-level"> API * Documentation */ void grantAccess(String user, Permissions permissions) throws ArangoDBException; @@ -687,7 +687,7 @@ MultiDocumentEntity> deleteDocuments( * @param user The name of the user * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/user-management.html#set-the-collection-access-level"> API * Documentation */ void revokeAccess(String user) throws ArangoDBException; @@ -698,7 +698,7 @@ MultiDocumentEntity> deleteDocuments( * @param user The name of the user * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/user-management.html#set-the-collection-access-level"> API * Documentation * @since ArangoDB 3.2.0 */ @@ -710,7 +710,7 @@ MultiDocumentEntity> deleteDocuments( * @param user The name of the user * @return permissions of the user * @throws ArangoDBException - * @see + * @see * API Documentation * @since ArangoDB 3.2.0 */ diff --git a/src/main/java/com/arangodb/ArangoDB.java b/src/main/java/com/arangodb/ArangoDB.java index 7aa23584f..2c1bdd3c1 100644 --- a/src/main/java/com/arangodb/ArangoDB.java +++ b/src/main/java/com/arangodb/ArangoDB.java @@ -644,7 +644,7 @@ public synchronized ArangoDB build() { /** * Creates a new database with the given name. * - * @see API + * @see API * Documentation * @param name * Name of the database to create @@ -656,7 +656,7 @@ public synchronized ArangoDB build() { /** * Retrieves a list of all existing databases * - * @see API + * @see API * Documentation * @return a list of all existing databases * @throws ArangoDBException @@ -667,7 +667,7 @@ public synchronized ArangoDB build() { * Retrieves a list of all databases the current user can access * * @see API + * "https://www.arangodb.com/docs/stable/http/database-database-management.html#list-of-accessible-databases">API * Documentation * @return a list of all databases the current user can access * @throws ArangoDBException @@ -678,7 +678,7 @@ public synchronized ArangoDB build() { * List available database to the specified user * * @see API + * "https://www.arangodb.com/docs/stable/http/user-management.html#list-the-accessible-databases-for-a-user">API * Documentation * @param user * The name of the user for which you want to query the databases @@ -690,7 +690,7 @@ public synchronized ArangoDB build() { /** * Returns the server name and version number. * - * @see API + * @see API * Documentation * @return the server version, number * @throws ArangoDBException @@ -700,7 +700,7 @@ public synchronized ArangoDB build() { /** * Returns the server storage engine. * - * @see API + * @see API * Documentation * @return the storage engine name * @throws ArangoDBException @@ -719,7 +719,7 @@ public synchronized ArangoDB build() { * Create a new user. This user will not have access to any database. You need permission to the _system database in * order to execute this call. * - * @see API Documentation + * @see API Documentation * @param user * The name of the user * @param passwd @@ -733,7 +733,7 @@ public synchronized ArangoDB build() { * Create a new user. This user will not have access to any database. You need permission to the _system database in * order to execute this call. * - * @see API Documentation + * @see API Documentation * @param user * The name of the user * @param passwd @@ -748,7 +748,7 @@ public synchronized ArangoDB build() { /** * Removes an existing user, identified by user. You need access to the _system database. * - * @see API Documentation + * @see API Documentation * @param user * The name of the user * @throws ArangoDBException @@ -759,7 +759,7 @@ public synchronized ArangoDB build() { * Fetches data about the specified user. You can fetch information about yourself or you need permission to the * _system database in order to execute this call. * - * @see API Documentation + * @see API Documentation * @param user * The name of the user * @return information about the user @@ -770,7 +770,7 @@ public synchronized ArangoDB build() { /** * Fetches data about all users. You can only execute this call if you have access to the _system database. * - * @see API + * @see API * Documentation * @return informations about all users * @throws ArangoDBException @@ -781,7 +781,7 @@ public synchronized ArangoDB build() { * Partially updates the data of an existing user. The name of an existing user must be specified in user. You can * only change the password of your self. You need access to the _system database to change the active flag. * - * @see API Documentation + * @see API Documentation * @param user * The name of the user * @param options @@ -795,7 +795,7 @@ public synchronized ArangoDB build() { * Replaces the data of an existing user. The name of an existing user must be specified in user. You can only * change the password of your self. You need access to the _system database to change the active flag. * - * @see API + * @see API * Documentation * @param user * The name of the user @@ -858,7 +858,7 @@ public synchronized ArangoDB build() { * Returns fatal, error, warning or info log messages from the server's global log. * * @see API + * "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API * Documentation * @param options * Additional options, can be null diff --git a/src/main/java/com/arangodb/ArangoDatabase.java b/src/main/java/com/arangodb/ArangoDatabase.java index 3b35f934d..00a8f9203 100644 --- a/src/main/java/com/arangodb/ArangoDatabase.java +++ b/src/main/java/com/arangodb/ArangoDatabase.java @@ -34,8 +34,8 @@ * * @author Mark Vollmary * @author Michele Rastelli - * @see Databases API Documentation - * @see Query API Documentation + * @see Databases API Documentation + * @see Query API Documentation */ @SuppressWarnings("UnusedReturnValue") public interface ArangoDatabase extends ArangoSerializationAccessor { @@ -59,7 +59,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * * @return the server version, number * @throws ArangoDBException - * @see API + * @see API * Documentation */ ArangoDBVersion getVersion() throws ArangoDBException; @@ -69,7 +69,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * * @return the storage engine name * @throws ArangoDBException - * @see API + * @see API * Documentation */ ArangoDBEngine getEngine() throws ArangoDBException; @@ -87,7 +87,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @return a list of all databases the current user can access * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/database-database-management.html#list-of-accessible-databases">API * Documentation */ Collection getAccessibleDatabases() throws ArangoDBException; @@ -106,7 +106,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param name The name of the collection * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionEntity createCollection(String name) throws ArangoDBException; @@ -119,7 +119,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param options Additional options, can be null * @return information about the collection * @throws ArangoDBException - * @see API + * @see API * Documentation */ CollectionEntity createCollection(String name, CollectionCreateOptions options) throws ArangoDBException; @@ -129,7 +129,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * * @return list of information about all collections * @throws ArangoDBException - * @see API + * @see API * Documentation */ Collection getCollections() throws ArangoDBException; @@ -140,7 +140,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param options Additional options, can be null * @return list of information about all collections * @throws ArangoDBException - * @see API + * @see API * Documentation */ Collection getCollections(CollectionsReadOptions options) throws ArangoDBException; @@ -151,7 +151,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param id The index-handle * @return information about the index * @throws ArangoDBException - * @see API Documentation + * @see API Documentation */ IndexEntity getIndex(String id) throws ArangoDBException; @@ -161,7 +161,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param id The index-handle * @return the id of the index * @throws ArangoDBException - * @see API Documentation + * @see API Documentation */ String deleteIndex(String id) throws ArangoDBException; @@ -170,7 +170,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * * @return true if the database was created successfully. * @throws ArangoDBException - * @see API + * @see API * Documentation */ Boolean create() throws ArangoDBException; @@ -180,7 +180,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * * @return true if the database was dropped successfully * @throws ArangoDBException - * @see API + * @see API * Documentation */ Boolean drop() throws ArangoDBException; @@ -192,7 +192,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param user The name of the user * @param permissions The permissions the user grant * @throws ArangoDBException - * @see + * @see * API Documentation */ void grantAccess(String user, Permissions permissions) throws ArangoDBException; @@ -203,7 +203,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * * @param user The name of the user * @throws ArangoDBException - * @see + * @see * API Documentation */ void grantAccess(String user) throws ArangoDBException; @@ -214,7 +214,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * * @param user The name of the user * @throws ArangoDBException - * @see + * @see * API Documentation */ void revokeAccess(String user) throws ArangoDBException; @@ -224,7 +224,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * * @param user The name of the user * @throws ArangoDBException - * @see + * @see * API Documentation * @since ArangoDB 3.2.0 */ @@ -247,7 +247,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param user The name of the user * @return permissions of the user * @throws ArangoDBException - * @see API + * @see API * Documentation * @since ArangoDB 3.2.0 */ @@ -263,7 +263,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param type The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException - * @see API + * @see API * Documentation */ ArangoCursor query(String query, Map bindVars, AqlQueryOptions options, Class type) @@ -278,7 +278,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @param type The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException - * @see API + * @see API * Documentation */ ArangoCursor query(String query, AqlQueryOptions options, Class type) throws ArangoDBException; @@ -292,7 +292,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @param type The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException - * @see API + * @see API * Documentation */ ArangoCursor query(String query, Map bindVars, Class type) throws ArangoDBException; @@ -305,7 +305,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @param type The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException - * @see API + * @see API * Documentation */ ArangoCursor query(String query, Class type) throws ArangoDBException; @@ -318,7 +318,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @return cursor of the results * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cursor-accessing-cursors.html#read-next-batch-from-cursor">API * Documentation */ ArangoCursor cursor(String cursorId, Class type) throws ArangoDBException; @@ -331,7 +331,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @param options Additional options, can be null * @return information about the query * @throws ArangoDBException - * @see API + * @see API * Documentation */ AqlExecutionExplainEntity explainQuery(String query, Map bindVars, AqlQueryExplainOptions options) @@ -344,7 +344,7 @@ AqlExecutionExplainEntity explainQuery(String query, Map bindVar * @param query the query which you want parse * @return imformation about the query * @throws ArangoDBException - * @see API + * @see API * Documentation */ AqlParseEntity parseQuery(String query) throws ArangoDBException; @@ -354,7 +354,7 @@ AqlExecutionExplainEntity explainQuery(String query, Map bindVar * * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cache.html#clears-any-results-in-the-aql-query-results-cache">API * Documentation */ void clearQueryCache() throws ArangoDBException; @@ -365,7 +365,7 @@ AqlExecutionExplainEntity explainQuery(String query, Map bindVar * @return configuration for the AQL query cache * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cache.html#returns-the-global-properties-for-the-aql-query-results-cache">API * Documentation */ QueryCachePropertiesEntity getQueryCacheProperties() throws ArangoDBException; @@ -378,7 +378,7 @@ AqlExecutionExplainEntity explainQuery(String query, Map bindVar * @return current set of properties * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cache.html#globally-adjusts-the-aql-query-results-cache-properties">API * Documentation */ QueryCachePropertiesEntity setQueryCacheProperties(QueryCachePropertiesEntity properties) throws ArangoDBException; @@ -389,7 +389,7 @@ AqlExecutionExplainEntity explainQuery(String query, Map bindVar * @return configuration for the AQL query tracking * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#returns-the-properties-for-the-aql-query-tracking">API * Documentation */ QueryTrackingPropertiesEntity getQueryTrackingProperties() throws ArangoDBException; @@ -401,7 +401,7 @@ AqlExecutionExplainEntity explainQuery(String query, Map bindVar * @return current set of properties * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#changes-the-properties-for-the-aql-query-tracking">API * Documentation */ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingPropertiesEntity properties) @@ -413,7 +413,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * @return a list of currently running AQL queries * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#returns-the-currently-running-aql-queries">API * Documentation */ Collection getCurrentlyRunningQueries() throws ArangoDBException; @@ -424,7 +424,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * @return a list of slow running AQL queries * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#returns-the-list-of-slow-aql-queries">API * Documentation */ Collection getSlowQueries() throws ArangoDBException; @@ -434,7 +434,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#clears-the-list-of-slow-aql-queries">API * Documentation */ void clearSlowQueries() throws ArangoDBException; @@ -444,7 +444,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * * @param id The id of the query * @throws ArangoDBException - * @see API + * @see API * Documentation */ void killQuery(String id) throws ArangoDBException; @@ -456,7 +456,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * @param code A String evaluating to a JavaScript function * @param options Additional options, can be null * @throws ArangoDBException - * @see API + * @see API * Documentation */ void createAqlFunction(String name, String code, AqlFunctionCreateOptions options) throws ArangoDBException; @@ -469,7 +469,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * @return number of deleted functions (since ArangoDB 3.4.0) * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-user-functions.html#remove-existing-aql-user-function">API * Documentation */ Integer deleteAqlFunction(String name, AqlFunctionDeleteOptions options) throws ArangoDBException; @@ -481,7 +481,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * @return all reqistered AQL user functions * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/aql-user-functions.html#return-registered-aql-user-functions">API * Documentation */ Collection getAqlFunctions(AqlFunctionGetOptions options) throws ArangoDBException; @@ -502,7 +502,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * @param edgeDefinitions An array of definitions for the edge * @return information about the graph * @throws ArangoDBException - * @see API + * @see API * Documentation */ GraphEntity createGraph(String name, Collection edgeDefinitions) throws ArangoDBException; @@ -516,7 +516,7 @@ QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingProperties * @param options Additional options, can be null * @return information about the graph * @throws ArangoDBException - * @see API + * @see API * Documentation */ GraphEntity createGraph(String name, Collection edgeDefinitions, GraphCreateOptions options) @@ -527,7 +527,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * * @return graphs stored in this database * @throws ArangoDBException - * @see API + * @see API * Documentation */ Collection getGraphs() throws ArangoDBException; @@ -540,7 +540,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * @param options Additional options, can be null * @return the result of the transaction if it succeeded * @throws ArangoDBException - * @see API + * @see API * Documentation */ T transaction(String action, Class type, TransactionOptions options) throws ArangoDBException; @@ -551,7 +551,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * @param options Additional options, can be null * @return information about the transaction * @throws ArangoDBException - * @see API + * @see API * Documentation * @since ArangoDB 3.5.0 */ @@ -562,7 +562,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * * @return information about the transaction * @throws ArangoDBException - * @see API + * @see API * Documentation */ StreamTransactionEntity abortStreamTransaction(String id) throws ArangoDBException; @@ -572,7 +572,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * * @return information about the transaction * @throws ArangoDBException - * @see + * @see * API Documentation * @since ArangoDB 3.5.0 */ @@ -583,7 +583,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * * @return all the currently running Stream Transactions * @throws ArangoDBException - * @see + * @see * API Documentation * @since ArangoDB 3.5.0 */ @@ -594,7 +594,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * * @return information about the transaction * @throws ArangoDBException - * @see + * @see * API Documentation * @since ArangoDB 3.5.0 */ @@ -606,7 +606,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * @return information about the current database * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/database-database-management.html#information-of-the-database">API * Documentation */ DatabaseEntity getInfo() throws ArangoDBException; @@ -619,7 +619,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * @param options Additional options * @return Result of the executed traversal * @throws ArangoDBException - * @see API + * @see API * Documentation */ TraversalEntity executeTraversal(Class vertexClass, Class edgeClass, TraversalOptions options) @@ -632,7 +632,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * @param type The type of the document (POJO class, VPackSlice or String for JSON) * @return the document identified by the id * @throws ArangoDBException - * @see API + * @see API * Documentation */ T getDocument(String id, Class type) throws ArangoDBException; @@ -645,7 +645,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * @param options Additional options, can be null * @return the document identified by the id * @throws ArangoDBException - * @see API + * @see API * Documentation */ T getDocument(String id, Class type, DocumentReadOptions options) throws ArangoDBException; @@ -655,7 +655,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * * @throws ArangoDBException * @see API + * "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#reloads-the-routing-information">API * Documentation */ void reloadRouting() throws ArangoDBException; @@ -674,7 +674,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * * @return list of information about all views * @throws ArangoDBException - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.4.0 */ Collection getViews() throws ArangoDBException; @@ -715,7 +715,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * @param options Additional options, can be null * @return information about the view * @throws ArangoDBException - * @see API + * @see API * Documentation * @since ArangoDB 3.4.0 */ @@ -727,7 +727,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * @param options AnalyzerEntity * @return the created Analyzer * @throws ArangoDBException - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ AnalyzerEntity createAnalyzer(AnalyzerEntity options) throws ArangoDBException; @@ -738,7 +738,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * @param name of the Analyzer without database prefix * @return information about an Analyzer * @throws ArangoDBException - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ AnalyzerEntity getAnalyzer(String name) throws ArangoDBException; @@ -748,7 +748,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * * @return collection of all analyzers definitions * @throws ArangoDBException - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ Collection getAnalyzers() throws ArangoDBException; @@ -758,7 +758,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * * @param name of the Analyzer without database prefix * @throws ArangoDBException - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ void deleteAnalyzer(String name) throws ArangoDBException; @@ -769,7 +769,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * @param name of the Analyzer without database prefix * @param options AnalyzerDeleteOptions * @throws ArangoDBException - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ void deleteAnalyzer(String name, AnalyzerDeleteOptions options) throws ArangoDBException; diff --git a/src/main/java/com/arangodb/ArangoEdgeCollection.java b/src/main/java/com/arangodb/ArangoEdgeCollection.java index 2a4905739..229161653 100644 --- a/src/main/java/com/arangodb/ArangoEdgeCollection.java +++ b/src/main/java/com/arangodb/ArangoEdgeCollection.java @@ -27,7 +27,7 @@ /** * Interface for operations on ArangoDB edge collection level. * - * @see API Documentation + * @see API Documentation * @author Mark Vollmary */ @SuppressWarnings("UnusedReturnValue") @@ -50,7 +50,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { /** * Creates a new edge in the collection * - * @see API Documentation + * @see API Documentation * @param value * A representation of a single edge (POJO, VPackSlice or String for JSON) * @return information about the edge @@ -61,7 +61,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { /** * Creates a new edge in the collection * - * @see API Documentation + * @see API Documentation * @param value * A representation of a single edge (POJO, VPackSlice or String for JSON) * @param options @@ -74,7 +74,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { /** * Fetches an existing edge * - * @see API Documentation + * @see API Documentation * @param key * The key of the edge * @param type @@ -87,7 +87,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { /** * Fetches an existing edge * - * @see API Documentation + * @see API Documentation * @param key * The key of the edge * @param type @@ -103,7 +103,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is * violated * - * @see API Documentation + * @see API Documentation * @param key * The key of the edge * @param @@ -117,7 +117,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is * violated * - * @see API Documentation + * @see API Documentation * @param key * The key of the edge * @param @@ -134,7 +134,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * patch (the patch document). All attributes from the patch document will be added to the existing document if they * do not yet exist, and overwritten in the existing document if they do exist there. * - * @see API Documentation + * @see API Documentation * @param key * The key of the edge * @param @@ -149,7 +149,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * patch (the patch document). All attributes from the patch document will be added to the existing document if they * do not yet exist, and overwritten in the existing document if they do exist there. * - * @see API Documentation + * @see API Documentation * @param key * The key of the edge * @param @@ -164,7 +164,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { /** * Removes a edge * - * @see API Documentation + * @see API Documentation * @param key * The key of the edge * @throws ArangoDBException @@ -174,7 +174,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { /** * Removes a edge * - * @see API Documentation + * @see API Documentation * @param key * The key of the edge * @param options diff --git a/src/main/java/com/arangodb/ArangoGraph.java b/src/main/java/com/arangodb/ArangoGraph.java index ac02999b4..bd748a8a7 100644 --- a/src/main/java/com/arangodb/ArangoGraph.java +++ b/src/main/java/com/arangodb/ArangoGraph.java @@ -29,7 +29,7 @@ /** * Interface for operations on ArangoDB graph level. * - * @see API Documentation + * @see API Documentation * @author Mark Vollmary */ public interface ArangoGraph extends ArangoSerializationAccessor { @@ -59,7 +59,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { * Creates the graph in the graph module. The creation of a graph requires the name of the graph and a definition of * its edges. * - * @see API + * @see API * Documentation * @param edgeDefinitions * An array of definitions for the edge @@ -72,7 +72,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { * Creates the graph in the graph module. The creation of a graph requires the name of the graph and a definition of * its edges. * - * @see API + * @see API * Documentation * @param edgeDefinitions * An array of definitions for the edge @@ -86,7 +86,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { /** * Deletes the graph from the database. * - * @see API Documentation + * @see API Documentation * @throws ArangoDBException */ void drop() throws ArangoDBException; @@ -95,7 +95,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { * Deletes the graph from the database. * * @see API + * "https://www.arangodb.com/docs/stable/http/gharial-management.html#drop-a-graph">API * Documentation * @param dropCollections * Drop collections of this graph as well. Collections will only be @@ -107,7 +107,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { /** * Retrieves general information about the graph. * - * @see API Documentation + * @see API Documentation * @return the definition content of this graph * @throws ArangoDBException */ @@ -116,7 +116,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { /** * Fetches all vertex collections from the graph and returns a list of collection names. * - * @see API + * @see API * Documentation * @return all vertex collections within this graph * @throws ArangoDBException @@ -127,7 +127,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { * Adds a vertex collection to the set of collections of the graph. If the collection does not exist, it will be * created. * - * @see API + * @see API * Documentation * @param name * Name of the vertex collection @@ -157,7 +157,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { /** * Fetches all edge collections from the graph and returns a list of collection names. * - * @see API + * @see API * Documentation * @return all edge collections within this graph * @throws ArangoDBException @@ -167,7 +167,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { /** * Adds the given edge definition to the graph. * - * @see API + * @see API * Documentation * @param definition * The edge definition @@ -180,7 +180,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { * Change one specific edge definition. This will modify all occurrences of this definition in all graphs known to * your database * - * @see API + * @see API * Documentation * @param definition * The edge definition @@ -194,7 +194,7 @@ public interface ArangoGraph extends ArangoSerializationAccessor { * remain untouched and can still be used in your queries * * @see API + * "https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-an-edge-definition-from-the-graph">API * Documentation * @param definitionName * The name of the edge collection used in the definition diff --git a/src/main/java/com/arangodb/ArangoSearch.java b/src/main/java/com/arangodb/ArangoSearch.java index 14e775410..65f1af0e1 100644 --- a/src/main/java/com/arangodb/ArangoSearch.java +++ b/src/main/java/com/arangodb/ArangoSearch.java @@ -28,7 +28,7 @@ /** * Interface for operations on ArangoDB view level for ArangoSearch views. * - * @see View API Documentation + * @see View API Documentation * @author Mark Vollmary * @since ArangoDB 3.4.0 */ @@ -37,7 +37,7 @@ public interface ArangoSearch extends ArangoView { /** * Creates a view, then returns view information from the server. * - * @see API + * @see API * Documentation * @return information about the view * @throws ArangoDBException @@ -47,7 +47,7 @@ public interface ArangoSearch extends ArangoView { /** * Creates a view with the given {@code options}, then returns view information from the server. * - * @see API + * @see API * Documentation * @param options * Additional options, can be null @@ -59,7 +59,7 @@ public interface ArangoSearch extends ArangoView { /** * Reads the properties of the specified view. * - * @see API + * @see API * Documentation * @return properties of the view * @throws ArangoDBException @@ -70,7 +70,7 @@ public interface ArangoSearch extends ArangoView { * Partially changes properties of the view. * * @see API + * "https://www.arangodb.com/docs/stable/http/views-arangosearch.html#partially-changes-properties-of-an-arangosearch-view">API * Documentation * @param options * properties to change @@ -83,7 +83,7 @@ public interface ArangoSearch extends ArangoView { * Changes properties of the view. * * @see API + * "https://www.arangodb.com/docs/stable/http/views-arangosearch.html#change-properties-of-an-arangosearch-view">API * Documentation * @param options * properties to change diff --git a/src/main/java/com/arangodb/ArangoVertexCollection.java b/src/main/java/com/arangodb/ArangoVertexCollection.java index b119c858b..68e44e3c3 100644 --- a/src/main/java/com/arangodb/ArangoVertexCollection.java +++ b/src/main/java/com/arangodb/ArangoVertexCollection.java @@ -27,7 +27,7 @@ /** * Interface for operations on ArangoDB vertex collection level. * - * @see API Documentation + * @see API Documentation * @author Mark Vollmary */ public interface ArangoVertexCollection extends ArangoSerializationAccessor { @@ -50,7 +50,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other * graph * - * @see API + * @see API * Documentation * @throws ArangoDBException */ @@ -59,7 +59,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { /** * Creates a new vertex in the collection * - * @see API Documentation + * @see API Documentation * @param value * A representation of a single vertex (POJO, VPackSlice or String for JSON) * @return information about the vertex @@ -70,7 +70,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { /** * Creates a new vertex in the collection * - * @see API Documentation + * @see API Documentation * @param value * A representation of a single vertex (POJO, VPackSlice or String for JSON) * @param options @@ -83,7 +83,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { /** * Retrieves the vertex document with the given {@code key} from the collection. * - * @see API Documentation + * @see API Documentation * @param key * The key of the vertex * @param type @@ -96,7 +96,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { /** * Retrieves the vertex document with the given {@code key} from the collection. * - * @see API Documentation + * @see API Documentation * @param key * The key of the vertex * @param type @@ -112,7 +112,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is * violated * - * @see API + * @see API * Documentation * @param key * The key of the vertex @@ -127,7 +127,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is * violated * - * @see API + * @see API * Documentation * @param key * The key of the vertex @@ -145,7 +145,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * patch (the patch document). All attributes from the patch document will be added to the existing document if they * do not yet exist, and overwritten in the existing document if they do exist there. * - * @see API Documentation + * @see API Documentation * @param key * The key of the vertex * @param @@ -160,7 +160,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * patch (the patch document). All attributes from the patch document will be added to the existing document if they * do not yet exist, and overwritten in the existing document if they do exist there. * - * @see API Documentation + * @see API Documentation * @param key * The key of the vertex * @param @@ -175,7 +175,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { /** * Deletes the vertex with the given {@code key} from the collection. * - * @see API Documentation + * @see API Documentation * @param key * The key of the vertex * @throws ArangoDBException @@ -185,7 +185,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { /** * Deletes the vertex with the given {@code key} from the collection. * - * @see API Documentation + * @see API Documentation * @param key * The key of the vertex * @param options diff --git a/src/main/java/com/arangodb/ArangoView.java b/src/main/java/com/arangodb/ArangoView.java index db7811dd3..e0afbede5 100644 --- a/src/main/java/com/arangodb/ArangoView.java +++ b/src/main/java/com/arangodb/ArangoView.java @@ -25,7 +25,7 @@ /** * Interface for operations on ArangoDB view level. * - * @see View API Documentation + * @see View API Documentation * @author Mark Vollmary * @since ArangoDB 3.4.0 */ @@ -57,7 +57,7 @@ public interface ArangoView extends ArangoSerializationAccessor { /** * Deletes the view from the database. * - * @see API Documentation + * @see API Documentation * @throws ArangoDBException */ void drop() throws ArangoDBException; @@ -65,7 +65,7 @@ public interface ArangoView extends ArangoSerializationAccessor { /** * Renames the view. * - * @see API Documentation + * @see API Documentation * @param newName * The new name * @return information about the view @@ -76,7 +76,7 @@ public interface ArangoView extends ArangoSerializationAccessor { /** * Returns information about the view. * - * @see API + * @see API * Documentation * @return information about the view * @throws ArangoDBException diff --git a/src/main/java/com/arangodb/async/ArangoCollectionAsync.java b/src/main/java/com/arangodb/async/ArangoCollectionAsync.java index e11b028df..3438a6a9a 100644 --- a/src/main/java/com/arangodb/async/ArangoCollectionAsync.java +++ b/src/main/java/com/arangodb/async/ArangoCollectionAsync.java @@ -32,8 +32,8 @@ * Interface for operations on ArangoDB collection level. * * @author Mark Vollmary - * @see Collection API Documentation - * @see Documents API Documentation + * @see Collection API Documentation + * @see Documents API Documentation */ @SuppressWarnings("unused") public interface ArangoCollectionAsync extends ArangoSerializationAccessor { @@ -58,7 +58,7 @@ public interface ArangoCollectionAsync extends ArangoSerializationAccessor { * * @param value A representation of a single document (POJO, VPackSlice or String for Json) * @return information about the document - * @see API + * @see API * Documentation */ CompletableFuture> insertDocument(final T value); @@ -70,7 +70,7 @@ public interface ArangoCollectionAsync extends ArangoSerializationAccessor { * @param value A representation of a single document (POJO, VPackSlice or String for Json) * @param options Additional options, can be null * @return information about the document - * @see API + * @see API * Documentation */ CompletableFuture> insertDocument(final T value, final DocumentCreateOptions options); @@ -81,7 +81,7 @@ public interface ArangoCollectionAsync extends ArangoSerializationAccessor { * * @param values A List of documents (POJO, VPackSlice or String for Json) * @return information about the documents - * @see API + * @see API * Documentation */ CompletableFuture>> insertDocuments(final Collection values); @@ -93,7 +93,7 @@ public interface ArangoCollectionAsync extends ArangoSerializationAccessor { * @param values A List of documents (POJO, VPackSlice or String for Json) * @param options Additional options, can be null * @return information about the documents - * @see API + * @see API * Documentation */ CompletableFuture>> insertDocuments( @@ -142,7 +142,7 @@ CompletableFuture importDocuments( * @param key The key of the document * @param type The type of the document (POJO class, VPackSlice or String for Json) * @return the document identified by the key - * @see API + * @see API * Documentation */ CompletableFuture getDocument(final String key, final Class type) throws ArangoDBException; @@ -154,7 +154,7 @@ CompletableFuture importDocuments( * @param type The type of the document (POJO class, VPackSlice or String for Json) * @param options Additional options, can be null * @return the document identified by the key - * @see API + * @see API * Documentation */ CompletableFuture getDocument(final String key, final Class type, final DocumentReadOptions options) @@ -189,7 +189,7 @@ CompletableFuture> getDocuments( * @param key The key of the document * @param value A representation of a single document (POJO, VPackSlice or String for Json) * @return information about the document - * @see API + * @see API * Documentation */ CompletableFuture> replaceDocument(final String key, final T value); @@ -202,7 +202,7 @@ CompletableFuture> getDocuments( * @param value A representation of a single document (POJO, VPackSlice or String for Json) * @param options Additional options, can be null * @return information about the document - * @see API + * @see API * Documentation */ CompletableFuture> replaceDocument( @@ -216,7 +216,7 @@ CompletableFuture> replaceDocument( * * @param values A List of documents (POJO, VPackSlice or String for Json) * @return information about the documents - * @see API + * @see API * Documentation */ CompletableFuture>> replaceDocuments(final Collection values); @@ -228,7 +228,7 @@ CompletableFuture> replaceDocument( * @param values A List of documents (POJO, VPackSlice or String for Json) * @param options Additional options, can be null * @return information about the documents - * @see API + * @see API * Documentation */ CompletableFuture>> replaceDocuments( @@ -243,7 +243,7 @@ CompletableFuture>> replaceDocum * @param key The key of the document * @param value A representation of a single document (POJO, VPackSlice or String for Json) * @return information about the document - * @see API + * @see API * Documentation */ CompletableFuture> updateDocument(final String key, final T value); @@ -257,7 +257,7 @@ CompletableFuture>> replaceDocum * @param value A representation of a single document (POJO, VPackSlice or String for Json) * @param options Additional options, can be null * @return information about the document - * @see API + * @see API * Documentation */ CompletableFuture> updateDocument( @@ -273,7 +273,7 @@ CompletableFuture> updateDocument( * * @param values A list of documents (POJO, VPackSlice or String for Json) * @return information about the documents - * @see API + * @see API * Documentation */ CompletableFuture>> updateDocuments(final Collection values); @@ -287,7 +287,7 @@ CompletableFuture> updateDocument( * @param values A list of documents (POJO, VPackSlice or String for Json) * @param options Additional options, can be null * @return information about the documents - * @see API + * @see API * Documentation */ CompletableFuture>> updateDocuments( @@ -299,7 +299,7 @@ CompletableFuture>> updateDocume * * @param key The key of the document * @return information about the document - * @see API + * @see API * Documentation */ CompletableFuture> deleteDocument(final String key); @@ -312,7 +312,7 @@ CompletableFuture>> updateDocume * options.returnOld is set to true, otherwise can be null. * @param options Additional options, can be null * @return information about the document - * @see API + * @see API * Documentation */ CompletableFuture> deleteDocument( @@ -326,7 +326,7 @@ CompletableFuture> deleteDocument( * @param values The keys of the documents or the documents themselves * @return information about the documents * @see API + * "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#removes-multiple-documents">API * Documentation */ CompletableFuture>> deleteDocuments(final Collection values); @@ -340,7 +340,7 @@ CompletableFuture> deleteDocument( * @param options Additional options, can be null * @return information about the documents * @see API + * "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#removes-multiple-documents">API * Documentation */ CompletableFuture>> deleteDocuments( @@ -354,7 +354,7 @@ CompletableFuture>> deleteDocume * @param key The key of the document * @return true if the document was found, otherwise false * @see API + * "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#read-document-header">API * Documentation */ CompletableFuture documentExists(final String key); @@ -366,7 +366,7 @@ CompletableFuture>> deleteDocume * @param options Additional options, can be null * @return true if the document was found, otherwise false * @see API + * "https://www.arangodb.com/docs/stable/http/document-working-with-documents.html#read-document-header">API * Documentation */ CompletableFuture documentExists(final String key, final DocumentExistsOptions options); @@ -376,7 +376,7 @@ CompletableFuture>> deleteDocume * * @param id The index-handle * @return information about the index - * @see API Documentation + * @see API Documentation */ CompletableFuture getIndex(final String id); @@ -385,7 +385,7 @@ CompletableFuture>> deleteDocume * * @param id The index-handle * @return the id of the index - * @see API Documentation + * @see API Documentation */ CompletableFuture deleteIndex(final String id); @@ -395,7 +395,7 @@ CompletableFuture>> deleteDocume * @param fields A list of attribute paths * @param options Additional options, can be null * @return information about the index - * @see API Documentation + * @see API Documentation */ CompletableFuture ensureHashIndex(final Iterable fields, final HashIndexOptions options); @@ -405,7 +405,7 @@ CompletableFuture>> deleteDocume * @param fields A list of attribute paths * @param options Additional options, can be null * @return information about the index - * @see API + * @see API * Documentation */ CompletableFuture ensureSkiplistIndex( @@ -418,7 +418,7 @@ CompletableFuture ensureSkiplistIndex( * @param fields A list of attribute paths * @param options Additional options, can be null * @return information about the index - * @see API + * @see API * Documentation */ CompletableFuture ensurePersistentIndex( @@ -431,7 +431,7 @@ CompletableFuture ensurePersistentIndex( * @param fields A list of attribute paths * @param options Additional options, can be null * @return information about the index - * @see API + * @see API * Documentation */ CompletableFuture ensureGeoIndex(final Iterable fields, final GeoIndexOptions options); @@ -442,7 +442,7 @@ CompletableFuture ensurePersistentIndex( * @param fields A list of attribute paths * @param options Additional options, can be null * @return information about the index - * @see API + * @see API * Documentation */ CompletableFuture ensureFulltextIndex( @@ -465,7 +465,7 @@ CompletableFuture ensureFulltextIndex( * * @return information about the indexes * @see API + * "https://www.arangodb.com/docs/stable/http/indexes-working-with.html#read-all-indexes-of-a-collection">API * Documentation */ CompletableFuture> getIndexes(); @@ -481,7 +481,7 @@ CompletableFuture ensureFulltextIndex( * Removes all documents from the collection, but leaves the indexes intact * * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture truncate(); @@ -490,7 +490,7 @@ CompletableFuture ensureFulltextIndex( * Removes all documents from the collection, but leaves the indexes intact * * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture truncate(CollectionTruncateOptions options); @@ -500,7 +500,7 @@ CompletableFuture ensureFulltextIndex( * * @return information about the collection, including the number of documents * @see API + * "https://www.arangodb.com/docs/stable/http/collection-getting.html#return-number-of-documents-in-a-collection">API * Documentation */ CompletableFuture count(); @@ -510,7 +510,7 @@ CompletableFuture ensureFulltextIndex( * * @return information about the collection, including the number of documents * @see API + * "https://www.arangodb.com/docs/stable/http/collection-getting.html#return-number-of-documents-in-a-collection">API * Documentation */ CompletableFuture count(CollectionCountOptions options); @@ -519,7 +519,7 @@ CompletableFuture ensureFulltextIndex( * Creates the collection * * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture create(); @@ -529,7 +529,7 @@ CompletableFuture ensureFulltextIndex( * * @param options Additional options, can be null * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture create(final CollectionCreateOptions options); @@ -538,7 +538,7 @@ CompletableFuture ensureFulltextIndex( * Drops the collection * * @return void - * @see API + * @see API * Documentation */ CompletableFuture drop(); @@ -549,7 +549,7 @@ CompletableFuture ensureFulltextIndex( * @param isSystem Whether or not the collection to drop is a system collection. This parameter must be set to true in * order to drop a system collection. * @return void - * @see API + * @see API * Documentation */ CompletableFuture drop(final boolean isSystem); @@ -558,7 +558,7 @@ CompletableFuture ensureFulltextIndex( * Loads a collection into memory. * * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture load(); @@ -568,7 +568,7 @@ CompletableFuture ensureFulltextIndex( * in which case it will be loaded into memory, again. * * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture unload(); @@ -578,7 +578,7 @@ CompletableFuture ensureFulltextIndex( * * @return information about the collection * @see API + * "https://www.arangodb.com/docs/stable/http/collection-getting.html#return-information-about-a-collection">API * Documentation */ CompletableFuture getInfo(); @@ -588,7 +588,7 @@ CompletableFuture ensureFulltextIndex( * * @return properties of the collection * @see API + * "https://www.arangodb.com/docs/stable/http/collection-getting.html#read-properties-of-a-collection">API * Documentation */ CompletableFuture getProperties(); @@ -599,7 +599,7 @@ CompletableFuture ensureFulltextIndex( * @param options Additional options, can be null * @return properties of the collection * @see API + * "https://www.arangodb.com/docs/stable/http/collection-modifying.html#change-properties-of-a-collection">API * Documentation */ CompletableFuture changeProperties(final CollectionPropertiesOptions options); @@ -609,7 +609,7 @@ CompletableFuture ensureFulltextIndex( * * @param newName The new name * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture rename(final String newName); @@ -621,7 +621,7 @@ CompletableFuture ensureFulltextIndex( * @param value A projection of the document containing at least the shard key (_key or a custom attribute) for * which the responsible shard should be determined * @return information about the responsible shard - * @see + * @see * API Documentation * @since ArangoDB 3.5.0 */ @@ -631,7 +631,7 @@ CompletableFuture ensureFulltextIndex( * Retrieve the collections revision * * @return information about the collection, including the collections revision - * @see API + * @see API * Documentation */ CompletableFuture getRevision(); @@ -644,7 +644,7 @@ CompletableFuture ensureFulltextIndex( * @param permissions The permissions the user grant * @return void * @see API + * "https://www.arangodb.com/docs/stable/http/user-management.html#set-the-collection-access-level"> API * Documentation */ CompletableFuture grantAccess(final String user, final Permissions permissions); @@ -656,7 +656,7 @@ CompletableFuture ensureFulltextIndex( * @param user The name of the user * @return void * @see API + * "https://www.arangodb.com/docs/stable/http/user-management.html#set-the-collection-access-level"> API * Documentation */ CompletableFuture revokeAccess(final String user); @@ -667,7 +667,7 @@ CompletableFuture ensureFulltextIndex( * @param user The name of the user * @return void * @see API + * "https://www.arangodb.com/docs/stable/http/user-management.html#set-the-collection-access-level"> API * Documentation * @since ArangoDB 3.2.0 */ @@ -678,7 +678,7 @@ CompletableFuture ensureFulltextIndex( * * @param user The name of the user * @return permissions of the user - * @see + * @see * API Documentation * @since ArangoDB 3.2.0 */ diff --git a/src/main/java/com/arangodb/async/ArangoDBAsync.java b/src/main/java/com/arangodb/async/ArangoDBAsync.java index 4d1767657..168752901 100644 --- a/src/main/java/com/arangodb/async/ArangoDBAsync.java +++ b/src/main/java/com/arangodb/async/ArangoDBAsync.java @@ -92,7 +92,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * * @param name Has to contain a valid database name * @return true if the database was created successfully. - * @see API + * @see API * Documentation */ CompletableFuture createDatabase(final String name); @@ -101,7 +101,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * Retrieves a list of all existing databases * * @return a list of all existing databases - * @see API + * @see API * Documentation */ CompletableFuture> getDatabases(); @@ -111,7 +111,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * * @return a list of all databases the current user can access * @see API + * "https://www.arangodb.com/docs/stable/http/database-database-management.html#list-of-accessible-databases">API * Documentation */ CompletableFuture> getAccessibleDatabases(); @@ -122,7 +122,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * @param user The name of the user for which you want to query the databases * @return * @see API + * "https://www.arangodb.com/docs/stable/http/user-management.html#list-the-accessible-databases-for-a-user">API * Documentation */ CompletableFuture> getAccessibleDatabasesFor(final String user); @@ -131,7 +131,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * Returns the server name and version number. * * @return the server version, number - * @see API + * @see API * Documentation */ CompletableFuture getVersion(); @@ -150,7 +150,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * @param user The name of the user * @param passwd The user password * @return information about the user - * @see API Documentation + * @see API Documentation */ CompletableFuture createUser(final String user, final String passwd); @@ -162,7 +162,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * @param passwd The user password * @param options Additional properties of the user, can be null * @return information about the user - * @see API Documentation + * @see API Documentation */ CompletableFuture createUser(final String user, final String passwd, final UserCreateOptions options); @@ -171,7 +171,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * * @param user The name of the user * @return void - * @see API Documentation + * @see API Documentation */ CompletableFuture deleteUser(final String user); @@ -181,7 +181,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * * @param user The name of the user * @return information about the user - * @see API Documentation + * @see API Documentation */ CompletableFuture getUser(final String user); @@ -189,7 +189,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * Fetches data about all users. You can only execute this call if you have access to the _system database. * * @return informations about all users - * @see API + * @see API * Documentation */ CompletableFuture> getUsers(); @@ -201,7 +201,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * @param user The name of the user * @param options Properties of the user to be changed * @return information about the user - * @see API Documentation + * @see API Documentation */ CompletableFuture updateUser(final String user, final UserUpdateOptions options); @@ -212,7 +212,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * @param user The name of the user * @param options Additional properties of the user, can be null * @return information about the user - * @see API + * @see API * Documentation */ CompletableFuture replaceUser(final String user, final UserUpdateOptions options); @@ -253,7 +253,7 @@ public interface ArangoDBAsync extends ArangoSerializationAccessor { * @param options Additional options, can be null * @return the log messages * @see API + * "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API * Documentation */ CompletableFuture getLogs(final LogOptions options); diff --git a/src/main/java/com/arangodb/async/ArangoDatabaseAsync.java b/src/main/java/com/arangodb/async/ArangoDatabaseAsync.java index 9a6c7a7c3..572da7452 100644 --- a/src/main/java/com/arangodb/async/ArangoDatabaseAsync.java +++ b/src/main/java/com/arangodb/async/ArangoDatabaseAsync.java @@ -36,8 +36,8 @@ * Interface for operations on ArangoDB database level. * * @author Mark Vollmary - * @see Databases API Documentation - * @see Query API Documentation + * @see Databases API Documentation + * @see Query API Documentation */ @SuppressWarnings("unused") public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { @@ -60,7 +60,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * Returns the server name and version number. * * @return the server version, number - * @see API + * @see API * Documentation */ CompletableFuture getVersion(); @@ -69,7 +69,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * Returns the name of the used storage engine. * * @return the storage engine name - * @see API + * @see API * Documentation */ CompletableFuture getEngine(); @@ -86,7 +86,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @return a list of all databases the current user can access * @see API + * "https://www.arangodb.com/docs/stable/http/database-database-management.html#list-of-accessible-databases">API * Documentation */ CompletableFuture> getAccessibleDatabases(); @@ -104,7 +104,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @param name The name of the collection * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture createCollection(final String name); @@ -115,7 +115,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * @param name The name of the collection * @param options Additional options, can be null * @return information about the collection - * @see API + * @see API * Documentation */ CompletableFuture createCollection(final String name, final CollectionCreateOptions options); @@ -124,7 +124,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * Returns all collections * * @return list of information about all collections - * @see API + * @see API * Documentation */ CompletableFuture> getCollections(); @@ -134,7 +134,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @param options Additional options, can be null * @return list of information about all collections - * @see API + * @see API * Documentation */ CompletableFuture> getCollections(final CollectionsReadOptions options); @@ -144,7 +144,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @param id The index-handle * @return information about the index - * @see API Documentation + * @see API Documentation */ CompletableFuture getIndex(final String id); @@ -153,7 +153,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @param id The index handle * @return the id of the index - * @see API Documentation + * @see API Documentation */ CompletableFuture deleteIndex(final String id); @@ -161,7 +161,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * Creates the database * * @return true if the database was created successfully. - * @see API + * @see API * Documentation */ CompletableFuture create(); @@ -170,7 +170,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * Drop an existing database * * @return true if the database was dropped successfully - * @see API + * @see API * Documentation */ CompletableFuture drop(); @@ -182,7 +182,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * @param user The name of the user * @param permissions The permissions the user grant * @return void - * @see + * @see * API Documentation */ CompletableFuture grantAccess(final String user, final Permissions permissions); @@ -193,7 +193,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @param user The name of the user * @return void - * @see + * @see * API Documentation */ CompletableFuture grantAccess(final String user); @@ -204,7 +204,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @param user The name of the user * @return void - * @see + * @see * API Documentation */ CompletableFuture revokeAccess(final String user); @@ -214,7 +214,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @param user The name of the user * @return void - * @see + * @see * API Documentation * @since ArangoDB 3.2.0 */ @@ -235,7 +235,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * * @param user The name of the user * @return permissions of the user - * @see API + * @see API * Documentation * @since ArangoDB 3.2.0 */ @@ -250,7 +250,7 @@ public interface ArangoDatabaseAsync extends ArangoSerializationAccessor { * @param options Additional options, can be null * @param type The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) * @return cursor of the results - * @see API + * @see API * Documentation */ CompletableFuture> query( @@ -267,7 +267,7 @@ CompletableFuture> query( * @param options Additional options, can be null * @param type The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) * @return cursor of the results - * @see API + * @see API * Documentation */ CompletableFuture> query( @@ -283,7 +283,7 @@ CompletableFuture> query( * @param bindVars key/value pairs representing the bind parameters * @param type The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) * @return cursor of the results - * @see API + * @see API * Documentation */ CompletableFuture> query( @@ -298,7 +298,7 @@ CompletableFuture> query( * @param query contains the query string to be executed * @param type The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) * @return cursor of the results - * @see API + * @see API * Documentation */ CompletableFuture> query(final String query, final Class type); @@ -310,7 +310,7 @@ CompletableFuture> query( * @param type The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) * @return cursor of the results * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cursor-accessing-cursors.html#read-next-batch-from-cursor">API * Documentation */ CompletableFuture> cursor(final String cursorId, final Class type); @@ -322,7 +322,7 @@ CompletableFuture> query( * @param bindVars key/value pairs representing the bind parameters * @param options Additional options, can be null * @return information about the query - * @see API + * @see API * Documentation */ CompletableFuture explainQuery( @@ -336,7 +336,7 @@ CompletableFuture explainQuery( * * @param query the query which you want parse * @return imformation about the query - * @see API + * @see API * Documentation */ CompletableFuture parseQuery(final String query); @@ -346,7 +346,7 @@ CompletableFuture explainQuery( * * @return void * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cache.html#clears-any-results-in-the-aql-query-results-cache">API * Documentation */ CompletableFuture clearQueryCache(); @@ -356,7 +356,7 @@ CompletableFuture explainQuery( * * @return configuration for the AQL query cache * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cache.html#returns-the-global-properties-for-the-aql-query-results-cache">API * Documentation */ CompletableFuture getQueryCacheProperties(); @@ -368,7 +368,7 @@ CompletableFuture explainQuery( * @param properties properties to be set * @return current set of properties * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cache.html#globally-adjusts-the-aql-query-results-cache-properties">API * Documentation */ CompletableFuture setQueryCacheProperties(final QueryCachePropertiesEntity properties); @@ -378,7 +378,7 @@ CompletableFuture explainQuery( * * @return configuration for the AQL query tracking * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#returns-the-properties-for-the-aql-query-tracking">API * Documentation */ CompletableFuture getQueryTrackingProperties(); @@ -389,7 +389,7 @@ CompletableFuture explainQuery( * @param properties properties to be set * @return current set of properties * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#changes-the-properties-for-the-aql-query-tracking">API * Documentation */ CompletableFuture setQueryTrackingProperties( @@ -400,7 +400,7 @@ CompletableFuture setQueryTrackingProperties( * * @return a list of currently running AQL queries * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#returns-the-currently-running-aql-queries">API * Documentation */ CompletableFuture> getCurrentlyRunningQueries(); @@ -410,7 +410,7 @@ CompletableFuture setQueryTrackingProperties( * * @return a list of slow running AQL queries * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#returns-the-list-of-slow-aql-queries">API * Documentation */ CompletableFuture> getSlowQueries(); @@ -420,7 +420,7 @@ CompletableFuture setQueryTrackingProperties( * * @return void * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query.html#clears-the-list-of-slow-aql-queries">API * Documentation */ CompletableFuture clearSlowQueries(); @@ -430,7 +430,7 @@ CompletableFuture setQueryTrackingProperties( * * @param id The id of the query * @return void - * @see API + * @see API * Documentation */ CompletableFuture killQuery(final String id); @@ -442,7 +442,7 @@ CompletableFuture setQueryTrackingProperties( * @param code a string representation of the function body * @param options Additional options, can be null * @return void - * @see API + * @see API * Documentation */ CompletableFuture createAqlFunction( @@ -457,7 +457,7 @@ CompletableFuture createAqlFunction( * @param options Additional options, can be null * @return number of deleted functions (since ArangoDB 3.4.0) * @see API + * "https://www.arangodb.com/docs/stable/http/aql-user-functions.html#remove-existing-aql-user-function">API * Documentation */ CompletableFuture deleteAqlFunction(final String name, final AqlFunctionDeleteOptions options); @@ -468,7 +468,7 @@ CompletableFuture createAqlFunction( * @param options Additional options, can be null * @return all reqistered AQL user functions * @see API + * "https://www.arangodb.com/docs/stable/http/aql-user-functions.html#return-registered-aql-user-functions">API * Documentation */ CompletableFuture> getAqlFunctions(final AqlFunctionGetOptions options); @@ -488,7 +488,7 @@ CompletableFuture createAqlFunction( * @param name Name of the graph * @param edgeDefinitions An array of definitions for the edge * @return information about the graph - * @see API + * @see API * Documentation */ CompletableFuture createGraph(final String name, final Collection edgeDefinitions); @@ -501,7 +501,7 @@ CompletableFuture createAqlFunction( * @param edgeDefinitions An array of definitions for the edge * @param options Additional options, can be null * @return information about the graph - * @see API + * @see API * Documentation */ CompletableFuture createGraph( @@ -513,7 +513,7 @@ CompletableFuture createGraph( * Lists all graphs known to the graph module * * @return graphs stored in this database - * @see API + * @see API * Documentation */ CompletableFuture> getGraphs(); @@ -525,7 +525,7 @@ CompletableFuture createGraph( * @param type The type of the result (POJO class, VPackSlice or String for Json) * @param options Additional options, can be null * @return the result of the transaction if it succeeded - * @see API + * @see API * Documentation */ CompletableFuture transaction(final String action, final Class type, final TransactionOptions options); @@ -535,7 +535,7 @@ CompletableFuture createGraph( * * @param options Additional options, can be null * @return information about the transaction - * @see API + * @see API * Documentation * @since ArangoDB 3.5.0 */ @@ -545,7 +545,7 @@ CompletableFuture createGraph( * Aborts a Stream Transaction. * * @return information about the transaction - * @see API + * @see API * Documentation */ CompletableFuture abortStreamTransaction(String id); @@ -554,7 +554,7 @@ CompletableFuture createGraph( * Gets information about a Stream Transaction. * * @return information about the transaction - * @see + * @see * API Documentation * @since ArangoDB 3.5.0 */ @@ -564,7 +564,7 @@ CompletableFuture createGraph( * Gets all the currently running Stream Transactions. * * @return all the currently running Stream Transactions - * @see + * @see * API Documentation * @since ArangoDB 3.5.0 */ @@ -574,7 +574,7 @@ CompletableFuture createGraph( * Commits a Stream Transaction. * * @return information about the transaction - * @see + * @see * API Documentation * @since ArangoDB 3.5.0 */ @@ -585,7 +585,7 @@ CompletableFuture createGraph( * * @return information about the current database * @see API + * "https://www.arangodb.com/docs/stable/http/database-database-management.html#information-of-the-database">API * Documentation */ CompletableFuture getInfo(); @@ -597,7 +597,7 @@ CompletableFuture createGraph( * @param edgeClass The type of the edge documents (POJO class, VPackSlice or String for Json) * @param options Additional options * @return Result of the executed traversal - * @see API + * @see API * Documentation */ CompletableFuture> executeTraversal( @@ -611,7 +611,7 @@ CompletableFuture> executeTraversal( * @param id The id of the document * @param type The type of the document (POJO class, VPackSlice or String for Json) * @return the document identified by the id - * @see API + * @see API * Documentation */ CompletableFuture getDocument(final String id, final Class type) throws ArangoDBException; @@ -623,7 +623,7 @@ CompletableFuture> executeTraversal( * @param type The type of the document (POJO class, VPackSlice or String for Json) * @param options Additional options, can be null * @return the document identified by the id - * @see API + * @see API * Documentation */ CompletableFuture getDocument(final String id, final Class type, final DocumentReadOptions options) @@ -634,7 +634,7 @@ CompletableFuture getDocument(final String id, final Class type, final * * @return void * @see API + * "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#reloads-the-routing-information">API * Documentation */ CompletableFuture reloadRouting(); @@ -652,7 +652,7 @@ CompletableFuture getDocument(final String id, final Class type, final * Fetches all views from the database and returns an list of view descriptions. * * @return list of information about all views - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.4.0 */ CompletableFuture> getViews(); @@ -691,7 +691,7 @@ CompletableFuture getDocument(final String id, final Class type, final * @param name The name of the view * @param options Additional options, can be null * @return information about the view - * @see API + * @see API * Documentation * @since ArangoDB 3.4.0 */ @@ -702,7 +702,7 @@ CompletableFuture getDocument(final String id, final Class type, final * * @param options AnalyzerEntity * @return the created Analyzer - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ CompletableFuture createAnalyzer(AnalyzerEntity options); @@ -712,7 +712,7 @@ CompletableFuture getDocument(final String id, final Class type, final * * @param name of the Analyzer without database prefix * @return information about an Analyzer - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ CompletableFuture getAnalyzer(String name); @@ -721,7 +721,7 @@ CompletableFuture getDocument(final String id, final Class type, final * Retrieves all analyzers definitions. * * @return collection of all analyzers definitions - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ CompletableFuture> getAnalyzers(); @@ -730,7 +730,7 @@ CompletableFuture getDocument(final String id, final Class type, final * Deletes an Analyzer * * @param name of the Analyzer without database prefix - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ CompletableFuture deleteAnalyzer(String name); @@ -740,7 +740,7 @@ CompletableFuture getDocument(final String id, final Class type, final * * @param name of the Analyzer without database prefix * @param options AnalyzerDeleteOptions - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ CompletableFuture deleteAnalyzer(String name, AnalyzerDeleteOptions options); diff --git a/src/main/java/com/arangodb/async/ArangoEdgeCollectionAsync.java b/src/main/java/com/arangodb/async/ArangoEdgeCollectionAsync.java index 7f7cb4585..2dea8807c 100644 --- a/src/main/java/com/arangodb/async/ArangoEdgeCollectionAsync.java +++ b/src/main/java/com/arangodb/async/ArangoEdgeCollectionAsync.java @@ -31,7 +31,7 @@ * Interface for operations on ArangoDB edge collection level. * * @author Mark Vollmary - * @see API Documentation + * @see API Documentation */ @SuppressWarnings("unused") public interface ArangoEdgeCollectionAsync extends ArangoSerializationAccessor { @@ -55,7 +55,7 @@ public interface ArangoEdgeCollectionAsync extends ArangoSerializationAccessor { * * @param value A representation of a single edge (POJO, VPackSlice or String for Json) * @return information about the edge - * @see API Documentation + * @see API Documentation */ CompletableFuture insertEdge(final T value); @@ -65,7 +65,7 @@ public interface ArangoEdgeCollectionAsync extends ArangoSerializationAccessor { * @param value A representation of a single edge (POJO, VPackSlice or String for Json) * @param options Additional options, can be null * @return information about the edge - * @see API Documentation + * @see API Documentation */ CompletableFuture insertEdge(final T value, final EdgeCreateOptions options); @@ -75,7 +75,7 @@ public interface ArangoEdgeCollectionAsync extends ArangoSerializationAccessor { * @param key The key of the edge * @param type The type of the edge-document (POJO class, VPackSlice or String for Json) * @return the edge identified by the key - * @see API Documentation + * @see API Documentation */ CompletableFuture getEdge(final String key, final Class type); @@ -86,7 +86,7 @@ public interface ArangoEdgeCollectionAsync extends ArangoSerializationAccessor { * @param type The type of the edge-document (POJO class, VPackSlice or String for Json) * @param options Additional options, can be null * @return the edge identified by the key - * @see API Documentation + * @see API Documentation */ CompletableFuture getEdge(final String key, final Class type, final GraphDocumentReadOptions options); @@ -96,7 +96,7 @@ public interface ArangoEdgeCollectionAsync extends ArangoSerializationAccessor { * * @param key The key of the edge * @return information about the edge - * @see API Documentation + * @see API Documentation */ CompletableFuture replaceEdge(final String key, final T value); @@ -107,7 +107,7 @@ public interface ArangoEdgeCollectionAsync extends ArangoSerializationAccessor { * @param key The key of the edge * @param options Additional options, can be null * @return information about the edge - * @see API Documentation + * @see API Documentation */ CompletableFuture replaceEdge( final String key, @@ -121,7 +121,7 @@ CompletableFuture replaceEdge( * * @param key The key of the edge * @return information about the edge - * @see API Documentation + * @see API Documentation */ CompletableFuture updateEdge(final String key, final T value); @@ -133,7 +133,7 @@ CompletableFuture replaceEdge( * @param key The key of the edge * @param options Additional options, can be null * @return information about the edge - * @see API Documentation + * @see API Documentation */ CompletableFuture updateEdge( final String key, @@ -144,7 +144,7 @@ CompletableFuture updateEdge( * Removes a edge * * @param key The key of the edge - * @see API Documentation + * @see API Documentation */ CompletableFuture deleteEdge(final String key); @@ -153,7 +153,7 @@ CompletableFuture updateEdge( * * @param key The key of the edge * @param options Additional options, can be null - * @see API Documentation + * @see API Documentation */ CompletableFuture deleteEdge(final String key, final EdgeDeleteOptions options); diff --git a/src/main/java/com/arangodb/async/ArangoGraphAsync.java b/src/main/java/com/arangodb/async/ArangoGraphAsync.java index 9633f5c40..34bd0d5f3 100644 --- a/src/main/java/com/arangodb/async/ArangoGraphAsync.java +++ b/src/main/java/com/arangodb/async/ArangoGraphAsync.java @@ -32,7 +32,7 @@ * Interface for operations on ArangoDB graph level. * * @author Mark Vollmary - * @see API Documentation + * @see API Documentation */ @SuppressWarnings("unused") public interface ArangoGraphAsync extends ArangoSerializationAccessor { @@ -64,7 +64,7 @@ public interface ArangoGraphAsync extends ArangoSerializationAccessor { * * @param edgeDefinitions An array of definitions for the edge * @return information about the graph - * @see API + * @see API * Documentation */ CompletableFuture create(final Collection edgeDefinitions); @@ -76,7 +76,7 @@ public interface ArangoGraphAsync extends ArangoSerializationAccessor { * @param edgeDefinitions An array of definitions for the edge * @param options Additional options, can be null * @return information about the graph - * @see API + * @see API * Documentation */ CompletableFuture createGraph( @@ -87,7 +87,7 @@ CompletableFuture createGraph( * Delete an existing graph * * @return void - * @see API Documentation + * @see API Documentation */ CompletableFuture drop(); @@ -97,7 +97,7 @@ CompletableFuture createGraph( * @param dropCollections Drop collections of this graph as well. Collections will only be dropped if they are not used in other * graphs. * @return void - * @see API Documentation + * @see API Documentation */ CompletableFuture drop(boolean dropCollections); @@ -105,7 +105,7 @@ CompletableFuture createGraph( * Get a graph from the graph module * * @return the definition content of this graph - * @see API Documentation + * @see API Documentation */ CompletableFuture getInfo(); @@ -113,7 +113,7 @@ CompletableFuture createGraph( * Lists all vertex collections used in this graph * * @return all vertex collections within this graph - * @see API + * @see API * Documentation */ CompletableFuture> getVertexCollections(); @@ -124,7 +124,7 @@ CompletableFuture createGraph( * * @param name The name of the collection * @return information about the graph - * @see API + * @see API * Documentation */ CompletableFuture addVertexCollection(final String name); @@ -149,7 +149,7 @@ CompletableFuture createGraph( * Lists all edge collections used in this graph * * @return all edge collections within this graph - * @see API + * @see API * Documentation */ CompletableFuture> getEdgeDefinitions(); @@ -159,7 +159,7 @@ CompletableFuture createGraph( * * @param definition * @return information about the graph - * @see API + * @see API * Documentation */ CompletableFuture addEdgeDefinition(final EdgeDefinition definition); @@ -170,7 +170,7 @@ CompletableFuture createGraph( * * @param definition The edge definition * @return information about the graph - * @see API + * @see API * Documentation */ CompletableFuture replaceEdgeDefinition(final EdgeDefinition definition); @@ -182,7 +182,7 @@ CompletableFuture createGraph( * @param definitionName The name of the edge collection used in the definition * @return information about the graph * @see API + * "https://www.arangodb.com/docs/stable/http/gharial-management.html#remove-an-edge-definition-from-the-graph">API * Documentation */ CompletableFuture removeEdgeDefinition(final String definitionName); diff --git a/src/main/java/com/arangodb/async/ArangoSearchAsync.java b/src/main/java/com/arangodb/async/ArangoSearchAsync.java index 06899676d..d738012c1 100644 --- a/src/main/java/com/arangodb/async/ArangoSearchAsync.java +++ b/src/main/java/com/arangodb/async/ArangoSearchAsync.java @@ -31,7 +31,7 @@ * Interface for operations on ArangoDB view level for ArangoSearch views. * * @author Mark Vollmary - * @see View API Documentation + * @see View API Documentation * @since ArangoDB 3.4.0 */ public interface ArangoSearchAsync extends ArangoViewAsync { @@ -40,7 +40,7 @@ public interface ArangoSearchAsync extends ArangoViewAsync { * Creates a view, then returns view information from the server. * * @return information about the view @ - * @see API + * @see API * Documentation */ CompletableFuture create(); @@ -50,7 +50,7 @@ public interface ArangoSearchAsync extends ArangoViewAsync { * * @param options Additional options, can be null * @return information about the view @ - * @see API + * @see API * Documentation */ CompletableFuture create(ArangoSearchCreateOptions options); @@ -59,7 +59,7 @@ public interface ArangoSearchAsync extends ArangoViewAsync { * Reads the properties of the specified view. * * @return properties of the view @ - * @see API + * @see API * Documentation */ CompletableFuture getProperties(); @@ -70,7 +70,7 @@ public interface ArangoSearchAsync extends ArangoViewAsync { * @param options properties to change * @return properties of the view @ * @see API + * "https://www.arangodb.com/docs/stable/http/views-arangosearch.html#partially-changes-properties-of-an-arangosearch-view">API * Documentation */ CompletableFuture updateProperties(ArangoSearchPropertiesOptions options); @@ -81,7 +81,7 @@ public interface ArangoSearchAsync extends ArangoViewAsync { * @param options properties to change * @return properties of the view @ * @see API + * "https://www.arangodb.com/docs/stable/http/views-arangosearch.html#change-properties-of-an-arangosearch-view">API * Documentation */ CompletableFuture replaceProperties(ArangoSearchPropertiesOptions options); diff --git a/src/main/java/com/arangodb/async/ArangoVertexCollectionAsync.java b/src/main/java/com/arangodb/async/ArangoVertexCollectionAsync.java index 2f1b1af66..b610a9796 100644 --- a/src/main/java/com/arangodb/async/ArangoVertexCollectionAsync.java +++ b/src/main/java/com/arangodb/async/ArangoVertexCollectionAsync.java @@ -31,7 +31,7 @@ * Interface for operations on ArangoDB vertex collection level. * * @author Mark Vollmary - * @see API Documentation + * @see API Documentation */ @SuppressWarnings("unused") public interface ArangoVertexCollectionAsync extends ArangoSerializationAccessor { @@ -55,7 +55,7 @@ public interface ArangoVertexCollectionAsync extends ArangoSerializationAccessor * graph * * @return void - * @see API + * @see API * Documentation */ CompletableFuture drop(); @@ -65,7 +65,7 @@ public interface ArangoVertexCollectionAsync extends ArangoSerializationAccessor * * @param value A representation of a single vertex (POJO, VPackSlice or String for Json) * @return information about the vertex - * @see API Documentation + * @see API Documentation */ CompletableFuture insertVertex(final T value); @@ -75,7 +75,7 @@ public interface ArangoVertexCollectionAsync extends ArangoSerializationAccessor * @param value A representation of a single vertex (POJO, VPackSlice or String for Json) * @param options Additional options, can be null * @return information about the vertex - * @see API Documentation + * @see API Documentation */ CompletableFuture insertVertex(final T value, final VertexCreateOptions options); @@ -85,7 +85,7 @@ public interface ArangoVertexCollectionAsync extends ArangoSerializationAccessor * @param key The key of the vertex * @param type The type of the vertex-document (POJO class, VPackSlice or String for Json) * @return the vertex identified by the key - * @see API Documentation + * @see API Documentation */ CompletableFuture getVertex(final String key, final Class type); @@ -96,7 +96,7 @@ public interface ArangoVertexCollectionAsync extends ArangoSerializationAccessor * @param type The type of the vertex-document (POJO class, VPackSlice or String for Json) * @param options Additional options, can be null * @return the vertex identified by the key - * @see API Documentation + * @see API Documentation */ CompletableFuture getVertex(final String key, final Class type, final GraphDocumentReadOptions options); @@ -106,7 +106,7 @@ public interface ArangoVertexCollectionAsync extends ArangoSerializationAccessor * * @param key The key of the vertex * @return information about the vertex - * @see API + * @see API * Documentation */ CompletableFuture replaceVertex(final String key, final T value); @@ -118,7 +118,7 @@ public interface ArangoVertexCollectionAsync extends ArangoSerializationAccessor * @param key The key of the vertex * @param options Additional options, can be null * @return information about the vertex - * @see API + * @see API * Documentation */ CompletableFuture replaceVertex( @@ -133,7 +133,7 @@ CompletableFuture replaceVertex( * * @param key The key of the vertex * @return information about the vertex - * @see API Documentation + * @see API Documentation */ CompletableFuture updateVertex(final String key, final T value); @@ -145,7 +145,7 @@ CompletableFuture replaceVertex( * @param key The key of the vertex * @param options Additional options, can be null * @return information about the vertex - * @see API Documentation + * @see API Documentation */ CompletableFuture updateVertex( final String key, @@ -156,7 +156,7 @@ CompletableFuture updateVertex( * Removes a vertex * * @param key The key of the vertex - * @see API Documentation + * @see API Documentation */ CompletableFuture deleteVertex(final String key); @@ -165,7 +165,7 @@ CompletableFuture updateVertex( * * @param key The key of the vertex * @param options Additional options, can be null - * @see API Documentation + * @see API Documentation */ CompletableFuture deleteVertex(final String key, final VertexDeleteOptions options); diff --git a/src/main/java/com/arangodb/async/ArangoViewAsync.java b/src/main/java/com/arangodb/async/ArangoViewAsync.java index 1afea0d87..fed3da081 100644 --- a/src/main/java/com/arangodb/async/ArangoViewAsync.java +++ b/src/main/java/com/arangodb/async/ArangoViewAsync.java @@ -29,7 +29,7 @@ * Interface for operations on ArangoDB view level. * * @author Mark Vollmary - * @see View API Documentation + * @see View API Documentation * @since ArangoDB 3.4.0 */ @SuppressWarnings("unused") @@ -59,7 +59,7 @@ public interface ArangoViewAsync extends ArangoSerializationAccessor { /** * Deletes the view from the database. * - * @see API Documentation + * @see API Documentation */ CompletableFuture drop(); @@ -68,7 +68,7 @@ public interface ArangoViewAsync extends ArangoSerializationAccessor { * * @param newName The new name * @return information about the view - * @see API Documentation + * @see API Documentation */ CompletableFuture rename(String newName); @@ -76,7 +76,7 @@ public interface ArangoViewAsync extends ArangoSerializationAccessor { * Returns information about the view. * * @return information about the view - * @see API + * @see API * Documentation */ CompletableFuture getInfo(); diff --git a/src/main/java/com/arangodb/entity/AqlExecutionExplainEntity.java b/src/main/java/com/arangodb/entity/AqlExecutionExplainEntity.java index 1a92ecc3d..dfea4b6a9 100644 --- a/src/main/java/com/arangodb/entity/AqlExecutionExplainEntity.java +++ b/src/main/java/com/arangodb/entity/AqlExecutionExplainEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class AqlExecutionExplainEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/AqlFunctionEntity.java b/src/main/java/com/arangodb/entity/AqlFunctionEntity.java index c67128d26..b4dfbdc3b 100644 --- a/src/main/java/com/arangodb/entity/AqlFunctionEntity.java +++ b/src/main/java/com/arangodb/entity/AqlFunctionEntity.java @@ -24,7 +24,7 @@ * @author Mark Vollmary * * @see API + * "https://www.arangodb.com/docs/stable/http/aql-user-functions.html#return-registered-aql-user-functions">API * Documentation */ public class AqlFunctionEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/AqlParseEntity.java b/src/main/java/com/arangodb/entity/AqlParseEntity.java index 1ffd904ac..00b9020bd 100644 --- a/src/main/java/com/arangodb/entity/AqlParseEntity.java +++ b/src/main/java/com/arangodb/entity/AqlParseEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class AqlParseEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/ArangoDBEngine.java b/src/main/java/com/arangodb/entity/ArangoDBEngine.java index 72d2c9300..30157ea49 100644 --- a/src/main/java/com/arangodb/entity/ArangoDBEngine.java +++ b/src/main/java/com/arangodb/entity/ArangoDBEngine.java @@ -22,7 +22,7 @@ /** * @author Michele Rastelli - * @see API + * @see API * Documentation */ public class ArangoDBEngine implements Entity { diff --git a/src/main/java/com/arangodb/entity/ArangoDBVersion.java b/src/main/java/com/arangodb/entity/ArangoDBVersion.java index 6f5db7a35..6fa6f4c6a 100644 --- a/src/main/java/com/arangodb/entity/ArangoDBVersion.java +++ b/src/main/java/com/arangodb/entity/ArangoDBVersion.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class ArangoDBVersion implements Entity { diff --git a/src/main/java/com/arangodb/entity/CollectionEntity.java b/src/main/java/com/arangodb/entity/CollectionEntity.java index d14c35b09..1239027a4 100644 --- a/src/main/java/com/arangodb/entity/CollectionEntity.java +++ b/src/main/java/com/arangodb/entity/CollectionEntity.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class CollectionEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/CollectionPropertiesEntity.java b/src/main/java/com/arangodb/entity/CollectionPropertiesEntity.java index 8092edec6..16e9ad879 100644 --- a/src/main/java/com/arangodb/entity/CollectionPropertiesEntity.java +++ b/src/main/java/com/arangodb/entity/CollectionPropertiesEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class CollectionPropertiesEntity extends CollectionEntity { diff --git a/src/main/java/com/arangodb/entity/CollectionRevisionEntity.java b/src/main/java/com/arangodb/entity/CollectionRevisionEntity.java index ee34f1673..73d912c59 100644 --- a/src/main/java/com/arangodb/entity/CollectionRevisionEntity.java +++ b/src/main/java/com/arangodb/entity/CollectionRevisionEntity.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class CollectionRevisionEntity extends CollectionEntity { diff --git a/src/main/java/com/arangodb/entity/CursorEntity.java b/src/main/java/com/arangodb/entity/CursorEntity.java index 9e0e6a185..cae5f3e84 100644 --- a/src/main/java/com/arangodb/entity/CursorEntity.java +++ b/src/main/java/com/arangodb/entity/CursorEntity.java @@ -30,7 +30,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class CursorEntity implements Entity, MetaAware { diff --git a/src/main/java/com/arangodb/entity/DatabaseEntity.java b/src/main/java/com/arangodb/entity/DatabaseEntity.java index 0b108abc3..cfe8b3614 100644 --- a/src/main/java/com/arangodb/entity/DatabaseEntity.java +++ b/src/main/java/com/arangodb/entity/DatabaseEntity.java @@ -24,7 +24,7 @@ * @author Mark Vollmary * * @see API + * "https://www.arangodb.com/docs/stable/http/database-database-management.html#information-of-the-database">API * Documentation */ public class DatabaseEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/DocumentCreateEntity.java b/src/main/java/com/arangodb/entity/DocumentCreateEntity.java index fa1d748c6..a9b4e6a10 100644 --- a/src/main/java/com/arangodb/entity/DocumentCreateEntity.java +++ b/src/main/java/com/arangodb/entity/DocumentCreateEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class DocumentCreateEntity extends DocumentEntity { diff --git a/src/main/java/com/arangodb/entity/DocumentDeleteEntity.java b/src/main/java/com/arangodb/entity/DocumentDeleteEntity.java index d23f65f0d..a010eed63 100644 --- a/src/main/java/com/arangodb/entity/DocumentDeleteEntity.java +++ b/src/main/java/com/arangodb/entity/DocumentDeleteEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class DocumentDeleteEntity extends DocumentEntity { diff --git a/src/main/java/com/arangodb/entity/DocumentUpdateEntity.java b/src/main/java/com/arangodb/entity/DocumentUpdateEntity.java index a2dd68d7b..2a76a03d3 100644 --- a/src/main/java/com/arangodb/entity/DocumentUpdateEntity.java +++ b/src/main/java/com/arangodb/entity/DocumentUpdateEntity.java @@ -27,7 +27,7 @@ * @author Mark Vollmary * @param * - * @see API + * @see API * Documentation * */ diff --git a/src/main/java/com/arangodb/entity/EdgeDefinition.java b/src/main/java/com/arangodb/entity/EdgeDefinition.java index cc47f89b6..eb4c72b52 100644 --- a/src/main/java/com/arangodb/entity/EdgeDefinition.java +++ b/src/main/java/com/arangodb/entity/EdgeDefinition.java @@ -26,7 +26,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class EdgeDefinition { diff --git a/src/main/java/com/arangodb/entity/EdgeUpdateEntity.java b/src/main/java/com/arangodb/entity/EdgeUpdateEntity.java index 15f65697f..585922599 100644 --- a/src/main/java/com/arangodb/entity/EdgeUpdateEntity.java +++ b/src/main/java/com/arangodb/entity/EdgeUpdateEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class EdgeUpdateEntity extends DocumentEntity { diff --git a/src/main/java/com/arangodb/entity/GraphEntity.java b/src/main/java/com/arangodb/entity/GraphEntity.java index 50af41d86..9c8689ffa 100644 --- a/src/main/java/com/arangodb/entity/GraphEntity.java +++ b/src/main/java/com/arangodb/entity/GraphEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class GraphEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/LogEntity.java b/src/main/java/com/arangodb/entity/LogEntity.java index f33ace4ee..a7db6e717 100644 --- a/src/main/java/com/arangodb/entity/LogEntity.java +++ b/src/main/java/com/arangodb/entity/LogEntity.java @@ -26,7 +26,7 @@ * @author Mark Vollmary * * @see API + * "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API * Documentation */ public class LogEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/PathEntity.java b/src/main/java/com/arangodb/entity/PathEntity.java index 705e11ee9..619bdf605 100644 --- a/src/main/java/com/arangodb/entity/PathEntity.java +++ b/src/main/java/com/arangodb/entity/PathEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class PathEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/QueryCachePropertiesEntity.java b/src/main/java/com/arangodb/entity/QueryCachePropertiesEntity.java index 38df32031..5b0d540b1 100644 --- a/src/main/java/com/arangodb/entity/QueryCachePropertiesEntity.java +++ b/src/main/java/com/arangodb/entity/QueryCachePropertiesEntity.java @@ -24,7 +24,7 @@ * @author Mark Vollmary * * @see API + * "https://www.arangodb.com/docs/stable/http/aql-query-cache.html">API * Documentation */ public class QueryCachePropertiesEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/ShardingStrategy.java b/src/main/java/com/arangodb/entity/ShardingStrategy.java index efc28a6ac..dc0f4d441 100644 --- a/src/main/java/com/arangodb/entity/ShardingStrategy.java +++ b/src/main/java/com/arangodb/entity/ShardingStrategy.java @@ -22,7 +22,7 @@ /** * @author Axel Becker - * https://www.arangodb.com/docs/3.4/http/collection-creating.html + * https://www.arangodb.com/docs/stable/http/collection-creating.html */ public enum ShardingStrategy { diff --git a/src/main/java/com/arangodb/entity/StreamTransactionEntity.java b/src/main/java/com/arangodb/entity/StreamTransactionEntity.java index 0a7a808dc..5ebf0adf3 100644 --- a/src/main/java/com/arangodb/entity/StreamTransactionEntity.java +++ b/src/main/java/com/arangodb/entity/StreamTransactionEntity.java @@ -23,7 +23,7 @@ /** * @author Michele Rastelli * @see API Documentation + * "https://www.arangodb.com/docs/stable/http/transaction-stream-transaction.html">API Documentation * @since ArangoDB 3.5.0 */ public class StreamTransactionEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/TransactionEntity.java b/src/main/java/com/arangodb/entity/TransactionEntity.java index d2b85189b..333a1e538 100644 --- a/src/main/java/com/arangodb/entity/TransactionEntity.java +++ b/src/main/java/com/arangodb/entity/TransactionEntity.java @@ -23,7 +23,7 @@ /** * @author Michele Rastelli * @see + * "https://www.arangodb.com/docs/stable/http/transaction-stream-transaction.html#list-currently-ongoing-transactions * @since ArangoDB 3.5.0 */ public class TransactionEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/TraversalEntity.java b/src/main/java/com/arangodb/entity/TraversalEntity.java index 95e656103..77e231046 100644 --- a/src/main/java/com/arangodb/entity/TraversalEntity.java +++ b/src/main/java/com/arangodb/entity/TraversalEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class TraversalEntity implements Entity { diff --git a/src/main/java/com/arangodb/entity/UserEntity.java b/src/main/java/com/arangodb/entity/UserEntity.java index b2f572094..87a302eb7 100644 --- a/src/main/java/com/arangodb/entity/UserEntity.java +++ b/src/main/java/com/arangodb/entity/UserEntity.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class UserEntity implements Entity { diff --git a/src/main/java/com/arangodb/internal/InternalArangoDatabase.java b/src/main/java/com/arangodb/internal/InternalArangoDatabase.java index 6b167267b..8de26500f 100644 --- a/src/main/java/com/arangodb/internal/InternalArangoDatabase.java +++ b/src/main/java/com/arangodb/internal/InternalArangoDatabase.java @@ -290,7 +290,7 @@ protected Request deleteAqlFunctionRequest(final String name, final AqlFunctionD protected ResponseDeserializer deleteAqlFunctionResponseDeserializer() { return response -> { // compatibility with ArangoDB < 3.4 - // https://docs.arangodb.com/devel/Manual/ReleaseNotes/UpgradingChanges34.html + // https://www.arangodb.com/docs/stable/release-notes-upgrading-changes34.html Integer count = null; final VPackSlice body = response.getBody(); if (body.isObject()) { @@ -314,7 +314,7 @@ protected ResponseDeserializer> getAqlFunctionsRes return response -> { final VPackSlice body = response.getBody(); // compatibility with ArangoDB < 3.4 - // https://docs.arangodb.com/devel/Manual/ReleaseNotes/UpgradingChanges34.html + // https://www.arangodb.com/docs/stable/release-notes-upgrading-changes34.html final VPackSlice result = body.isArray() ? body : body.get(ArangoResponseField.RESULT); return util().deserialize(result, new Type>() { }.getType()); diff --git a/src/main/java/com/arangodb/model/AqlFunctionCreateOptions.java b/src/main/java/com/arangodb/model/AqlFunctionCreateOptions.java index 12088c9ea..1802cc8b5 100644 --- a/src/main/java/com/arangodb/model/AqlFunctionCreateOptions.java +++ b/src/main/java/com/arangodb/model/AqlFunctionCreateOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class AqlFunctionCreateOptions { diff --git a/src/main/java/com/arangodb/model/AqlFunctionDeleteOptions.java b/src/main/java/com/arangodb/model/AqlFunctionDeleteOptions.java index 8d428b96a..4b763da35 100644 --- a/src/main/java/com/arangodb/model/AqlFunctionDeleteOptions.java +++ b/src/main/java/com/arangodb/model/AqlFunctionDeleteOptions.java @@ -24,7 +24,7 @@ * @author Mark Vollmary * * @see API + * "https://www.arangodb.com/docs/stable/http/aql-user-functions.html#remove-existing-aql-user-function">API * Documentation */ public class AqlFunctionDeleteOptions { diff --git a/src/main/java/com/arangodb/model/AqlFunctionGetOptions.java b/src/main/java/com/arangodb/model/AqlFunctionGetOptions.java index a7c91edb3..67e82b7a8 100644 --- a/src/main/java/com/arangodb/model/AqlFunctionGetOptions.java +++ b/src/main/java/com/arangodb/model/AqlFunctionGetOptions.java @@ -24,7 +24,7 @@ * @author Mark Vollmary * * @see API + * "https://www.arangodb.com/docs/stable/http/aql-user-functions.html#return-registered-aql-user-functions">API * Documentation */ public class AqlFunctionGetOptions { diff --git a/src/main/java/com/arangodb/model/AqlQueryExplainOptions.java b/src/main/java/com/arangodb/model/AqlQueryExplainOptions.java index dab33e745..0509533e3 100644 --- a/src/main/java/com/arangodb/model/AqlQueryExplainOptions.java +++ b/src/main/java/com/arangodb/model/AqlQueryExplainOptions.java @@ -28,7 +28,7 @@ * @author Mark Vollmary * @author Michele Rastelli * - * @see API Documentation + * @see API Documentation */ public class AqlQueryExplainOptions { diff --git a/src/main/java/com/arangodb/model/AqlQueryOptions.java b/src/main/java/com/arangodb/model/AqlQueryOptions.java index b897c81ef..ce693f4bf 100644 --- a/src/main/java/com/arangodb/model/AqlQueryOptions.java +++ b/src/main/java/com/arangodb/model/AqlQueryOptions.java @@ -31,7 +31,7 @@ /** * @author Mark Vollmary * @author Michele Rastelli - * @see API + * @see API * Documentation */ public class AqlQueryOptions implements Serializable { @@ -420,7 +420,7 @@ private static class Optimizer { /** * @param allowDirtyRead Set to {@code true} allows reading from followers in an active-failover setup. * @return options - * @see API + * @see API * Documentation * @since ArangoDB 3.4.0 */ diff --git a/src/main/java/com/arangodb/model/AqlQueryParseOptions.java b/src/main/java/com/arangodb/model/AqlQueryParseOptions.java index 0b288286f..b883b5659 100644 --- a/src/main/java/com/arangodb/model/AqlQueryParseOptions.java +++ b/src/main/java/com/arangodb/model/AqlQueryParseOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class AqlQueryParseOptions { diff --git a/src/main/java/com/arangodb/model/CollectionCreateOptions.java b/src/main/java/com/arangodb/model/CollectionCreateOptions.java index e1c705972..8ea85e7a3 100644 --- a/src/main/java/com/arangodb/model/CollectionCreateOptions.java +++ b/src/main/java/com/arangodb/model/CollectionCreateOptions.java @@ -29,7 +29,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class CollectionCreateOptions { diff --git a/src/main/java/com/arangodb/model/CollectionPropertiesOptions.java b/src/main/java/com/arangodb/model/CollectionPropertiesOptions.java index 410409fc9..0419d3fbd 100644 --- a/src/main/java/com/arangodb/model/CollectionPropertiesOptions.java +++ b/src/main/java/com/arangodb/model/CollectionPropertiesOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class CollectionPropertiesOptions { diff --git a/src/main/java/com/arangodb/model/CollectionsReadOptions.java b/src/main/java/com/arangodb/model/CollectionsReadOptions.java index 3b32a8d99..ba2293f93 100644 --- a/src/main/java/com/arangodb/model/CollectionsReadOptions.java +++ b/src/main/java/com/arangodb/model/CollectionsReadOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class CollectionsReadOptions { diff --git a/src/main/java/com/arangodb/model/DocumentCreateOptions.java b/src/main/java/com/arangodb/model/DocumentCreateOptions.java index 7b30bc069..1e94c3356 100644 --- a/src/main/java/com/arangodb/model/DocumentCreateOptions.java +++ b/src/main/java/com/arangodb/model/DocumentCreateOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * @author Michele Rastelli - * @see API + * @see API * Documentation */ public class DocumentCreateOptions { diff --git a/src/main/java/com/arangodb/model/DocumentDeleteOptions.java b/src/main/java/com/arangodb/model/DocumentDeleteOptions.java index 642654e39..fb11f13c2 100644 --- a/src/main/java/com/arangodb/model/DocumentDeleteOptions.java +++ b/src/main/java/com/arangodb/model/DocumentDeleteOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * @author Michele Rastelli - * @see API + * @see API * Documentation */ public class DocumentDeleteOptions { diff --git a/src/main/java/com/arangodb/model/DocumentExistsOptions.java b/src/main/java/com/arangodb/model/DocumentExistsOptions.java index b139f09cd..29b07dbc4 100644 --- a/src/main/java/com/arangodb/model/DocumentExistsOptions.java +++ b/src/main/java/com/arangodb/model/DocumentExistsOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * @author Michele Rastelli - * @see API + * @see API * Documentation */ public class DocumentExistsOptions { diff --git a/src/main/java/com/arangodb/model/DocumentReadOptions.java b/src/main/java/com/arangodb/model/DocumentReadOptions.java index d8a0d658c..2fc0a5aa8 100644 --- a/src/main/java/com/arangodb/model/DocumentReadOptions.java +++ b/src/main/java/com/arangodb/model/DocumentReadOptions.java @@ -26,7 +26,7 @@ * @author Mark Vollmary * @author Michele Rastelli * - * @see API + * @see API * Documentation */ public class DocumentReadOptions { @@ -86,7 +86,7 @@ public DocumentReadOptions catchException(final boolean catchException) { } /** - * @see API + * @see API * Documentation * @param allowDirtyRead * Set to {@code true} allows reading from followers in an active-failover setup. diff --git a/src/main/java/com/arangodb/model/DocumentReplaceOptions.java b/src/main/java/com/arangodb/model/DocumentReplaceOptions.java index aa737b3db..c816708f0 100644 --- a/src/main/java/com/arangodb/model/DocumentReplaceOptions.java +++ b/src/main/java/com/arangodb/model/DocumentReplaceOptions.java @@ -24,7 +24,7 @@ * @author Mark Vollmary * @author Michele Rastelli * - * @see API + * @see API * Documentation */ public class DocumentReplaceOptions { diff --git a/src/main/java/com/arangodb/model/DocumentUpdateOptions.java b/src/main/java/com/arangodb/model/DocumentUpdateOptions.java index b495e5e3f..127ecc0a8 100644 --- a/src/main/java/com/arangodb/model/DocumentUpdateOptions.java +++ b/src/main/java/com/arangodb/model/DocumentUpdateOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * @author Michele Rastelli - * @see API + * @see API * Documentation */ public class DocumentUpdateOptions { diff --git a/src/main/java/com/arangodb/model/EdgeCreateOptions.java b/src/main/java/com/arangodb/model/EdgeCreateOptions.java index 5efd3811d..3f335cfb1 100644 --- a/src/main/java/com/arangodb/model/EdgeCreateOptions.java +++ b/src/main/java/com/arangodb/model/EdgeCreateOptions.java @@ -22,7 +22,7 @@ /** * @author Mark Vollmary - * @see API Documentation + * @see API Documentation */ public class EdgeCreateOptions { diff --git a/src/main/java/com/arangodb/model/EdgeDeleteOptions.java b/src/main/java/com/arangodb/model/EdgeDeleteOptions.java index ff666c611..b7c600760 100644 --- a/src/main/java/com/arangodb/model/EdgeDeleteOptions.java +++ b/src/main/java/com/arangodb/model/EdgeDeleteOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class EdgeDeleteOptions { diff --git a/src/main/java/com/arangodb/model/EdgeReplaceOptions.java b/src/main/java/com/arangodb/model/EdgeReplaceOptions.java index 9bf86cb82..47f553159 100644 --- a/src/main/java/com/arangodb/model/EdgeReplaceOptions.java +++ b/src/main/java/com/arangodb/model/EdgeReplaceOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class EdgeReplaceOptions { diff --git a/src/main/java/com/arangodb/model/EdgeUpdateOptions.java b/src/main/java/com/arangodb/model/EdgeUpdateOptions.java index bd29a14d4..f3f97c5c5 100644 --- a/src/main/java/com/arangodb/model/EdgeUpdateOptions.java +++ b/src/main/java/com/arangodb/model/EdgeUpdateOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class EdgeUpdateOptions { diff --git a/src/main/java/com/arangodb/model/FulltextIndexOptions.java b/src/main/java/com/arangodb/model/FulltextIndexOptions.java index d13fab005..4cb51e73d 100644 --- a/src/main/java/com/arangodb/model/FulltextIndexOptions.java +++ b/src/main/java/com/arangodb/model/FulltextIndexOptions.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class FulltextIndexOptions extends IndexOptions { diff --git a/src/main/java/com/arangodb/model/GeoIndexOptions.java b/src/main/java/com/arangodb/model/GeoIndexOptions.java index 67ce4f775..912c2283c 100644 --- a/src/main/java/com/arangodb/model/GeoIndexOptions.java +++ b/src/main/java/com/arangodb/model/GeoIndexOptions.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class GeoIndexOptions extends IndexOptions { diff --git a/src/main/java/com/arangodb/model/GraphCreateOptions.java b/src/main/java/com/arangodb/model/GraphCreateOptions.java index b19307d58..ae74b93e8 100644 --- a/src/main/java/com/arangodb/model/GraphCreateOptions.java +++ b/src/main/java/com/arangodb/model/GraphCreateOptions.java @@ -28,7 +28,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class GraphCreateOptions { diff --git a/src/main/java/com/arangodb/model/GraphDocumentReadOptions.java b/src/main/java/com/arangodb/model/GraphDocumentReadOptions.java index 47ddea107..a43a49e6f 100644 --- a/src/main/java/com/arangodb/model/GraphDocumentReadOptions.java +++ b/src/main/java/com/arangodb/model/GraphDocumentReadOptions.java @@ -81,7 +81,7 @@ public GraphDocumentReadOptions catchException(final boolean catchException) { /** * @param allowDirtyRead Set to {@code true} allows reading from followers in an active-failover setup. * @return options - * @see API + * @see API * Documentation * @since ArangoDB 3.4.0 */ diff --git a/src/main/java/com/arangodb/model/HashIndexOptions.java b/src/main/java/com/arangodb/model/HashIndexOptions.java index 99ddc27bc..e5e80a8aa 100644 --- a/src/main/java/com/arangodb/model/HashIndexOptions.java +++ b/src/main/java/com/arangodb/model/HashIndexOptions.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class HashIndexOptions extends IndexOptions { diff --git a/src/main/java/com/arangodb/model/LogOptions.java b/src/main/java/com/arangodb/model/LogOptions.java index 9ba095224..47eddb890 100644 --- a/src/main/java/com/arangodb/model/LogOptions.java +++ b/src/main/java/com/arangodb/model/LogOptions.java @@ -26,7 +26,7 @@ * @author Mark Vollmary * * @see API + * "https://www.arangodb.com/docs/stable/http/administration-and-monitoring.html#read-global-logs-from-the-server">API * Documentation */ public class LogOptions { diff --git a/src/main/java/com/arangodb/model/PersistentIndexOptions.java b/src/main/java/com/arangodb/model/PersistentIndexOptions.java index f1d5ecaab..e72c47294 100644 --- a/src/main/java/com/arangodb/model/PersistentIndexOptions.java +++ b/src/main/java/com/arangodb/model/PersistentIndexOptions.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API + * @see API * Documentation */ public class PersistentIndexOptions extends IndexOptions { diff --git a/src/main/java/com/arangodb/model/SkiplistIndexOptions.java b/src/main/java/com/arangodb/model/SkiplistIndexOptions.java index 5ba4cbd75..7e5a9e92f 100644 --- a/src/main/java/com/arangodb/model/SkiplistIndexOptions.java +++ b/src/main/java/com/arangodb/model/SkiplistIndexOptions.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class SkiplistIndexOptions extends IndexOptions { diff --git a/src/main/java/com/arangodb/model/StreamTransactionOptions.java b/src/main/java/com/arangodb/model/StreamTransactionOptions.java index 4e3307275..fc80951c9 100644 --- a/src/main/java/com/arangodb/model/StreamTransactionOptions.java +++ b/src/main/java/com/arangodb/model/StreamTransactionOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * @author Michele Rastelli - * @see API Documentation + * @see API Documentation * @since ArangoDB 3.5.0 */ public class StreamTransactionOptions { diff --git a/src/main/java/com/arangodb/model/TransactionOptions.java b/src/main/java/com/arangodb/model/TransactionOptions.java index 99d4e0c60..c17cecb77 100644 --- a/src/main/java/com/arangodb/model/TransactionOptions.java +++ b/src/main/java/com/arangodb/model/TransactionOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * @author Michele Rastelli - * @see API + * @see API * Documentation */ public class TransactionOptions { diff --git a/src/main/java/com/arangodb/model/TraversalOptions.java b/src/main/java/com/arangodb/model/TraversalOptions.java index a6287c97f..5d53bd994 100644 --- a/src/main/java/com/arangodb/model/TraversalOptions.java +++ b/src/main/java/com/arangodb/model/TraversalOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class TraversalOptions { diff --git a/src/main/java/com/arangodb/model/UserCreateOptions.java b/src/main/java/com/arangodb/model/UserCreateOptions.java index 2dfecc0c8..19d99dc26 100644 --- a/src/main/java/com/arangodb/model/UserCreateOptions.java +++ b/src/main/java/com/arangodb/model/UserCreateOptions.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class UserCreateOptions { diff --git a/src/main/java/com/arangodb/model/UserUpdateOptions.java b/src/main/java/com/arangodb/model/UserUpdateOptions.java index 33d3b18f3..b83057e80 100644 --- a/src/main/java/com/arangodb/model/UserUpdateOptions.java +++ b/src/main/java/com/arangodb/model/UserUpdateOptions.java @@ -25,7 +25,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class UserUpdateOptions { diff --git a/src/main/java/com/arangodb/model/VertexCreateOptions.java b/src/main/java/com/arangodb/model/VertexCreateOptions.java index 19846a5b8..e26140455 100644 --- a/src/main/java/com/arangodb/model/VertexCreateOptions.java +++ b/src/main/java/com/arangodb/model/VertexCreateOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class VertexCreateOptions { diff --git a/src/main/java/com/arangodb/model/VertexDeleteOptions.java b/src/main/java/com/arangodb/model/VertexDeleteOptions.java index 7f3cfcdf0..1c301bea1 100644 --- a/src/main/java/com/arangodb/model/VertexDeleteOptions.java +++ b/src/main/java/com/arangodb/model/VertexDeleteOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class VertexDeleteOptions { diff --git a/src/main/java/com/arangodb/model/VertexReplaceOptions.java b/src/main/java/com/arangodb/model/VertexReplaceOptions.java index e98bd2222..fe53c07e9 100644 --- a/src/main/java/com/arangodb/model/VertexReplaceOptions.java +++ b/src/main/java/com/arangodb/model/VertexReplaceOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class VertexReplaceOptions { diff --git a/src/main/java/com/arangodb/model/VertexUpdateOptions.java b/src/main/java/com/arangodb/model/VertexUpdateOptions.java index 2f5d2fc96..9117a038a 100644 --- a/src/main/java/com/arangodb/model/VertexUpdateOptions.java +++ b/src/main/java/com/arangodb/model/VertexUpdateOptions.java @@ -23,7 +23,7 @@ /** * @author Mark Vollmary * - * @see API Documentation + * @see API Documentation */ public class VertexUpdateOptions { diff --git a/src/test/java/com/arangodb/async/example/graph/AQLActorsAndMoviesExample.java b/src/test/java/com/arangodb/async/example/graph/AQLActorsAndMoviesExample.java index 8f369ff0c..9c89ee494 100644 --- a/src/test/java/com/arangodb/async/example/graph/AQLActorsAndMoviesExample.java +++ b/src/test/java/com/arangodb/async/example/graph/AQLActorsAndMoviesExample.java @@ -41,7 +41,7 @@ /** * @author Mark Vollmary - * @see AQL Example Queries on an + * @see AQL Example Queries on an * Actors and Movies Database */ @SuppressWarnings("JavaDoc") @@ -308,7 +308,7 @@ private static void createData() throws InterruptedException, ExecutionException * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-actors-who-acted-in-movie1-or-movie2">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -324,7 +324,7 @@ public void allActorsActsInMovie1or2() throws InterruptedException, ExecutionExc * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-actors-who-acted-in-movie1-or-movie2">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -340,7 +340,7 @@ public void allActorsActsInMovie1or2UnionDistinct() throws InterruptedException, * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-actors-who-acted-in-both-movie1-and-movie2-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -355,7 +355,7 @@ public void allActorsActsInMovie1and2() throws InterruptedException, ExecutionEx * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-common-movies-between-actor1-and-actor2-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -371,7 +371,7 @@ public void allMoviesBetweenActor1andActor2() throws InterruptedException, Execu * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-actors-who-acted-in-3-or-more-movies-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -389,7 +389,7 @@ public void allActorsWhoActedIn3orMoreMovies() throws InterruptedException, Exec * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-movies-where-exactly-6-actors-acted-in-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -405,7 +405,7 @@ public void allMoviesWhereExactly6ActorsActedIn() throws InterruptedException, E * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#the-number-of-actors-by-movie-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -428,7 +428,7 @@ public void theNumberOfActorsByMovie() throws InterruptedException, ExecutionExc * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#the-number-of-movies-by-actor-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -462,7 +462,7 @@ public void theNumberOfMoviesByActor() throws InterruptedException, ExecutionExc * @throws ExecutionException * @throws InterruptedException * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#the-number-of-movies-acted-in-between-2005-and-2010-by-actor-">AQL * Example Queries on an Actors and Movies Database */ @Test diff --git a/src/test/java/com/arangodb/async/example/graph/GraphTraversalsInAQLExample.java b/src/test/java/com/arangodb/async/example/graph/GraphTraversalsInAQLExample.java index cd9ac367f..f3b903e4c 100644 --- a/src/test/java/com/arangodb/async/example/graph/GraphTraversalsInAQLExample.java +++ b/src/test/java/com/arangodb/async/example/graph/GraphTraversalsInAQLExample.java @@ -34,7 +34,7 @@ * Graph traversals in AQL * * @author a-brandt - * @see Graph traversals in AQL + * @see Graph traversals in AQL */ public class GraphTraversalsInAQLExample extends BaseGraphTest { diff --git a/src/test/java/com/arangodb/async/example/graph/ShortestPathInAQLExample.java b/src/test/java/com/arangodb/async/example/graph/ShortestPathInAQLExample.java index 021ae91bb..41a7674d0 100644 --- a/src/test/java/com/arangodb/async/example/graph/ShortestPathInAQLExample.java +++ b/src/test/java/com/arangodb/async/example/graph/ShortestPathInAQLExample.java @@ -36,7 +36,7 @@ * Shortest Path in AQL * * @author a-brandt - * @see Shortest Path in AQL + * @see Shortest Path in AQL */ public class ShortestPathInAQLExample extends BaseGraphTest { diff --git a/src/test/java/com/arangodb/example/graph/AQLActorsAndMoviesExample.java b/src/test/java/com/arangodb/example/graph/AQLActorsAndMoviesExample.java index 7d140217d..e6ec12a9e 100644 --- a/src/test/java/com/arangodb/example/graph/AQLActorsAndMoviesExample.java +++ b/src/test/java/com/arangodb/example/graph/AQLActorsAndMoviesExample.java @@ -39,7 +39,7 @@ /** * @author Mark Vollmary - * @see AQL Example Queries on an + * @see AQL Example Queries on an * Actors and Movies Database */ public class AQLActorsAndMoviesExample { @@ -66,7 +66,7 @@ public static void tearDown() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-actors-who-acted-in-movie1-or-movie2">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -80,7 +80,7 @@ public void allActorsActsInMovie1or2() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-actors-who-acted-in-movie1-or-movie2">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -94,7 +94,7 @@ public void allActorsActsInMovie1or2UnionDistinct() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-actors-who-acted-in-both-movie1-and-movie2-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -107,7 +107,7 @@ public void allActorsActsInMovie1and2() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-common-movies-between-actor1-and-actor2-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -121,7 +121,7 @@ public void allMoviesBetweenActor1andActor2() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-actors-who-acted-in-3-or-more-movies-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -137,7 +137,7 @@ public void allActorsWhoActedIn3orMoreMovies() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#all-movies-where-exactly-6-actors-acted-in-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -151,7 +151,7 @@ public void allMoviesWhereExactly6ActorsActedIn() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#the-number-of-actors-by-movie-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -172,7 +172,7 @@ public void theNumberOfActorsByMovie() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#the-number-of-movies-by-actor-">AQL * Example Queries on an Actors and Movies Database */ @Test @@ -204,7 +204,7 @@ public void theNumberOfMoviesByActor() { /** * @see AQL + * "https://www.arangodb.com/docs/stable/cookbook/graph-example-actors-and-movies.html#the-number-of-movies-acted-in-between-2005-and-2010-by-actor-">AQL * Example Queries on an Actors and Movies Database */ @Test diff --git a/src/test/java/com/arangodb/example/graph/GraphTraversalsInAQLExample.java b/src/test/java/com/arangodb/example/graph/GraphTraversalsInAQLExample.java index 9bfd3a573..d8f896542 100644 --- a/src/test/java/com/arangodb/example/graph/GraphTraversalsInAQLExample.java +++ b/src/test/java/com/arangodb/example/graph/GraphTraversalsInAQLExample.java @@ -34,7 +34,7 @@ /** * Graph traversals in AQL * - * @see Graph traversals in AQL + * @see Graph traversals in AQL * * @author a-brandt * diff --git a/src/test/java/com/arangodb/example/graph/ShortestPathInAQLExample.java b/src/test/java/com/arangodb/example/graph/ShortestPathInAQLExample.java index 38b84f843..6c60674c3 100644 --- a/src/test/java/com/arangodb/example/graph/ShortestPathInAQLExample.java +++ b/src/test/java/com/arangodb/example/graph/ShortestPathInAQLExample.java @@ -36,7 +36,7 @@ /** * Shortest Path in AQL * - * @see Shortest Path in AQL + * @see Shortest Path in AQL * * @author a-brandt * From c180454ebf4782153787d9e43f07f4196731fdf4 Mon Sep 17 00:00:00 2001 From: Simran Brucherseifer Date: Thu, 24 Oct 2019 14:06:29 +0200 Subject: [PATCH 32/33] Capitalization --- docs/Drivers/Java/Reference/Database/ViewAccess.md | 12 ++++++------ docs/Drivers/Java/Reference/View/Arangosearch.md | 2 +- docs/Drivers/Java/Reference/View/ViewManipulation.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/Drivers/Java/Reference/Database/ViewAccess.md b/docs/Drivers/Java/Reference/Database/ViewAccess.md index 148d752e9..246cb357d 100644 --- a/docs/Drivers/Java/Reference/Database/ViewAccess.md +++ b/docs/Drivers/Java/Reference/Database/ViewAccess.md @@ -1,19 +1,19 @@ # Accessing Views These functions implement the -[HTTP API for accessing View](https://www.arangodb.com/docs/stable/http/views.html). +[HTTP API for accessing Views](https://www.arangodb.com/docs/stable/http/views.html). ## ArangoDatabase.view `ArangoDatabase.view(String name) : ArangoView` -Returns a _ArangoView_ instance for the given view name. +Returns a _ArangoView_ instance for the given View name. **Arguments** - **name**: `String` - Name of the view + Name of the View **Examples** @@ -27,13 +27,13 @@ ArangoView view = db.view("myView"); `ArangoDatabase.arangoSearch(String name) : ArangoSearch` -Returns a _ArangoSearch_ instance for the given ArangoSearch view name. +Returns a _ArangoSearch_ instance for the given ArangoSearch View name. **Arguments** - **name**: `String` - Name of the view + Name of the View **Examples** @@ -47,7 +47,7 @@ ArangoSearch view = db.arangoSearch("myArangoSearchView"); `ArangoDatabase.getViews() : Collection` -Fetches all views from the database and returns an list of collection descriptions. +Fetches all Views from the database and returns an list of collection descriptions. **Examples** diff --git a/docs/Drivers/Java/Reference/View/Arangosearch.md b/docs/Drivers/Java/Reference/View/Arangosearch.md index 4bb572303..fec932b38 100644 --- a/docs/Drivers/Java/Reference/View/Arangosearch.md +++ b/docs/Drivers/Java/Reference/View/Arangosearch.md @@ -150,7 +150,7 @@ ArangoDatabase db = arango.db("myDB"); ArangoSearch view = db.arangoSearch("potatoes"); view.create(new ArangoSearchPropertiesOptions()); -// the ArangoSearch view "potatoes" now exists +// the ArangoSearch View "potatoes" now exists ``` ## ArangoSearch.getProperties diff --git a/docs/Drivers/Java/Reference/View/ViewManipulation.md b/docs/Drivers/Java/Reference/View/ViewManipulation.md index f963e27ba..5bfe19de6 100644 --- a/docs/Drivers/Java/Reference/View/ViewManipulation.md +++ b/docs/Drivers/Java/Reference/View/ViewManipulation.md @@ -25,7 +25,7 @@ Creates a View of the given _type_, then returns View information from the serve ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); db.createView("myView", ViewType.ARANGO_SEARCH); -// the view "potatoes" now exists +// the View "potatoes" now exists ``` ## ArangoView.rename From 698bdcf8e20218ddb8022ad935b1127c5cc98409 Mon Sep 17 00:00:00 2001 From: Simran Date: Thu, 24 Oct 2019 17:15:34 +0200 Subject: [PATCH 33/33] Update Transactions.md --- docs/Drivers/Java/Reference/Database/Transactions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Drivers/Java/Reference/Database/Transactions.md b/docs/Drivers/Java/Reference/Database/Transactions.md index 0242a2654..00006c0be 100644 --- a/docs/Drivers/Java/Reference/Database/Transactions.md +++ b/docs/Drivers/Java/Reference/Database/Transactions.md @@ -2,6 +2,7 @@ This function implements the [HTTP API for JS transactions](https://www.arangodb.com/docs/stable/http/transaction-js-transaction.html). +Also see [ArangoDB Transactions](https://www.arangodb.com/docs/stable/transactions.html). ## ArangoDatabase.transaction