diff --git a/ChangeLog.md b/ChangeLog.md index f74ecc97a..98d3e1de2 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -277,8 +277,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Fixed -- fixed default Json parsing, include null values (Issue #163) -- fixed Json parsing of negative long (Issue #151) +- fixed default JSON parsing, include null values (Issue #163) +- fixed JSON parsing of negative long (Issue #151) ## [4.3.0] - 2017-11-23 @@ -386,7 +386,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a - added `ArangoDBException#getException()` - added protocol switch (`ArangoDB.Builder#useProtocol(Protocol)`) - `Protocol#VST` = VeclocyStream (default) - - `Protocol#HTTP_JSON` = Json over HTTP + - `Protocol#HTTP_JSON` = JSON over HTTP - `Protocol#HTTP_VPACK` = VelocyPack over HTTP ## [4.1.12] - 2017-04-13 @@ -472,13 +472,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Fixed - fixed URL encoding bug (#97) -- fixed update/replaceDocumets with Json (#98) +- fixed update/replaceDocumets with JSON (#98) ## [4.1.7] - 2017-01-26 ### Fixed -- fixed `importDocuments`, `insertDocuments` to work with raw Jsons (issue #91) +- fixed `importDocuments`, `insertDocuments` to work with raw JSONs (issue #91) ## [4.1.6] - 2017-01-18 @@ -523,7 +523,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a ### Added -- added `VelocyPack` UTC_DATE parsing to Json String (ISO 8601) +- added `VelocyPack` UTC_DATE parsing to JSON String (ISO 8601) - added configuration methods for `VPackParser` in `ArangoDB.Builder` - added `VPackJsonSerializer` for `VPackParser` diff --git a/docs/Drivers/Java/GettingStarted/README.md b/docs/Drivers/Java/GettingStarted/README.md index de857c239..0eff8df2f 100644 --- a/docs/Drivers/Java/GettingStarted/README.md +++ b/docs/Drivers/Java/GettingStarted/README.md @@ -2,15 +2,14 @@ ## Supported versions - - - - - - - - -
arangodb-java-driverArangoDBnetwork protocolJava version
5.x.x+3.0.0+VelocyStream, HTTP1.6+
4.2.x+3.0.0+VelocyStream, HTTP1.6+
4.1.x3.1.0+VelocyStream1.6+
3.1.x3.1.0+HTTP1.6+
3.0.x3.0.xHTTP1.6+
2.7.42.7.x, 2.8.xHTTP1.6+
+arangodb-java-driver | ArangoDB | network protocol | Java version +---------------------|--------------|--------------------|------------- +5.x.x+ | 3.0.0+ | VelocyStream, HTTP | 1.6+ +4.2.x+ | 3.0.0+ | VelocyStream, HTTP | 1.6+ +4.1.x | 3.1.0+ | VelocyStream | 1.6+ +3.1.x | 3.1.0+ | HTTP | 1.6+ +3.0.x | 3.0.x | HTTP | 1.6+ +2.7.4 | 2.7.x, 2.8.x | HTTP | 1.6+ **Note**: VelocyStream is only supported in ArangoDB 3.1 and above. @@ -31,7 +30,8 @@ ArangoDB 3.x.x ``` -If you want to test with a snapshot version (e.g. 4.6.0-SNAPSHOT), add the staging repository of oss.sonatype.org to your pom.xml: +If you want to test with a snapshot version (e.g. 4.6.0-SNAPSHOT), +add the staging repository of oss.sonatype.org to your pom.xml: ```XML diff --git a/docs/Drivers/Java/Reference/Collection/BulkImport.md b/docs/Drivers/Java/Reference/Collection/BulkImport.md index 6ca3969f1..43325e7f8 100644 --- a/docs/Drivers/Java/Reference/Collection/BulkImport.md +++ b/docs/Drivers/Java/Reference/Collection/BulkImport.md @@ -5,13 +5,9 @@ This function implements the ## ArangoCollection.importDocuments -``` -ArangoCollection.importDocuments(Collection values, DocumentImportOptions options) : DocumentImportEntity -``` +`ArangoCollection.importDocuments(Collection values, DocumentImportOptions options) : DocumentImportEntity` -``` -ArangoCollection.importDocuments(String values, DocumentImportOptions options) : DocumentImportEntity -``` +`ArangoCollection.importDocuments(String values, DocumentImportOptions options) : DocumentImportEntity` Bulk imports the given values into the collection. @@ -27,15 +23,21 @@ Bulk imports the given values into the collection. - **fromPrefix**: `String` - An optional prefix for the values in \_from attributes. If specified, the value is automatically prepended to each \_from input value. This allows specifying just the keys for \_from. + An optional prefix for the values in \_from attributes. If specified, + the value is automatically prepended to each \_from input value. + This allows specifying just the keys for \_from. - **toPrefix**: `String` - An optional prefix for the values in \_to attributes. If specified, the value is automatically prepended to each \_to input value. This allows specifying just the keys for \_to. + An optional prefix for the values in \_to attributes. If specified, + the value is automatically prepended to each \_to input value. + This allows specifying just the keys for \_to. - **overwrite**: `Boolean` - If this parameter has a value of true, then all data in the collection will be removed prior to the import. Note that any existing index definitions will be preseved. + If this parameter has a value of true, then all data in the collection + will be removed prior to the import. Note that any existing index definitions + will be preserved. - **waitForSync**: `Boolean` @@ -43,23 +45,34 @@ Bulk imports the given values into the collection. - **onDuplicate**: `OnDuplicate` - Controls what action is carried out in case of a unique key constraint violation. Possible values are: + Controls what action is carried out in case of a unique key constraint violation. + Possible values are: - - **error**: this will not import the current document because of the unique key constraint violation. This is the default setting. + - **error**: this will not import the current document because of the + unique key constraint violation. This is the default setting. - - **update**: this will update an existing document in the database with the data specified in the request. Attributes of the existing document that are not present in the request will be preseved. + - **update**: this will update an existing document in the database with + the data specified in the request. Attributes of the existing document + that are not present in the request will be preserved. - - **replace**: this will replace an existing document in the database with the data specified in the request. + - **replace**: this will replace an existing document in the database with + the data specified in the request. - - **ignore**: this will not update an existing document and simply ignore the error caused by the unique key constraint violation. Note that update, replace and ignore will only work when the import document in the request contains the \_key attribute. update and replace may also fail because of secondary unique key constraint violations. + - **ignore**: this will not update an existing document and simply ignore + the error caused by the unique key constraint violation. Note that update, + replace and ignore will only work when the import document in the request + contains the \_key attribute. update and replace may also fail because of + secondary unique key constraint violations. - **complete**: `Boolean` - If set to true, it will make the whole import fail if any error occurs. Otherwise the import will continue even if some documents cannot be imported. + If set to true, it will make the whole import fail if any error occurs. + Otherwise the import will continue even if some documents cannot be imported. - **details**: `Boolean` - If set to true, the result will include an attribute details with details about documents that could not be imported. + If set to true, the result will include an attribute details with details + about documents that could not be imported. **Examples** @@ -71,5 +84,8 @@ ArangoCollection collection = db.collection("some-collection"); BaseDocument doc1 = new BaseDocument(); BaseDocument doc2 = new BaseDocument(); BaseDocument doc3 = new BaseDocument(); -collection.importDocuments(Arrays.asList(doc1, doc2, doc3), new DocumentImportOptions()); +collection.importDocuments( + Arrays.asList(doc1, doc2, doc3), + new DocumentImportOptions() +); ``` diff --git a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md index caeb96b1c..e6f4f1f78 100644 --- a/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md +++ b/docs/Drivers/Java/Reference/Collection/CollectionManipulation.md @@ -5,11 +5,10 @@ These functions implement ## ArangoDatabase.createCollection -``` -ArangoDatabase.createCollection(String name, CollectionCreateOptions options) : CollectionEntity -``` +`ArangoDatabase.createCollection(String name, CollectionCreateOptions options) : CollectionEntity` -Creates a collection with the given _options_ for this collection's name, then returns collection information from the server. +Creates a collection with the given _options_ for this collection's name, +then returns collection information from the server. **Arguments** @@ -21,19 +20,30 @@ Creates a collection with the given _options_ for this collection's name, then r - **journalSize**: `Long` - The maximal size of a journal or datafile in bytes. The value must be at least 1048576 (1 MiB). + The maximal size of a journal or datafile in bytes. + The value must be at least 1048576 (1 MiB). - **replicationFactor**: `Integer` - (The default is 1): in a cluster, this attribute determines how many copies of each shard are kept on different DBServers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. Any two copies reside on different DBServers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated to all "follower" replicas, before the write operation is reported successful. If a server fails, this is detected automatically and one of the servers holding copies take over, usually without an error being reported. + (The default is 1): in a cluster, this attribute determines how many copies + of each shard are kept on different DBServers. The value 1 means that only + one copy (no synchronous replication) is kept. A value of k means that + k-1 replicas are kept. Any two copies reside on different DBServers. + Replication between them is synchronous, that is, every write operation to + the "leader" copy will be replicated to all "follower" replicas, before the + write operation is reported successful. If a server fails, this is detected + automatically and one of the servers holding copies take over, usually + without an error being reported. - **satellite**: `Boolean` - If the true the collection is created as a satellite collection. In this case the _replicationFactor_ is ignored. + If the true the collection is created as a satellite collection. + In this case the _replicationFactor_ is ignored. - **waitForSync**: `Boolean` - If true then the data is synchronized to disk before returning from a document create, update, replace or removal operation. (default: false) + If true then the data is synchronized to disk before returning from a + document create, update, replace or removal operation. (default: false) - **doCompact**: `Boolean` @@ -41,19 +51,38 @@ Creates a collection with the given _options_ for this collection's name, then r - **isVolatile**: `Boolean` - If true then the collection data is kept in-memory only and not made persistent. Unloading the collection will cause the collection data to be discarded. Stopping or re-starting the server will also cause full loss of data in the collection. Setting this option will make the resulting collection be slightly faster than regular collections because ArangoDB does not enforce any synchronization to disk and does not calculate any CRC checksums for datafiles (as there are no datafiles). This option should therefore be used for cache-type collections only, and not for data that cannot be re-created otherwise. (The default is false) + If true then the collection data is kept in-memory only and not made persistent. + Unloading the collection will cause the collection data to be discarded. + Stopping or re-starting the server will also cause full loss of data in + the collection. Setting this option will make the resulting collection be + slightly faster than regular collections because ArangoDB does not enforce + any synchronization to disk and does not calculate any CRC checksums for + datafiles (as there are no datafiles). This option should therefore be used + for cache-type collections only, and not for data that cannot be re-created + otherwise. (The default is false) - **shardKeys**: `String...` - (The default is [ "_key" ]): in a cluster, this attribute determines which document attributes are used to determine the target shard for documents. Documents are sent to shards based on the values of their shard key attributes. The values of all shard key attributes in a document are hashed, and the hash value is used to determine the target shard. Note: Values of shard key attributes cannot be changed once set. This option is meaningless in a single server setup. + (The default is [ "_key" ]): in a cluster, this attribute determines which + document attributes are used to determine the target shard for documents. + Documents are sent to shards based on the values of their shard key attributes. + The values of all shard key attributes in a document are hashed, and the + hash value is used to determine the target shard. Note: Values of shard key + attributes cannot be changed once set. This option is meaningless in a + single server setup. - **numberOfShards**: `Integer` - (The default is 1): in a cluster, this value determines the number of shards to create for the collection. In a single server setup, this option is meaningless. + (The default is 1): in a cluster, this value determines the number of shards + to create for the collection. In a single server setup, this option is meaningless. - **isSystem**: `Boolean` - If true, create a system collection. In this case collection-name should start with an underscore. End users should normally create non-system collections only. API implementors may be required to create system collections in very special occasions, but normally a regular collection will do. (The default is false) + If true, create a system collection. In this case collection-name should + start with an underscore. End users should normally create non-system + collections only. API implementors may be required to create system collections + in very special occasions, but normally a regular collection will do. + (The default is false) - **type**: `CollectionType` @@ -61,28 +90,41 @@ Creates a collection with the given _options_ for this collection's name, then r - **indexBuckets**: `Integer` - The: number of buckets into which indexes using a hash table are split. The default is 16 and this number has to be a power of 2 and less than or equal to 1024. For very large collections one should increase this to avoid long pauses when the hash table has to be initially built or resized, since buckets are resized individually and can be initially built in parallel. For example, 64 might be a sensible value for a collection with 100 000 000 documents. Currently, only the edge index respects this value, but other index types might follow in future ArangoDB versions. Changes (see below) are applied when the collection is loaded the next time. + The number of buckets into which indexes using a hash table are split. + The default is 16 and this number has to be a power of 2 and less than or + equal to 1024. For very large collections one should increase this to avoid + long pauses when the hash table has to be initially built or resized, since + buckets are resized individually and can be initially built in parallel. + For example, 64 might be a sensible value for a collection with + 100 000 000 documents. Currently, only the edge index respects this value, + but other index types might follow in future ArangoDB versions. + Changes (see below) are applied when the collection is loaded the next time. - **distributeShardsLike**: `String` - (The default is ""): in an Enterprise Edition cluster, this attribute binds the specifics of sharding for the newly created collection to follow that of a specified existing collection. Note: Using this parameter has consequences for the prototype collection. It can no longer be dropped, before sharding imitating collections are dropped. Equally, backups and restores of imitating collections alone will generate warnings, which can be overridden, about missing sharding prototype. + (The default is ""): in an Enterprise Edition cluster, this attribute binds + the specifics of sharding for the newly created collection to follow that + of a specified existing collection. Note: Using this parameter has + consequences for the prototype collection. It can no longer be dropped, + before sharding imitating collections are dropped. Equally, backups and + restores of imitating collections alone will generate warnings, which can + be overridden, about missing sharding prototype. **Examples** ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -db.createCollection("potatos", new CollectionCreateOptions()); -// the document collection "potatos" now exists +db.createCollection("potatoes", new CollectionCreateOptions()); +// the document collection "potatoes" now exists ``` ## ArangoCollection.create -``` -ArangoCollection.create(CollectionCreateOptions options) : CollectionEntity -``` +`ArangoCollection.create(CollectionCreateOptions options) : CollectionEntity` -Creates a collection with the given _options_ for this collection's name, then returns collection information from the server. +Creates a collection with the given _options_ for this collection's name, +then returns collection information from the server. Alternative for [ArangoDatabase.createCollection](#arangodatabasecreatecollection). @@ -92,19 +134,30 @@ Alternative for [ArangoDatabase.createCollection](#arangodatabasecreatecollectio - **journalSize**: `Long` - The maximal size of a journal or datafile in bytes. The value must be at least 1048576 (1 MiB). + The maximal size of a journal or datafile in bytes. + The value must be at least 1048576 (1 MiB). - **replicationFactor**: `Integer` - (The default is 1): in a cluster, this attribute determines how many copies of each shard are kept on different DBServers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. Any two copies reside on different DBServers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated to all "follower" replicas, before the write operation is reported successful. If a server fails, this is detected automatically and one of the servers holding copies take over, usually without an error being reported. + (The default is 1): in a cluster, this attribute determines how many copies + of each shard are kept on different DBServers. The value 1 means that only + one copy (no synchronous replication) is kept. A value of k means that k-1 + replicas are kept. Any two copies reside on different DBServers. + Replication between them is synchronous, that is, every write operation to + the "leader" copy will be replicated to all "follower" replicas, before the + write operation is reported successful. If a server fails, this is detected + automatically and one of the servers holding copies take over, usually + without an error being reported. - **satellite**: `Boolean` - If the true the collection is created as a satellite collection. In this case the _replicationFactor_ is ignored. + If the true the collection is created as a satellite collection. + In this case the _replicationFactor_ is ignored. - **waitForSync**: `Boolean` - If true then the data is synchronized to disk before returning from a document create, update, replace or removal operation. (default: false) + If true then the data is synchronized to disk before returning from a + document create, update, replace or removal operation. (default: false) - **doCompact**: `Boolean` @@ -112,19 +165,38 @@ Alternative for [ArangoDatabase.createCollection](#arangodatabasecreatecollectio - **isVolatile**: `Boolean` - If true then the collection data is kept in-memory only and not made persistent. Unloading the collection will cause the collection data to be discarded. Stopping or re-starting the server will also cause full loss of data in the collection. Setting this option will make the resulting collection be slightly faster than regular collections because ArangoDB does not enforce any synchronization to disk and does not calculate any CRC checksums for datafiles (as there are no datafiles). This option should therefore be used for cache-type collections only, and not for data that cannot be re-created otherwise. (The default is false) + If true then the collection data is kept in-memory only and not made persistent. + Unloading the collection will cause the collection data to be discarded. + Stopping or re-starting the server will also cause full loss of data in + the collection. Setting this option will make the resulting collection be + slightly faster than regular collections because ArangoDB does not enforce + any synchronization to disk and does not calculate any CRC checksums for + datafiles (as there are no datafiles). This option should therefore be used + for cache-type collections only, and not for data that cannot be re-created + otherwise. (The default is false) - **shardKeys**: `String...` - (The default is [ "_key" ]): in a cluster, this attribute determines which document attributes are used to determine the target shard for documents. Documents are sent to shards based on the values of their shard key attributes. The values of all shard key attributes in a document are hashed, and the hash value is used to determine the target shard. Note: Values of shard key attributes cannot be changed once set. This option is meaningless in a single server setup. + (The default is [ "_key" ]): in a cluster, this attribute determines which + document attributes are used to determine the target shard for documents. + Documents are sent to shards based on the values of their shard key attributes. + The values of all shard key attributes in a document are hashed, and the + hash value is used to determine the target shard. Note: Values of shard key + attributes cannot be changed once set. This option is meaningless in a + single server setup. - **numberOfShards**: `Integer` - (The default is 1): in a cluster, this value determines the number of shards to create for the collection. In a single server setup, this option is meaningless. + (The default is 1): in a cluster, this value determines the number of shards + to create for the collection. In a single server setup, this option is meaningless. - **isSystem**: `Boolean` - If true, create a system collection. In this case collection-name should start with an underscore. End users should normally create non-system collections only. API implementors may be required to create system collections in very special occasions, but normally a regular collection will do. (The default is false) + If true, create a system collection. In this case collection-name should + start with an underscore. End users should normally create non-system + collections only. API implementors may be required to create system collections + in very special occasions, but normally a regular collection will do. + (The default is false) - **type**: `CollectionType` @@ -132,27 +204,39 @@ Alternative for [ArangoDatabase.createCollection](#arangodatabasecreatecollectio - **indexBuckets**: `Integer` - The: number of buckets into which indexes using a hash table are split. The default is 16 and this number has to be a power of 2 and less than or equal to 1024. For very large collections one should increase this to avoid long pauses when the hash table has to be initially built or resized, since buckets are resized individually and can be initially built in parallel. For example, 64 might be a sensible value for a collection with 100 000 000 documents. Currently, only the edge index respects this value, but other index types might follow in future ArangoDB versions. Changes (see below) are applied when the collection is loaded the next time. + The number of buckets into which indexes using a hash table are split. + The default is 16 and this number has to be a power of 2 and less than or + equal to 1024. For very large collections one should increase this to avoid + long pauses when the hash table has to be initially built or resized, since + buckets are resized individually and can be initially built in parallel. + For example, 64 might be a sensible value for a collection with + 100 000 000 documents. Currently, only the edge index respects this value, + but other index types might follow in future ArangoDB versions. + Changes (see below) are applied when the collection is loaded the next time. - **distributeShardsLike**: `String` - (The default is ""): in an Enterprise Edition cluster, this attribute binds the specifics of sharding for the newly created collection to follow that of a specified existing collection. Note: Using this parameter has consequences for the prototype collection. It can no longer be dropped, before sharding imitating collections are dropped. Equally, backups and restores of imitating collections alone will generate warnings, which can be overridden, about missing sharding prototype. + (The default is ""): in an Enterprise Edition cluster, this attribute binds + the specifics of sharding for the newly created collection to follow that + of a specified existing collection. Note: Using this parameter has + consequences for the prototype collection. It can no longer be dropped, + before sharding imitating collections are dropped. Equally, backups and + restores of imitating collections alone will generate warnings, which can + be overridden, about missing sharding prototype. **Examples** ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoCollection collection = db.collection("potatos"); +ArangoCollection collection = db.collection("potatoes"); collection.create(new CollectionCreateOptions()); -// the document collection "potatos" now exists +// the document collection "potatoes" now exists ``` ## ArangoCollection.load -``` -ArangoCollection.load() : CollectionEntity -``` +`ArangoCollection.load() : CollectionEntity` Tells the server to load the collection into memory. @@ -168,11 +252,11 @@ collection.load(); ## ArangoCollection.unload -``` -ArangoCollection.unload() : CollectionEntity -``` +`ArangoCollection.unload() : CollectionEntity` -Tells the server to remove the collection from memory. This call does not delete any documents. You can use the collection afterwards; in which case it will be loaded into memory, again. +Tells the server to remove the collection from memory. This call does not +delete any documents. You can use the collection afterwards; in which case +it will be loaded into memory, again. **Examples** @@ -186,9 +270,7 @@ collection.unload(); ## ArangoCollection.changeProperties -``` -ArangoCollection.changeProperties(CollectionPropertiesOptions options) : CollectionPropertiesEntity -``` +`ArangoCollection.changeProperties(CollectionPropertiesOptions options) : CollectionPropertiesEntity` Changes the properties of the collection. @@ -206,7 +288,9 @@ ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); ArangoCollection collection = db.collection("some-collection"); -CollectionPropertiesEntity result = collection.changeProperties(new CollectionPropertiesEntity().waitForSync(true)); +CollectionPropertiesEntity result = collection.changeProperties( + new CollectionPropertiesEntity().waitForSync(true) +); assertThat(result.getWaitForSync(), is(true)); // the collection will now wait for data being written to disk // whenever a document is changed @@ -214,9 +298,7 @@ assertThat(result.getWaitForSync(), is(true)); ## ArangoCollection.rename -``` -ArangoCollection.rename(String newName) : CollectionEntity -``` +`ArangoCollection.rename(String newName) : CollectionEntity` Renames the collection @@ -240,9 +322,7 @@ assertThat(result.getName(), is("new-collection-name"); ## ArangoCollection.truncate -``` -ArangoCollection.truncate() : CollectionEntity -``` +`ArangoCollection.truncate() : CollectionEntity` Removes all documents from the collection, but leaves the indexes intact. @@ -259,9 +339,7 @@ collection.truncate(); ## ArangoCollection.drop -``` -ArangoCollection.drop() : void -``` +`ArangoCollection.drop() : void` Deletes the collection from the database. diff --git a/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md b/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md index 306a5f8cf..211476d31 100644 --- a/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md +++ b/docs/Drivers/Java/Reference/Collection/DocumentManipulation.md @@ -5,9 +5,7 @@ These functions implement the ## ArangoCollection.documentExists -``` -ArangoCollection.documentExists(String key) : Boolean -``` +`ArangoCollection.documentExists(String key) : Boolean` Checks if the document exists by reading a single document head @@ -29,9 +27,7 @@ Boolean exists = collection.documentExists("some-key"); ## ArangoCollection.getDocument -``` -ArangoCollection.getDocument(String key, Class type, DocumentReadOptions options) : T -``` +`ArangoCollection.getDocument(String key, Class type, DocumentReadOptions options) : T` Retrieves the document with the given \_key from the collection. @@ -43,7 +39,7 @@ Retrieves the document with the given \_key from the collection. - **type**: `Class` - The type of the document (POJO class, `VPackSlice` or `String` for Json) + The type of the document (POJO class, `VPackSlice` or `String` for JSON) - **options**: `DocumentReadOptions` @@ -71,9 +67,7 @@ BaseDocument document = collection.getDocument("some-key", BaseDocument.class); ## ArangoCollection.getDocuments -``` -ArangoCollection.getDocuments(Collection keys, Class type) : MultiDocumentEntity -``` +`ArangoCollection.getDocuments(Collection keys, Class type) : MultiDocumentEntity` Retrieves multiple documents with the given \_key from the collection. @@ -85,7 +79,7 @@ Retrieves multiple documents with the given \_key from the collection. - **type**: `Class` - The type of the document (POJO class, `VPackSlice` or `String` for Json) + The type of the document (POJO class, `VPackSlice` or `String` for JSON) **Examples** @@ -100,17 +94,17 @@ MultiDocumentEntity documents = collection.getDocuments(keys, Base ## ArangoCollection.insertDocument -``` -ArangoCollection.insertDocument(T value, DocumentCreateOptions options) : DocumentCreateEntity -``` +`ArangoCollection.insertDocument(T value, DocumentCreateOptions options) : DocumentCreateEntity` -Creates a new document from the given document, unless there is already a document with the \_key given. If no \_key is given, a new unique \_key is generated automatically. +Creates a new document from the given document, unless there is already a +document with the \_key given. If no \_key is given, a new unique \_key is +generated automatically. **Arguments** - **value**: `T` - A representation of a single document (POJO, `VPackSlice` or `String` for Json) + A representation of a single document (POJO, `VPackSlice` or `String` for JSON) - **options**: `DocumentCreateOptions` @@ -124,15 +118,22 @@ Creates a new document from the given document, unless there is already a docume - **returnOld**: `Boolean` - This options requires ArangoDB version 3.4.0 or higher. Additionally return the complete old document under the attribute old in the result. Only available if the _overwrite_ option is used. + This options requires ArangoDB version 3.4.0 or higher. Additionally return + the complete old document under the attribute old in the result. + Only available if the _overwrite_ option is used. - **overwrite**: `Boolean` - This options requires ArangoDB version 3.4.0 or higher. If set to true, the insert becomes a replace-insert. If a document with the same \_key already exists the new document is not rejected with unique constraint violated but will replace the old document. + This options requires ArangoDB version 3.4.0 or higher. If set to true, the + insert becomes a replace-insert. If a document with the same \_key already + exists the new document is not rejected with unique constraint violated but + will replace the old document. - **silent**: `Boolean` - If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. + If set to true, an empty object will be returned as response. No meta-data + will be returned for the created document. This option can be used to save + some network traffic. **Examples** @@ -148,17 +149,17 @@ collection.insertDocument(document, new DocumentCreateOptions()); ## ArangoCollection.insertDocuments -``` -ArangoCollection.insertDocuments(Collection values, DocumentCreateOptions options) : MultiDocumentEntity> -``` +`ArangoCollection.insertDocuments(Collection values, DocumentCreateOptions options) : MultiDocumentEntity>` -Creates new documents from the given documents, unless there is already a document with the \_key given. If no \_key is given, a new unique \_key is generated automatically. +Creates new documents from the given documents, unless there is already a +document with the \_key given. If no \_key is given, a new unique \_key is +generated automatically. **Arguments** - **values**: `Collection` - A List of documents (POJO, `VPackSlice` or `String` for Json) + A List of documents (POJO, `VPackSlice` or `String` for JSON) - **options**: `DocumentCreateOptions` @@ -172,15 +173,22 @@ Creates new documents from the given documents, unless there is already a docume - **returnOld**: `Boolean` - This options requires ArangoDB version 3.4.0 or higher. Additionally return the complete old document under the attribute old in the result. Only available if the _overwrite_ option is used. + This options requires ArangoDB version 3.4.0 or higher. Additionally return + the complete old document under the attribute old in the result. + Only available if the _overwrite_ option is used. - **overwrite**: `Boolean` - This options requires ArangoDB version 3.4.0 or higher. If set to true, the insert becomes a replace-insert. If a document with the same \_key already exists the new document is not rejected with unique constraint violated but will replace the old document. + This options requires ArangoDB version 3.4.0 or higher. If set to true, the + insert becomes a replace-insert. If a document with the same \_key already + exists the new document is not rejected with unique constraint violated but + will replace the old document. - **silent**: `Boolean` - If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. + If set to true, an empty object will be returned as response. No meta-data + will be returned for the created document. This option can be used to save + some network traffic. **Examples** @@ -192,16 +200,18 @@ ArangoCollection collection = db.collection("some-collection"); BaseDocument doc1 = new BaseDocument(); BaseDocument doc2 = new BaseDocument(); BaseDocument doc3 = new BaseDocument(); -collection.insertDocuments(Arrays.asList(doc1, doc2, doc3), new DocumentCreateOptions()); +collection.insertDocuments( + Arrays.asList(doc1, doc2, doc3), + new DocumentCreateOptions() +); ``` ## ArangoCollection.replaceDocument -``` -ArangoCollection.replaceDocument(String key, T value, DocumentReplaceOptions options) : DocumentUpdateEntity -``` +`ArangoCollection.replaceDocument(String key, T value, DocumentReplaceOptions options) : DocumentUpdateEntity` -Replaces the document with _key_ with the one in the body, provided there is such a document and no precondition is violated. +Replaces the document with _key_ with the one in the body, provided there is +such a document and no precondition is violated. **Arguments** @@ -211,7 +221,7 @@ Replaces the document with _key_ with the one in the body, provided there is suc - **value**: `T` - A representation of a single document (POJO, `VPackSlice` or `String` for Json) + A representation of a single document (POJO, `VPackSlice` or `String` for JSON) - **options**: `DocumentReplaceOptions` @@ -221,7 +231,10 @@ Replaces the document with _key_ with the one in the body, provided there is suc - **ignoreRevs**: `Boolean` - By default, or if this is set to true, the \_rev attributes in the given document is ignored. If this is set to false, then the \_rev attribute given in the body document is taken as a precondition. The document is only replaced if the current revision is the one specified. + By default, or if this is set to true, the \_rev attributes in the given + document is ignored. If this is set to false, then the \_rev attribute + given in the body document is taken as a precondition. The document is + only replaced if the current revision is the one specified. - **ifMatch**: `String` @@ -237,7 +250,9 @@ Replaces the document with _key_ with the one in the body, provided there is suc - **silent**: `Boolean` - If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. + If set to true, an empty object will be returned as response. No meta-data + will be returned for the created document. This option can be used to save + some network traffic. **Examples** @@ -259,17 +274,17 @@ assertThat(doc.getAttribute("hello"), is("world2")); ## ArangoCollection.replaceDocuments -``` -ArangoCollection.replaceDocuments(Collection values, DocumentReplaceOptions options) : MultiDocumentEntity> -``` +`ArangoCollection.replaceDocuments(Collection values, DocumentReplaceOptions options) : MultiDocumentEntity>` -Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are specified by the \_key attributes in the documents in values. +Replaces multiple documents in the specified collection with the ones in the +values, the replaced documents are specified by the \_key attributes in the +documents in values. **Arguments** - **values**: `Collection` - A List of documents (POJO, `VPackSlice` or `String` for Json) + A List of documents (POJO, `VPackSlice` or `String` for JSON) - **options**: `DocumentReplaceOptions` @@ -279,7 +294,10 @@ Replaces multiple documents in the specified collection with the ones in the val - **ignoreRevs**: `Boolean` - By default, or if this is set to true, the \_rev attributes in the given document is ignored. If this is set to false, then the \_rev attribute given in the body document is taken as a precondition. The document is only replaced if the current revision is the one specified. + By default, or if this is set to true, the \_rev attributes in the given + document is ignored. If this is set to false, then the \_rev attribute + given in the body document is taken as a precondition. The document is + only replaced if the current revision is the one specified. - **ifMatch**: `String` @@ -295,7 +313,9 @@ Replaces multiple documents in the specified collection with the ones in the val - **silent**: `Boolean` - If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. + If set to true, an empty object will be returned as response. No meta-data + will be returned for the created document. This option can be used to save + some network traffic. **Examples** @@ -311,16 +331,18 @@ collection.insertDocuments(Arrays.asList(doc1, doc2, doc3)); // change values of doc1, doc2, doc3 -collection.replaceDocuments(Arrays.asList(doc1, doc2, doc3), new DocumentReplaceOptions()); +collection.replaceDocuments( + Arrays.asList(doc1, doc2, doc3), + new DocumentReplaceOptions() +); ``` ## ArangoCollection.updateDocument -``` -ArangoCollection.updateDocument(String key, T value, DocumentUpdateOptions options) : DocumentUpdateEntity -``` +`ArangoCollection.updateDocument(String key, T value, DocumentUpdateOptions options) : DocumentUpdateEntity` -Updates the document with _key_ with the one in the body, provided there is such a document and no precondition is violated. +Updates the document with _key_ with the one in the body, provided there is +such a document and no precondition is violated. **Arguments** @@ -330,7 +352,7 @@ Updates the document with _key_ with the one in the body, provided there is such - **value**: `T` - A representation of a single document (POJO, `VPackSlice` or `String` for Json) + A representation of a single document (POJO, `VPackSlice` or `String` for JSON) - **options**: `DocumentUpdateOptions` @@ -340,7 +362,10 @@ Updates the document with _key_ with the one in the body, provided there is such - **ignoreRevs**: `Boolean` - By default, or if this is set to true, the \_rev attributes in the given document is ignored. If this is set to false, then the \_rev attribute given in the body document is taken as a precondition. The document is only replaced if the current revision is the one specified. + By default, or if this is set to true, the \_rev attributes in the given + document is ignored. If this is set to false, then the \_rev attribute + given in the body document is taken as a precondition. The document is + only replaced if the current revision is the one specified. - **ifMatch**: `String` @@ -356,7 +381,9 @@ Updates the document with _key_ with the one in the body, provided there is such - **silent**: `Boolean` - If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. + If set to true, an empty object will be returned as response. No meta-data + will be returned for the created document. This option can be used to save + some network traffic. **Examples** @@ -378,17 +405,17 @@ assertThat(doc.getAttribute("hello"), is("world2")); ## ArangoCollection.updateDocuments -``` -ArangoCollection.updateDocuments(Collection values, DocumentUpdateOptions options) : MultiDocumentEntity> -``` +`ArangoCollection.updateDocuments(Collection values, DocumentUpdateOptions options) : MultiDocumentEntity>` -Updates multiple documents in the specified collection with the ones in the values, the replaced documents are specified by the \_key attributes in the documents in values. +Updates multiple documents in the specified collection with the ones in the +values, the replaced documents are specified by the \_key attributes in the +documents in values. **Arguments** - **values**: `Collection` - A List of documents (POJO, `VPackSlice` or `String` for Json) + A List of documents (POJO, `VPackSlice` or `String` for JSON) - **options**: `DocumentUpdateOptions` @@ -398,7 +425,10 @@ Updates multiple documents in the specified collection with the ones in the valu - **ignoreRevs**: `Boolean` - By default, or if this is set to true, the \_rev attributes in the given document is ignored. If this is set to false, then the \_rev attribute given in the body document is taken as a precondition. The document is only replaced if the current revision is the one specified. + By default, or if this is set to true, the \_rev attributes in the given + document is ignored. If this is set to false, then the \_rev attribute + given in the body document is taken as a precondition. The document is + only replaced if the current revision is the one specified. - **ifMatch**: `String` @@ -414,7 +444,9 @@ Updates multiple documents in the specified collection with the ones in the valu - **silent**: `Boolean` - If set to true, an empty object will be returned as response. No meta-data will be returned for the created document. This option can be used to save some network traffic. + If set to true, an empty object will be returned as response. No meta-data + will be returned for the created document. This option can be used to save + some network traffic. **Examples** @@ -430,14 +462,15 @@ collection.insertDocuments(Arrays.asList(doc1, doc2, doc3)); // change values of doc1, doc2, doc3 -collection.updateDocuments(Arrays.asList(doc1, doc2, doc3), new DocumentUpdateOptions()); +collection.updateDocuments( + Arrays.asList(doc1, doc2, doc3), + new DocumentUpdateOptions() +); ``` ## ArangoCollection.deleteDocument -``` -ArangoCollection.deleteDocument(String key) : DocumentDeleteEntity -``` +`ArangoCollection.deleteDocument(String key) : DocumentDeleteEntity` Deletes the document with the given _key_ from the collection. @@ -466,9 +499,7 @@ assertThat(exists, is(false)); ## ArangoCollection.deleteDocuments -``` -ArangoCollection.deleteDocuments(Collection values) : MultiDocumentEntity> -``` +`ArangoCollection.deleteDocuments(Collection values) : MultiDocumentEntity>` Deletes multiple documents from the collection. diff --git a/docs/Drivers/Java/Reference/Collection/Indexes.md b/docs/Drivers/Java/Reference/Collection/Indexes.md index 548716033..48053aa08 100644 --- a/docs/Drivers/Java/Reference/Collection/Indexes.md +++ b/docs/Drivers/Java/Reference/Collection/Indexes.md @@ -5,9 +5,7 @@ These functions implement the ## ArangoCollection.ensureHashIndex -``` -ArangoCollection.ensureHashIndex(Iterable fields, HashIndexOptions options) : IndexEntity -``` +`ArangoCollection.ensureHashIndex(Iterable fields, HashIndexOptions options) : IndexEntity` Creates a hash index for the collection if it does not already exist. @@ -29,7 +27,7 @@ Creates a hash index for the collection if it does not already exist. - **deduplicate**: `Boolean` - If false, the deduplication of array values is turned off. + If false, the de-duplication of array values is turned off. **Examples** @@ -44,9 +42,7 @@ IndexEntity index = collection.ensureHashIndex(Arrays.asList("a", "b.c")); ## ArangoCollection.ensureSkipListIndex -``` -ArangoCollection.ensureSkipListIndex(Iterable fields, SkipListIndexOptions options) : IndexEntity -``` +`ArangoCollection.ensureSkipListIndex(Iterable fields, SkipListIndexOptions options) : IndexEntity` Creates a skip-list index for the collection if it does not already exist. @@ -68,7 +64,7 @@ Creates a skip-list index for the collection if it does not already exist. - **deduplicate**: `Boolean` - If false, the deduplication of array values is turned off. + If false, the de-duplication of array values is turned off. **Examples** @@ -77,15 +73,15 @@ ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); ArangoCollection collection = db.collection("some-collection"); -IndexEntity index = collection.ensureSkipListIndex(Arrays.asList("a", "b.c")); +IndexEntity index = collection.ensureSkipListIndex( + Arrays.asList("a", "b.c") +); // the index has been created with the handle `index.getId()` ``` ## ArangoCollection.ensureGeoIndex -``` -ArangoCollection.ensureGeoIndex(Iterable fields, GeoIndexOptions options) : IndexEntity -``` +`ArangoCollection.ensureGeoIndex(Iterable fields, GeoIndexOptions options) : IndexEntity` Creates a geo index for the collection if it does not already exist. @@ -99,7 +95,9 @@ Creates a geo index for the collection if it does not already exist. - **geoJson**: `Boolean` - If a geo-spatial index on a location is constructed and geoJson is true, then the order within the array is longitude followed by latitude. This corresponds to the format described in. + If a geo-spatial index on a location is constructed and geoJson is true, + then the order within the array is longitude followed by latitude. + This corresponds to the format described in. **Examples** @@ -108,15 +106,15 @@ ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); ArangoCollection collection = db.collection("some-collection"); -IndexEntity index = collection.ensureGeoIndex(Arrays.asList("latitude", "longitude")); +IndexEntity index = collection.ensureGeoIndex( + Arrays.asList("latitude", "longitude") +); // the index has been created with the handle `index.getId()` ``` ## ArangoCollection.ensureFulltextIndex -``` -ArangoCollection.ensureFulltextIndex(Iterable fields, FulltextIndexOptions options) : IndexEntity -``` +`ArangoCollection.ensureFulltextIndex(Iterable fields, FulltextIndexOptions options) : IndexEntity` Creates a fulltext index for the collection if it does not already exist. @@ -130,7 +128,9 @@ Creates a fulltext index for the collection if it does not already exist. - **minLength**: `Integer` - Minimum character length of words to index. Will default to a server-defined value if unspecified. It is thus recommended to set this value explicitly when creating the index. + Minimum character length of words to index. Will default to a server-defined + value if unspecified. It is thus recommended to set this value explicitly + when creating the index. **Examples** @@ -139,15 +139,15 @@ ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); ArangoCollection collection = db.collection("some-collection"); -IndexEntity index = collection.ensureFulltextIndex(Arrays.asList("description")); +IndexEntity index = collection.ensureFulltextIndex( + Arrays.asList("description") +); // the index has been created with the handle `index.getId()` ``` ## ArangoCollection.ensurePersistentIndex -``` -ArangoCollection.ensurePersistentIndex(Iterable fields, PersistentIndexOptions options) : IndexEntity -``` +`ArangoCollection.ensurePersistentIndex(Iterable fields, PersistentIndexOptions options) : IndexEntity` Creates a persistent index for the collection if it does not already exist. @@ -180,9 +180,7 @@ IndexEntity index = collection.ensurePersistentIndex(Arrays.asList("a", "b.c")); ## ArangoCollection.getIndex -``` -ArangoCollection.getIndex(String id) : IndexEntity -``` +`ArangoCollection.getIndex(String id) : IndexEntity` Fetches information about the index with the given _id_ and returns it. @@ -204,9 +202,7 @@ IndexEntity index = collection.getIndex("some-index"); ## ArangoCollection.getIndexes -``` -ArangoCollection.getIndexes() : Collection -``` +`ArangoCollection.getIndexes() : Collection` Fetches a list of all indexes on this collection. @@ -222,9 +218,7 @@ Collection indexes = collection.getIndexs(); ## ArangoCollection.deleteIndex -``` -ArangoCollection.deleteIndex(String id) : String -``` +`ArangoCollection.deleteIndex(String id) : String` Deletes the index with the given _id_ from the collection. diff --git a/docs/Drivers/Java/Reference/Collection/README.md b/docs/Drivers/Java/Reference/Collection/README.md index c31555cbe..43de5a013 100644 --- a/docs/Drivers/Java/Reference/Collection/README.md +++ b/docs/Drivers/Java/Reference/Collection/README.md @@ -14,9 +14,7 @@ for details. ## ArangoCollection.exists -``` -ArangoCollection.exists() : boolean -``` +`ArangoCollection.exists() : boolean` Checks whether the collection exists @@ -25,16 +23,14 @@ Checks whether the collection exists ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoCollection collection = db.collection("potatos"); +ArangoCollection collection = db.collection("potatoes"); boolean exists = collection.exists(); ``` ## ArangoCollection.getInfo -``` -ArangoCollection.getInfo() : CollectionEntity -``` +`ArangoCollection.getInfo() : CollectionEntity` Returns information about the collection. @@ -43,16 +39,14 @@ Returns information about the collection. ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoCollection collection = db.collection("potatos"); +ArangoCollection collection = db.collection("potatoes"); CollectionEntity info = collection.getInfo(); ``` ## ArangoCollection.getProperties -``` -ArangoCollection.getProperties() : CollectionPropertiesEntity -``` +`ArangoCollection.getProperties() : CollectionPropertiesEntity` Reads the properties of the specified collection. @@ -61,16 +55,14 @@ Reads the properties of the specified collection. ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoCollection collection = db.collection("potatos"); +ArangoCollection collection = db.collection("potatoes"); CollectionPropertiesEntity properties = collection.getProperties(); ``` ## ArangoCollection.getRevision -``` -ArangoCollection.getRevision() : CollectionRevisionEntity -``` +`ArangoCollection.getRevision() : CollectionRevisionEntity` Retrieve the collections revision. @@ -79,16 +71,14 @@ Retrieve the collections revision. ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoCollection collection = db.collection("potatos"); +ArangoCollection collection = db.collection("potatoes"); CollectionRevisionEntity revision = collection.getRevision(); ``` ## ArangoCollection.getIndexes -``` -ArangoCollection.getIndexes() : Collection -``` +`ArangoCollection.getIndexes() : Collection` Fetches a list of all indexes on this collection. @@ -97,7 +87,7 @@ Fetches a list of all indexes on this collection. ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoCollection collection = db.collection("potatos"); +ArangoCollection collection = db.collection("potatoes"); Collection indexes = collection.getIndexes(); ``` diff --git a/docs/Drivers/Java/Reference/Cursor.md b/docs/Drivers/Java/Reference/Cursor.md index 687a110b7..a65aa666a 100644 --- a/docs/Drivers/Java/Reference/Cursor.md +++ b/docs/Drivers/Java/Reference/Cursor.md @@ -1,12 +1,17 @@ # Cursor API -_ArangoCursor_ instances provide an abstraction over the HTTP API's limitations. Unless a method explicitly exhausts the cursor, the driver will only fetch as many batches from the server as necessary. Like the server-side cursors, _ArangoCursor_ instances are incrementally depleted as they are read from. +_ArangoCursor_ instances provide an abstraction over the HTTP API's limitations. +Unless a method explicitly exhausts the cursor, the driver will only fetch as +many batches from the server as necessary. Like the server-side cursors, +_ArangoCursor_ instances are incrementally depleted as they are read from. ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoCursor cursor = db.query("FOR x IN 1..5 RETURN x", Integer.class); +ArangoCursor cursor = db.query( + "FOR x IN 1..5 RETURN x", Integer.class +); // query result list: [1, 2, 3, 4, 5] Integer value = cursor.next(); assertThat(value, is(1)); @@ -15,11 +20,10 @@ assertThat(value, is(1)); ## ArangoCursor.hasNext -``` -ArangoCursor.hasNext() : boolean -``` +`ArangoCursor.hasNext() : boolean` -Returns _true_ if the cursor has more elements in its current batch of results or the cursor on the server has more batches. +Returns _true_ if the cursor has more elements in its current batch of results +or the cursor on the server has more batches. **Examples** @@ -33,11 +37,11 @@ boolean hasNext = cursor.hasNext(); ## ArangoCursor.next -``` -ArangoCursor.next() : T -``` +`ArangoCursor.next() : T` -Returns the next element of the query result. If the current element is the last element of the batch and the cursor on the server provides more batches, the next batch is fetched from the server. +Returns the next element of the query result. If the current element is the last +element of the batch and the cursor on the server provides more batches, the +next batch is fetched from the server. **Examples** @@ -52,9 +56,7 @@ assertThat(value, is(1)); ## ArangoCursor.first -``` -ArangoCursor.first() : T -``` +`ArangoCursor.first() : T` Returns the first element or {@code null} if no element exists. @@ -71,9 +73,7 @@ assertThat(value, is(1)); ## ArangoCursor.foreach -``` -ArangoCursor.foreach(Consumer action) : void -``` +`ArangoCursor.foreach(Consumer action) : void` Performs the given action for each element of the _ArangoIterable_ @@ -97,11 +97,10 @@ cursor.foreach(e -> { ## ArangoCursor.map -``` -ArangoCursor.map(Function mapper) : ArangoIterable -``` +`ArangoCursor.map(Function mapper) : ArangoIterable` -Returns a _ArangoIterable_ consisting of the results of applying the given function to the elements of this _ArangoIterable_. +Returns a _ArangoIterable_ consisting of the results of applying the given +function to the elements of this _ArangoIterable_. **Arguments** @@ -123,9 +122,7 @@ cursor.map(e -> e * 10).foreach(e -> { ## ArangoCursor.filter -``` -ArangoCursor.filter(Predicate predicate) : ArangoIterable -``` +`ArangoCursor.filter(Predicate predicate) : ArangoIterable` **Arguments** @@ -147,9 +144,7 @@ cursor.filter(e -> e < 4).foreach(e -> { ## ArangoCursor.anyMatch -``` -ArangoCursor.anyMatch(Predicate predicate) : boolean -``` +`ArangoCursor.anyMatch(Predicate predicate) : boolean` Returns whether any elements of this _ArangoIterable_ match the provided predicate. @@ -172,9 +167,7 @@ assertThat(match, is(true)); ## ArangoCursor.allMatch -``` -ArangoCursor.anyMatch(Predicate predicate) : boolean -``` +`ArangoCursor.anyMatch(Predicate predicate) : boolean` Returns whether all elements of this _ArangoIterable_ match the provided predicate. @@ -197,9 +190,7 @@ assertThat(match, is(true)); ## ArangoCursor.noneMatch -``` -ArangoCursor.noneMatch(Predicate predicate) : boolean -``` +`ArangoCursor.noneMatch(Predicate predicate) : boolean` Returns whether no elements of this _ArangoIterable_ match the provided predicate. @@ -222,13 +213,12 @@ assertThat(match, is(true)); ## ArangoCursor.collectInto -``` -ArangoCursor.collectInto(R target) : R -``` +`ArangoCursor.collectInto(R target) : R` **Arguments** -Iterates over all elements of this {@code ArangoIterable} and adds each to the given target. +Iterates over all elements of this {@code ArangoIterable} and adds each to +the given target. - **target**: `R >` @@ -248,9 +238,7 @@ Collection set = cursor.collectInto(new HashSet()); ## ArangoCursor.iterator -``` -ArangoCursor.iterator() : Iterator -``` +`ArangoCursor.iterator() : Iterator` Returns an iterator over elements of the query result. @@ -266,9 +254,7 @@ Iterator iterator = cursor.iterator(); ## ArangoCursor.asListRemaining -``` -ArangoCursor.asListRemaining() : List -``` +`ArangoCursor.asListRemaining() : List` Returns the remaining results as a _List_. @@ -284,11 +270,10 @@ Collection list = cursor.asListRemaining(); ## ArangoCursor.getCount -``` -ArangoCursor.getCount() : Integer -``` +`ArangoCursor.getCount() : Integer` -Returns the total number of result documents available (only available if the query was executed with the _count_ attribute set) +Returns the total number of result documents available (only available if the +query was executed with the _count_ attribute set) **Examples** @@ -303,9 +288,7 @@ assertThat(count, is(5)); ## ArangoCursor.count -``` -ArangoCursor.count() : long -``` +`ArangoCursor.count() : long` Returns the count of elements of this _ArangoIterable_. @@ -318,16 +301,17 @@ ArangoDatabase db = arango.db("myDB"); ArangoCursor cursor = db.query("FOR x IN 1..5 RETURN x", Integer.class) long count = cursor.filter(e -> e < 4).count(); // remaining results: [1, 2, 3] -asserThat(count, is(3L)); +assertThat(count, is(3L)); ``` ## ArangoCursor.getStats -``` -ArangoCursor.getStats() : Stats -``` +`ArangoCursor.getStats() : Stats` -Returns extra information about the query result. For data-modification queries, the stats will contain the number of modified documents and the number of documents that could not be modified due to an error (if ignoreErrors query option is specified); +Returns extra information about the query result. For data-modification queries, +the stats will contain the number of modified documents and the number of +documents that could not be modified due to an error (if `ignoreErrors` +query option is specified). **Examples** @@ -341,9 +325,7 @@ Stats stats = cursor.getStats(); ## ArangoCursor.getWarnings -``` -ArangoCursor.getWarnings() : Collection -``` +`ArangoCursor.getWarnings() : Collection` Returns warnings which the query could have been produced. @@ -359,11 +341,9 @@ Collection warnings = cursor.getWarnings(); ## ArangoCursor.isCached -``` -ArangoCursor.isCached() : boolean -``` +`ArangoCursor.isCached() : boolean` -Iindicating whether the query result was served from the query cache or not. +Indicating whether the query result was served from the query cache or not. **Examples** diff --git a/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md b/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md index 40c955483..586634691 100644 --- a/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md +++ b/docs/Drivers/Java/Reference/Database/AqlUserFunctions.md @@ -5,9 +5,7 @@ These functions implement the ## ArangoDatabase.getAqlFunctions -``` -ArangoDatabase.getAqlFunctions(AqlFunctionGetOptions options) : Collection -``` +`ArangoDatabase.getAqlFunctions(AqlFunctionGetOptions options) : Collection` **Arguments** @@ -22,15 +20,15 @@ ArangoDatabase.getAqlFunctions(AqlFunctionGetOptions options) : Collection functions = db.getAqlFunctions(new AqlFunctionGetOptions().namespace("myfuncs")); +Collection functions = db.getAqlFunctions( + new AqlFunctionGetOptions().namespace("myfuncs") +); // functions is a list of function descriptions ``` ## ArangoDatabase.createAqlFunction -``` -ArangoDatabase.createAqlFunction(String name, String code, AqlFunctionCreateOptions options) : void -``` +`ArangoDatabase.createAqlFunction(String name, String code, AqlFunctionCreateOptions options) : void` **Arguments** @@ -46,7 +44,9 @@ ArangoDatabase.createAqlFunction(String name, String code, AqlFunctionCreateOpti - **isDeterministic**: `Boolean` - An optional boolean value to indicate that the function results are fully deterministic (function return value solely depends on the input value and return value is the same for repeated calls with same input) + An optional boolean value to indicate that the function results are fully + deterministic (function return value solely depends on the input value + and return value is the same for repeated calls with same input) **Examples** @@ -66,9 +66,7 @@ ArangoCursor cursor = db.query(query, null, new AqlQueryOptions(), Doubl ## ArangoDatabase.deleteAqlFunction -``` -ArangoDatabase.deleteAqlFunction(String name, AqlFunctionDeleteOptions options): Integer -``` +`ArangoDatabase.deleteAqlFunction(String name, AqlFunctionDeleteOptions options): Integer` Deletes the AQL user function with the given name from the database. @@ -82,7 +80,10 @@ Deletes the AQL user function with the given name from the database. - **group**: `Boolean` - If set to true, then the function name provided in name is treated as a namespace prefix, and all functions in the specified namespace will be deleted. If set to false, the function name provided in name must be fully qualified, including any namespaces. + If set to true, then the function name provided in name is treated as a + namespace prefix, and all functions in the specified namespace will be deleted. + If set to false, the function name provided in name must be fully qualified, + including any namespaces. **Examples** diff --git a/docs/Drivers/Java/Reference/Database/CollectionAccess.md b/docs/Drivers/Java/Reference/Database/CollectionAccess.md index 4342186a5..48cb8fcac 100644 --- a/docs/Drivers/Java/Reference/Database/CollectionAccess.md +++ b/docs/Drivers/Java/Reference/Database/CollectionAccess.md @@ -5,9 +5,7 @@ These functions implement the ## ArangoDatabase.collection -``` -ArangoDatabase.collection(String name) : ArangoCollection -``` +`ArangoDatabase.collection(String name) : ArangoCollection` Returns a _ArangoCollection_ instance for the given collection name. @@ -27,9 +25,7 @@ ArangoCollection collection = db.collection("myCollection"); ## ArangoDatabase.getCollections -``` -ArangoDatabase.getCollections() : Collection -``` +`ArangoDatabase.getCollections() : Collection` Fetches all collections from the database and returns an list of collection descriptions. diff --git a/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md b/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md index 0be41e26a..71b5024ab 100644 --- a/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md +++ b/docs/Drivers/Java/Reference/Database/DatabaseManipulation.md @@ -5,9 +5,7 @@ These functions implement the ## ArangoDB.createDatabase -``` -ArangoDB.createDatabase(String name) : Boolean -``` +`ArangoDB.createDatabase(String name) : Boolean` Creates a new database with the given name. @@ -26,9 +24,7 @@ arango.createDatabase("myDB"); ## ArangoDatabase.create() -``` -ArangoDatabase.create() : Boolean -``` +`ArangoDatabase.create() : Boolean` Creates the database. @@ -44,9 +40,7 @@ db.create(); ## ArangoDatabase.exists() -``` -ArangoDatabase.exists() : boolean -``` +`ArangoDatabase.exists() : boolean` Checks whether the database exists @@ -60,9 +54,7 @@ boolean exists = db.exists(); ## ArangoDatabase.getInfo -``` -ArangoDatabase.getInfo() : DatabaseEntity -``` +`ArangoDatabase.getInfo() : DatabaseEntity` Retrieves information about the current database @@ -76,9 +68,7 @@ DatabaseEntity info = db.getInfo(); ## ArangoDB.getDatabases -``` -ArangoDB.getDatabases() : Collection -``` +`ArangoDB.getDatabases() : Collection` Retrieves a list of all existing databases @@ -91,9 +81,7 @@ Collection names = arango.getDatabases(); ## ArangoDatabase.drop -``` -ArangoDatabase.drop() : Boolean -``` +`ArangoDatabase.drop() : Boolean` Deletes the database from the server. diff --git a/docs/Drivers/Java/Reference/Database/GraphAccess.md b/docs/Drivers/Java/Reference/Database/GraphAccess.md index c18a64f7f..a1e74f48b 100644 --- a/docs/Drivers/Java/Reference/Database/GraphAccess.md +++ b/docs/Drivers/Java/Reference/Database/GraphAccess.md @@ -5,9 +5,7 @@ These functions implement the ## ArangoDatabase.graph -``` -ArangoDatabase.graph(String name) : ArangoGraph -``` +`ArangoDatabase.graph(String name) : ArangoGraph` Returns a _ArangoGraph_ instance for the given graph name. diff --git a/docs/Drivers/Java/Reference/Database/HttpRoutes.md b/docs/Drivers/Java/Reference/Database/HttpRoutes.md index 6521db97b..ebbef0f43 100644 --- a/docs/Drivers/Java/Reference/Database/HttpRoutes.md +++ b/docs/Drivers/Java/Reference/Database/HttpRoutes.md @@ -2,11 +2,10 @@ ## ArangoDatabase.route -``` -ArangoDatabase.route(String... path) : ArangoRoute -``` +`ArangoDatabase.route(String... path) : ArangoRoute` -Returns a new _ArangoRoute_ instance for the given path (relative to the database) that can be used to perform arbitrary requests. +Returns a new _ArangoRoute_ instance for the given path +(relative to the database) that can be used to perform arbitrary requests. **Arguments** diff --git a/docs/Drivers/Java/Reference/Database/Queries.md b/docs/Drivers/Java/Reference/Database/Queries.md index 2ff534de8..9966f1e70 100644 --- a/docs/Drivers/Java/Reference/Database/Queries.md +++ b/docs/Drivers/Java/Reference/Database/Queries.md @@ -5,11 +5,10 @@ This function implements the ## ArangoDatabase.query -``` -ArangoDatabase.query(String query, Map bindVars, AqlQueryOptions options, Class type) : ArangoCursor -``` +`ArangoDatabase.query(String query, Map bindVars, AqlQueryOptions options, Class type) : ArangoCursor` -Performs a database query using the given _query_ and _bindVars_, then returns a new _ArangoCursor_ instance for the result list. +Performs a database query using the given _query_ and _bindVars_, then returns +a new _ArangoCursor_ instance for the result list. **Arguments** @@ -25,31 +24,54 @@ Performs a database query using the given _query_ and _bindVars_, then returns a - **count**: `Boolean` - Indicates whether the number of documents in the result set should be returned in the "count" attribute of the result. Calculating the "count" attribute might have a performance impact for some queries in the future so this option is turned off by default, and "count" is only returned when requested. + Indicates whether the number of documents in the result set should be + returned in the "count" attribute of the result. Calculating the "count" + attribute might have a performance impact for some queries in the future + so this option is turned off by default, and "count" is only returned + when requested. - **ttl**: `Integer` - The time-to-live for the cursor (in seconds). The cursor will be removed on the server automatically after the specified amount of time. This is useful to ensure garbage collection of cursors that are not fully fetched by clients. If not set, a server-defined value will be used. + The time-to-live for the cursor (in seconds). The cursor will be removed + on the server automatically after the specified amount of time. + This is useful to ensure garbage collection of cursors that are not fully + fetched by clients. If not set, a server-defined value will be used. - **batchSize**: `Integer` - Maximum number of result documents to be transferred from the server to the client in one roundtrip. If this attribute is not set, a server-controlled default value will be used. A batchSize value of 0 is disallowed. + Maximum number of result documents to be transferred from the server to + the client in one roundtrip. If this attribute is not set, a server-controlled + default value will be used. A batchSize value of 0 is disallowed. - **memoryLimit**: `Long` - The maximum number of memory (measured in bytes) that the query is allowed to use. If set, then the query will fail with error "resource limit exceeded" in case it allocates too much memory. A value of 0 indicates that there is no memory limit. + The maximum number of memory (measured in bytes) that the query is allowed + to use. If set, then the query will fail with error "resource limit exceeded" + in case it allocates too much memory. A value of 0 indicates that there is + no memory limit. - **cache**: `Boolean` - Flag to determine whether the AQL query cache shall be used. If set to false, then any query cache lookup will be skipped for the query. If set to true, it will lead to the query cache being checked for the query if the query cache mode is either on or demand. + Flag to determine whether the AQL query cache shall be used. + If set to false, then any query cache lookup will be skipped for the query. + If set to true, it will lead to the query cache being checked for the query + if the query cache mode is either on or demand. - **failOnWarning**: `Boolean` - When set to true, the query will throw an exception and abort instead of producing a warning. This option should be used during development to catch potential issues early. When the attribute is set to false, warnings will not be propagated to exceptions and will be returned with the query result. There is also a server configuration option --query.fail-on-warning for setting the default value for failOnWarning so it does not need to be set on a per-query level. + When set to true, the query will throw an exception and abort instead of + producing a warning. This option should be used during development to catch + potential issues early. When the attribute is set to false, warnings will + not be propagated to exceptions and will be returned with the query result. + There is also a server configuration option `--query.fail-on-warning` for + setting the default value for failOnWarning so it does not need to be set + on a per-query level. - **profile**: `Boolean` - If set to true, then the additional query profiling information will be returned in the sub-attribute profile of the extra return attribute if the query result is not served from the query cache. + If set to true, then the additional query profiling information will be + returned in the sub-attribute profile of the extra return attribute if the + query result is not served from the query cache. - **maxTransactionSize**: `Long` @@ -57,27 +79,51 @@ Performs a database query using the given _query_ and _bindVars_, then returns a - **maxWarningCount**: `Long` - Limits the maximum number of warnings a query will return. The number of warnings a query will return is limited to 10 by default, but that number can be increased or decreased by setting this attribute. + Limits the maximum number of warnings a query will return. The number of + warnings a query will return is limited to 10 by default, but that number + can be increased or decreased by setting this attribute. - **intermediateCommitCount**: `Long` - Maximum number of operations after which an intermediate commit is performed automatically. Honored by the RocksDB storage engine only. + Maximum number of operations after which an intermediate commit is + performed automatically. Honored by the RocksDB storage engine only. - **intermediateCommitSize**: `Long` - Maximum total size of operations after which an intermediate commit is performed automatically. Honored by the RocksDB storage engine only. + Maximum total size of operations after which an intermediate commit is + performed automatically. Honored by the RocksDB storage engine only. - **satelliteSyncWait**: `Double` - This Enterprise Edition parameter allows to configure how long a DBServer will have time to bring the satellite collections involved in the query into sync. The default value is 60.0 (seconds). When the max time has been reached the query will be stopped. + This Enterprise Edition parameter allows to configure how long a DBServer + will have time to bring the satellite collections involved in the query + into sync. The default value is 60.0 (seconds). When the max time has been + reached the query will be stopped. - **skipInaccessibleCollections** - AQL queries (especially graph traversals) will treat collection to which a user has no access rights as if these collections were empty. Instead of returning a forbidden access error, your queries will execute normally. This is intended to help with certain use-cases: A graph contains several collections and different users execute AQL queries on that graph. You can now naturally limit the accessible results by changing the access rights of users on collections. This feature is only available in the Enterprise Edition. + AQL queries (especially graph traversals) will treat collection to which a + user has no access rights as if these collections were empty. Instead of + returning a forbidden access error, your queries will execute normally. + This is intended to help with certain use-cases: A graph contains several + collections and different users execute AQL queries on that graph. + You can now naturally limit the accessible results by changing the + access rights of users on collections. This feature is only available in + the Enterprise Edition. - **fullCount**: `Boolean` - If set to true and the query contains a LIMIT clause, then the result will have an extra attribute with the sub-attributes stats and fullCount, { ... , "extra": { "stats": { "fullCount": 123 } } }. The fullCount attribute will contain the number of documents in the result before the last LIMIT in the query was applied. It can be used to count the number of documents that match certain filter criteria, but only return a subset of them, in one go. It is thus similar to MySQL's SQL_CALC_FOUND_ROWS hint. Note that setting the option will disable a few LIMIT optimizations and may lead to more documents being processed, and thus make queries run longer. Note that the fullCount attribute will only be present in the result if the query has a LIMIT clause and the LIMIT clause is actually used in the query. + If set to true and the query contains a LIMIT clause, then the result will + have an extra attribute with the sub-attributes stats and fullCount, + `{ ... , "extra": { "stats": { "fullCount": 123 } } }`. + The fullCount attribute will contain the number of documents in the result + before the last LIMIT in the query was applied. It can be used to count the + number of documents that match certain filter criteria, but only return a + subset of them, in one go. It is thus similar to MySQL's SQL_CALC_FOUND_ROWS hint. + Note that setting the option will disable a few LIMIT optimizations and may + lead to more documents being processed, and thus make queries run longer. + Note that the fullCount attribute will only be present in the result if the + query has a LIMIT clause and the LIMIT clause is actually used in the query. - **maxPlans**: `Integer` @@ -85,23 +131,39 @@ Performs a database query using the given _query_ and _bindVars_, then returns a - **rules**: `Collection` - A list of to-be-included or to-be-excluded optimizer rules can be put into this attribute, telling the optimizer to include or exclude specific rules. To disable a rule, prefix its name with a -, to enable a rule, prefix it with a +. There is also a pseudo-rule all, which will match all optimizer rules. + A list of to-be-included or to-be-excluded optimizer rules can be put into + this attribute, telling the optimizer to include or exclude specific rules. + To disable a rule, prefix its name with a `-`, to enable a rule, prefix it + with a `+`. There is also a pseudo-rule all, which will match all optimizer rules. - **stream**: `Boolean` - Specify true and the query will be executed in a streaming fashion. The query result is not stored on the server, but calculated on the fly. Beware: long-running queries will need to hold the collection locks for as long as the query cursor exists. When set to false a query will be executed right away in its entirety. In that case query results are either returned right away (if the resultset is small enough), or stored on the arangod instance and accessible via the cursor API (with respect to the ttl). It is advisable to only use this option on short-running queries or without exclusive locks (write-locks on MMFiles). Please note that the query options cache, count and fullCount will not work on streaming queries. Additionally query statistics, warnings and profiling data will only be available after the query is finished. The default value is false. + Specify true and the query will be executed in a streaming fashion. + The query result is not stored on the server, but calculated on the fly. + Beware: long-running queries will need to hold the collection locks for as + long as the query cursor exists. When set to false a query will be executed + right away in its entirety. In that case query results are either returned + right away (if the resultset is small enough), or stored on the arangod + instance and accessible via the cursor API (with respect to the TTL). + It is advisable to only use this option on short-running queries or without + exclusive locks (write-locks on MMFiles). Please note that the query options + cache, count and fullCount will not work on streaming queries. Additionally + query statistics, warnings and profiling data will only be available after + the query is finished. The default value is false. - **type**: `Class` - The type of the result (POJO class, `VPackSlice`, `String` for Json, or `Collection`/`List`/`Map`) + The type of the result (POJO class, `VPackSlice`, `String` for JSON, or `Collection`/`List`/`Map`) **Examples** ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoCursor cursor = db.query("FOR i IN @@collection RETURN i" - new MapBuilder().put("@collection", "myCollection").get(), - new AqlQueryOptions(), - BaseDocument.class); +ArangoCursor cursor = db.query( + "FOR i IN @@collection RETURN i" + new MapBuilder().put("@collection", "myCollection").get(), + new AqlQueryOptions(), + BaseDocument.class +); ``` diff --git a/docs/Drivers/Java/Reference/Database/README.md b/docs/Drivers/Java/Reference/Database/README.md index d0372990b..aa2a1cd40 100644 --- a/docs/Drivers/Java/Reference/Database/README.md +++ b/docs/Drivers/Java/Reference/Database/README.md @@ -2,9 +2,7 @@ ## ArangoDB.db -``` -ArangoDB.db(String name) : ArangoDatabase -``` +`ArangoDB.db(String name) : ArangoDatabase` Returns a _ArangoDatabase_ instance for the given database name. diff --git a/docs/Drivers/Java/Reference/Database/Transactions.md b/docs/Drivers/Java/Reference/Database/Transactions.md index f8d41811f..118d5c1d7 100644 --- a/docs/Drivers/Java/Reference/Database/Transactions.md +++ b/docs/Drivers/Java/Reference/Database/Transactions.md @@ -5,9 +5,7 @@ This function implements the ## ArangoDatabase.transaction -``` -ArangoDatabase.transaction(String action, Class type, TransactionOptions options) : T -``` +`ArangoDatabase.transaction(String action, Class type, TransactionOptions options) : T` Performs a server-side transaction and returns its return value. @@ -19,7 +17,7 @@ Performs a server-side transaction and returns its return value. - **type**: `Class` - The type of the result (POJO class, `VPackSlice` or `String` for Json) + The type of the result (POJO class, `VPackSlice` or `String` for JSON) - **options**: `TransactionOptions` @@ -34,5 +32,7 @@ String action = "function (params) {" + "const db = require('@arangodb').db;" + "return db._query('FOR i IN test RETURN i._key').toArray();" + "}"; -String[] keys = arango.db().transaction(action, String[].class, new TransactionOptions()); +String[] keys = arango.db().transaction( + action, String[].class, new TransactionOptions() +); ``` diff --git a/docs/Drivers/Java/Reference/Database/ViewAccess.md b/docs/Drivers/Java/Reference/Database/ViewAccess.md index e9708846c..1118dc4fc 100644 --- a/docs/Drivers/Java/Reference/Database/ViewAccess.md +++ b/docs/Drivers/Java/Reference/Database/ViewAccess.md @@ -5,9 +5,7 @@ These functions implement the ## ArangoDatabase.view -``` -ArangoDatabase.view(String name) : ArangoView -``` +`ArangoDatabase.view(String name) : ArangoView` Returns a _ArangoView_ instance for the given view name. @@ -27,9 +25,7 @@ ArangoView view = db.view("myView"); ## ArangoDatabase.arangoSearch -``` -ArangoDatabase.arangoSearch(String name) : ArangoSearch -``` +`ArangoDatabase.arangoSearch(String name) : ArangoSearch` Returns a _ArangoSearch_ instance for the given ArangoSearch view name. @@ -49,9 +45,7 @@ ArangoSearch view = db.arangoSearch("myArangoSearchView"); ## ArangoDatabase.getViews -``` -ArangoDatabase.getViews() : Collection -``` +`ArangoDatabase.getViews() : Collection` Fetches all views from the database and returns an list of collection descriptions. diff --git a/docs/Drivers/Java/Reference/Graph/EdgeCollection.md b/docs/Drivers/Java/Reference/Graph/EdgeCollection.md index 94daf2a0d..1e82fc071 100644 --- a/docs/Drivers/Java/Reference/Graph/EdgeCollection.md +++ b/docs/Drivers/Java/Reference/Graph/EdgeCollection.md @@ -2,9 +2,7 @@ ## ArangoGraph.edgeCollection -``` -ArangoGraph.edgeCollection(String name) : ArangoEdgeColleciton -``` +`ArangoGraph.edgeCollection(String name) : ArangoEdgeCollection` Returns a _ArangoEdgeCollection_ instance for the given edge collection name. @@ -26,9 +24,7 @@ ArangoEdgeCollection collection = graph.edgeCollection("some-edge-collection"); ## ArangoGraph.getEdgeDefinitions -``` -ArangoGraph.getEdgeDefinitions() : Collection -``` +`ArangoGraph.getEdgeDefinitions() : Collection` Fetches all edge collections from the graph and returns a list of collection names. @@ -44,9 +40,7 @@ Collection collections = graph.getEdgeDefinitions(); ## ArangoGraph.addEdgeDefinition -``` -ArangoGraph.addEdgeDefinition(EdgeDefinition definition) : GraphEntity -``` +`ArangoGraph.addEdgeDefinition(EdgeDefinition definition) : GraphEntity` Adds the given edge definition to the graph. @@ -73,11 +67,10 @@ graph.addEdgeDefinition(edgeDefinition); ## ArangoGraph.replaceEdgeDefinition -``` -ArangoGraph.replaceEdgeDefinition(EdgeDefinition definition) : GraphEntity -``` +`ArangoGraph.replaceEdgeDefinition(EdgeDefinition definition) : GraphEntity` -Change one specific edge definition. This will modify all occurrences of this definition in all graphs known to your database. +Change one specific edge definition. This will modify all occurrences of this +definition in all graphs known to your database. **Arguments** @@ -102,11 +95,11 @@ graph.replaceEdgeDefinition(edgeDefinition); ## ArangoGraph.removeEdgeDefinition -``` -ArangoGraph.removeEdgeDefinition(String definitionName) : GraphEntity -``` +`ArangoGraph.removeEdgeDefinition(String definitionName) : GraphEntity` -Remove one edge definition from the graph. This will only remove the edge collection, the vertex collections remain untouched and can still be used in your queries. +Remove one edge definition from the graph. This will only remove the +edge collection, the vertex collections remain untouched and can still +be used in your queries. **Arguments** diff --git a/docs/Drivers/Java/Reference/Graph/Edges.md b/docs/Drivers/Java/Reference/Graph/Edges.md index 671baa84a..3d30c8a82 100644 --- a/docs/Drivers/Java/Reference/Graph/Edges.md +++ b/docs/Drivers/Java/Reference/Graph/Edges.md @@ -2,11 +2,9 @@ ## ArangoEdgeCollection.getEdge -``` -ArangoEdgeCollection.getEdge(String key, Class type, DocumentReadOptions options) : T -``` +`ArangoEdgeCollection.getEdge(String key, Class type, DocumentReadOptions options) : T` -Retrieves the edge document with the given key from the collection. +Retrieves the edge document with the given `key` from the collection. **Arguments** @@ -16,7 +14,7 @@ Retrieves the edge document with the given key from the collection. - **type**: `Class` - The type of the edge-document (POJO class, `VPackSlice` or `String` for Json) + The type of the edge-document (POJO class, `VPackSlice` or `String` for JSON) - **options**: `DocumentReadOptions` @@ -34,9 +32,7 @@ Retrieves the edge document with the given key from the collection. ## ArangoEdgeCollection.insertEdge -``` -ArangoEdgeCollection.insertEdge(T value, EdgeCreateOptions options) : EdgeEntity -``` +`ArangoEdgeCollection.insertEdge(T value, EdgeCreateOptions options) : EdgeEntity` Creates a new edge in the collection. @@ -44,7 +40,7 @@ Creates a new edge in the collection. - **value**: `T` - A representation of a single edge (POJO, `VPackSlice` or `String` for Json) + A representation of a single edge (POJO, `VPackSlice` or `String` for JSON) - **options**: `EdgeCreateOptions` @@ -67,11 +63,10 @@ collection.insertEdge(document, new EdgeCreateOptions()); ## ArangoEdgeCollection.replaceEdge -``` -ArangoEdgeCollection.replaceEdge(String key, T value, EdgeReplaceOptions options) : EdgeUpdateEntity -``` +`ArangoEdgeCollection.replaceEdge(String key, T value, EdgeReplaceOptions options) : EdgeUpdateEntity` -Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is violated. +Replaces the edge with key with the one in the body, provided there is such +a edge and no precondition is violated. **Arguments** @@ -81,7 +76,7 @@ Replaces the edge with key with the one in the body, provided there is such a ed - **value**: `T` - A representation of a single edge (POJO, `VPackSlice` or `String` for Json) + A representation of a single edge (POJO, `VPackSlice` or `String` for JSON) - **options**: `EdgeReplaceOptions` @@ -107,11 +102,10 @@ collection.replaceEdge("some-key", document, new EdgeReplaceOptions()); ## ArangoEdgeCollection.updateEdge -``` -ArangoEdgeCollection.updateEdge(String key, T value, EdgeUpdateOptions options) : EdgeUpdateEntity -``` +`ArangoEdgeCollection.updateEdge(String key, T value, EdgeUpdateOptions options) : EdgeUpdateEntity` -Updates the edge with key with the one in the body, provided there is such a edge and no precondition is violated. +Updates the edge with key with the one in the body, provided there is such a +edge and no precondition is violated. **Arguments** @@ -121,7 +115,7 @@ Updates the edge with key with the one in the body, provided there is such a edg - **value**: `T` - A representation of a single edge (POJO, `VPackSlice` or `String` for Json) + A representation of a single edge (POJO, `VPackSlice` or `String` for JSON) - **options**: `EdgeUpdateOptions` @@ -135,7 +129,11 @@ Updates the edge with key with the one in the body, provided there is such a edg - **keepNull**: `Boolean` - If the intention is to delete existing attributes with the patch command, the URL query parameter keepNull can be used with a value of false. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of null. + If the intention is to delete existing attributes with the patch command, + the URL query parameter keepNull can be used with a value of false. + This will modify the behavior of the patch command to remove any attributes + from the existing document that are contained in the patch document with an + attribute value of null. **Examples** @@ -151,9 +149,7 @@ collection.updateEdge("some-key", document, new EdgeUpdateOptions()); ## ArangoEdgeCollection.deleteEdge -``` -ArangoEdgeCollection.deleteEdge(String key, EdgeDeleteOptions options) : void -``` +`ArangoEdgeCollection.deleteEdge(String key, EdgeDeleteOptions options) : void` Deletes the edge with the given _key_ from the collection. diff --git a/docs/Drivers/Java/Reference/Graph/README.md b/docs/Drivers/Java/Reference/Graph/README.md index d2c9199b3..2bb454492 100644 --- a/docs/Drivers/Java/Reference/Graph/README.md +++ b/docs/Drivers/Java/Reference/Graph/README.md @@ -5,11 +5,10 @@ These functions implement the ## ArangoDatabase.createGraph -``` -## ArangoDatabase.createGraph(String name, Collection edgeDefinitions, GraphCreateOptions options) : GraphEntity -``` +`ArangoDatabase.createGraph(String name, Collection edgeDefinitions, GraphCreateOptions options) : GraphEntity` -Create a new graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges. +Create a new graph in the graph module. The creation of a graph requires the +name of the graph and a definition of its edges. **Arguments** @@ -29,19 +28,30 @@ Create a new graph in the graph module. The creation of a graph requires the nam - **isSmart**: `Boolean` - Define if the created graph should be smart. This only has effect in Enterprise Edition. + Define if the created graph should be smart. + This only has effect in Enterprise Edition. - **replicationFactor**: `Integer` - (The default is 1): in a cluster, this attribute determines how many copies of each shard are kept on different DBServers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. Any two copies reside on different DBServers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated to all "follower" replicas, before the write operation is reported successful. If a server fails, this is detected automatically and one of the servers holding copies take over, usually without an error being reported. + (The default is 1): in a cluster, this attribute determines how many copies + of each shard are kept on different DBServers. The value 1 means that only + one copy (no synchronous replication) is kept. A value of k means that k-1 + replicas are kept. Any two copies reside on different DBServers. + Replication between them is synchronous, that is, every write operation to + the "leader" copy will be replicated to all "follower" replicas, before the + write operation is reported successful. If a server fails, this is detected + automatically and one of the servers holding copies take over, usually + without an error being reported. - **numberOfShards**: `Integer` - The number of shards that is used for every collection within this graph. Cannot be modified later. + The number of shards that is used for every collection within this graph. + Cannot be modified later. - **smartGraphAttribute**: `String` - The attribute name that is used to smartly shard the vertices of a graph. Every vertex in this Graph has to have this attribute. Cannot be modified later. + The attribute name that is used to smartly shard the vertices of a graph. + Every vertex in this Graph has to have this attribute. Cannot be modified later. **Examples** @@ -53,17 +63,18 @@ EdgeDefinition edgeDefinition = new EdgeDefinition() .collection("edges") .from("start-vertices") .to("end-vertices"); -GraphEntity graph = db.createGraph("some-graph", Arrays.asList(edgeDefinition), new GraphCreateOptions()); +GraphEntity graph = db.createGraph( + "some-graph", Arrays.asList(edgeDefinition), new GraphCreateOptions() +); // graph now exists ``` ## ArangoGraph.create -``` -## ArangoGraph.create(Collection edgeDefinitions, GraphCreateOptions options) : GraphEntity -``` +`ArangoGraph.create(Collection edgeDefinitions, GraphCreateOptions options) : GraphEntity` -Create a new graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges. +Create a new graph in the graph module. The creation of a graph requires the +name of the graph and a definition of its edges. Alternative for [ArangoDatabase.createGraph](#arangodatabasecreategraph). @@ -81,19 +92,30 @@ Alternative for [ArangoDatabase.createGraph](#arangodatabasecreategraph). - **isSmart**: `Boolean` - Define if the created graph should be smart. This only has effect in Enterprise Edition. + Define if the created graph should be smart. + This only has effect in Enterprise Edition. - **replicationFactor**: `Integer` - (The default is 1): in a cluster, this attribute determines how many copies of each shard are kept on different DBServers. The value 1 means that only one copy (no synchronous replication) is kept. A value of k means that k-1 replicas are kept. Any two copies reside on different DBServers. Replication between them is synchronous, that is, every write operation to the "leader" copy will be replicated to all "follower" replicas, before the write operation is reported successful. If a server fails, this is detected automatically and one of the servers holding copies take over, usually without an error being reported. + (The default is 1): in a cluster, this attribute determines how many copies + of each shard are kept on different DBServers. The value 1 means that only + one copy (no synchronous replication) is kept. A value of k means that k-1 + replicas are kept. Any two copies reside on different DBServers. + Replication between them is synchronous, that is, every write operation to + the "leader" copy will be replicated to all "follower" replicas, before the + write operation is reported successful. If a server fails, this is detected + automatically and one of the servers holding copies take over, usually + without an error being reported. - **numberOfShards**: `Integer` - The number of shards that is used for every collection within this graph. Cannot be modified later. + The number of shards that is used for every collection within this graph. + Cannot be modified later. - **smartGraphAttribute**: `String` - The attribute name that is used to smartly shard the vertices of a graph. Every vertex in this Graph has to have this attribute. Cannot be modified later. + The attribute name that is used to smartly shard the vertices of a graph. + Every vertex in this Graph has to have this attribute. Cannot be modified later. **Examples** @@ -112,9 +134,7 @@ graph.create(Arrays.asList(edgeDefinition), new GraphCreateOptions()); ## ArangoGraph.exists -``` -ArangoGraph.exists() : boolean -``` +`ArangoGraph.exists() : boolean` Checks whether the graph exists @@ -130,9 +150,7 @@ boolean exists = graph.exists(); ## ArangoGraph.getInfo -``` -ArangoGraph.getInfo() : GraphEntity -``` +`ArangoGraph.getInfo() : GraphEntity` Retrieves general information about the graph. @@ -148,9 +166,7 @@ GraphEntity info = graph.getInfo(); ## ArangoGraph.drop -``` -ArangoGraph.drop(boolean dropCollections) : void -``` +`ArangoGraph.drop(boolean dropCollections) : void` Deletes the graph from the database. @@ -158,7 +174,8 @@ Deletes the graph from the database. - **dropCollections**: `boolean` - Drop collections of this graph as well. Collections will only be dropped if they are not used in other graphs. + Drop collections of this graph as well. Collections will only be dropped if + they are not used in other graphs. **Examples** diff --git a/docs/Drivers/Java/Reference/Graph/VertexCollection.md b/docs/Drivers/Java/Reference/Graph/VertexCollection.md index 92739dcc2..10c819d68 100644 --- a/docs/Drivers/Java/Reference/Graph/VertexCollection.md +++ b/docs/Drivers/Java/Reference/Graph/VertexCollection.md @@ -2,9 +2,7 @@ ## ArangoGraph.vertexCollection -``` -ArangoGraph.vertexCollection(String name) : ArangoVertexCollection -``` +`ArangoGraph.vertexCollection(String name) : ArangoVertexCollection` Returns a _ArangoVertexCollection_ instance for the given vertex collection name. @@ -26,9 +24,7 @@ ArangoVertexCollection collection = graph.vertexCollection("some-vertex-collecti ## ArangoGraph.getVertexCollections -``` -ArangoGraph.getVertexCollections() : Collection -``` +`ArangoGraph.getVertexCollections() : Collection` Fetches all vertex collections from the graph and returns a list of collection names. @@ -44,11 +40,10 @@ Collection collections = graph.getVertexCollections(); ## ArangoGraph.addVertexCollection -``` -ArangoGraph.addVertexCollection(String name) : GraphEntity -``` +`ArangoGraph.addVertexCollection(String name) : GraphEntity` -Adds a vertex collection to the set of collections of the graph. If the collection does not exist, it will be created. +Adds a vertex collection to the set of collections of the graph. +If the collection does not exist, it will be created. **Arguments** diff --git a/docs/Drivers/Java/Reference/Graph/Vertices.md b/docs/Drivers/Java/Reference/Graph/Vertices.md index 131194d72..ced694362 100644 --- a/docs/Drivers/Java/Reference/Graph/Vertices.md +++ b/docs/Drivers/Java/Reference/Graph/Vertices.md @@ -2,11 +2,9 @@ ## ArangoVertexCollection.getVertex -``` -ArangoVertexCollection.getVertex(String key, Class type, DocumentReadOptions options) : T -``` +`ArangoVertexCollection.getVertex(String key, Class type, DocumentReadOptions options) : T` -Retrieves the vertex document with the given key from the collection. +Retrieves the vertex document with the given `key` from the collection. **Arguments** @@ -16,7 +14,7 @@ Retrieves the vertex document with the given key from the collectio - **type**: `Class` - The type of the vertex-document (POJO class, `VPackSlice` or `String` for Json) + The type of the vertex-document (POJO class, `VPackSlice` or `String` for JSON) - **options**: `DocumentReadOptions` @@ -34,9 +32,7 @@ Retrieves the vertex document with the given key from the collectio ## ArangoVertexCollection.insertVertex -``` -ArangoVertexCollection.insertVertex(T value, VertexCreateOptions options) : VertexEntity -``` +`ArangoVertexCollection.insertVertex(T value, VertexCreateOptions options) : VertexEntity` Creates a new vertex in the collection. @@ -44,7 +40,7 @@ Creates a new vertex in the collection. - **value**: `T` - A representation of a single vertex (POJO, `VPackSlice` or `String` for Json) + A representation of a single vertex (POJO, `VPackSlice` or `String` for JSON) - **options**: `VertexCreateOptions` @@ -67,11 +63,10 @@ collection.insertVertex(document, new VertexCreateOptions()); ## ArangoVertexCollection.replaceVertex -``` -ArangoVertexCollection.replaceVertex(String key, T value, VertexReplaceOptions options) : VertexUpdateEntity -``` +`ArangoVertexCollection.replaceVertex(String key, T value, VertexReplaceOptions options) : VertexUpdateEntity` -Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated. +Replaces the vertex with key with the one in the body, provided there is such +a vertex and no precondition is violated. **Arguments** @@ -81,7 +76,7 @@ Replaces the vertex with key with the one in the body, provided there is such a - **value**: `T` - A representation of a single vertex (POJO, `VPackSlice` or `String` for Json) + A representation of a single vertex (POJO, `VPackSlice` or `String` for JSON) - **options**: `VertexReplaceOptions` @@ -107,11 +102,10 @@ collection.replaceVertex("some-key", document, new VertexReplaceOptions()); ## ArangoVertexCollection.updateVertex -``` -ArangoVertexCollection.updateVertex(String key, T value, VertexUpdateOptions options) : VertexUpdateEntity -``` +`ArangoVertexCollection.updateVertex(String key, T value, VertexUpdateOptions options) : VertexUpdateEntity` -Updates the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated. +Updates the vertex with key with the one in the body, provided there is such +a vertex and no precondition is violated. **Arguments** @@ -121,7 +115,7 @@ Updates the vertex with key with the one in the body, provided there is such a v - **value**: `T` - A representation of a single vertex (POJO, `VPackSlice` or `String` for Json) + A representation of a single vertex (POJO, `VPackSlice` or `String` for JSON) - **options**: `VertexUpdateOptions` @@ -135,7 +129,11 @@ Updates the vertex with key with the one in the body, provided there is such a v - **keepNull**: `Boolean` - If the intention is to delete existing attributes with the patch command, the URL query parameter keepNull can be used with a value of false. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of null. + If the intention is to delete existing attributes with the patch command, + the URL query parameter keepNull can be used with a value of false. + This will modify the behavior of the patch command to remove any attributes + from the existing document that are contained in the patch document with + an attribute value of null. **Examples** @@ -151,9 +149,7 @@ collection.updateVertex("some-key", document, new VertexUpdateOptions()); ## ArangoVertexCollection.deleteVertex -``` -ArangoVertexCollection.deleteVertex(String key, VertexDeleteOptions options) : void -``` +`ArangoVertexCollection.deleteVertex(String key, VertexDeleteOptions options) : void` Deletes the vertex with the given _key_ from the collection. diff --git a/docs/Drivers/Java/Reference/Route.md b/docs/Drivers/Java/Reference/Route.md index c5c03f1d2..e8453113f 100644 --- a/docs/Drivers/Java/Reference/Route.md +++ b/docs/Drivers/Java/Reference/Route.md @@ -1,14 +1,15 @@ # Route API -_ArangoRoute_ instances provide access for arbitrary HTTP requests. This allows easy access to Foxx services and other HTTP APIs not covered by the driver itself. +_ArangoRoute_ instances provide access for arbitrary HTTP requests. +This allows easy access to Foxx services and other HTTP APIs not covered +by the driver itself. ## ArangoRoute.route -``` -ArangoRoute.route(String... path) : ArangoRoute -``` +`ArangoRoute.route(String... path) : ArangoRoute` -Returns a new _ArangoRoute_ instance for the given path (relative to the current route) that can be used to perform arbitrary requests. +Returns a new _ArangoRoute_ instance for the given path (relative to the +current route) that can be used to perform arbitrary requests. **Arguments** @@ -30,9 +31,7 @@ ArangoRoute users = route.route("users"); ## ArangoRoute.withHeader -``` -ArangoRoute.withHeader(String key, Object value) : ArangoRoute -``` +`ArangoRoute.withHeader(String key, Object value) : ArangoRoute` Header that should be sent with each request to the route. @@ -48,9 +47,7 @@ Header that should be sent with each request to the route. ## ArangoRoute.withQueryParam -``` -ArangoRoute.withQueryParam(String key, Object value) : ArangoRoute -``` +`ArangoRoute.withQueryParam(String key, Object value) : ArangoRoute` Query parameter that should be sent with each request to the route. @@ -66,9 +63,7 @@ Query parameter that should be sent with each request to the route. ## ArangoRoute.withBody -``` -ArangoRoute.withBody(Object body) : ArangoRoute -``` +`ArangoRoute.withBody(Object body) : ArangoRoute` The response body. The body will be serialized to _VPackSlice_. @@ -80,9 +75,7 @@ The response body. The body will be serialized to _VPackSlice_. ## ArangoRoute.delete -``` -ArangoRoute.delete() : Response -``` +`ArangoRoute.delete() : Response` Performs a DELETE request to the given URL and returns the server response. @@ -112,9 +105,7 @@ ArangoRoute route = route.route("users/admin").withQueryParam("permanent", true) ## ArangoRoute.get -``` -ArangoRoute.get() : Response -``` +`ArangoRoute.get() : Response` Performs a GET request to the given URL and returns the server response. @@ -144,9 +135,7 @@ Response response = route.route("users").withQueryParam("group", "admin").get(); ## ArangoRoute.head -``` -ArangoRoute.head() : Response -``` +`ArangoRoute.head() : Response` Performs a HEAD request to the given URL and returns the server response. @@ -164,9 +153,7 @@ ArangoRoute route = route.head(); ## ArangoRoute.patch -``` -ArangoRoute.patch() : Response -``` +`ArangoRoute.patch() : Response` Performs a PATCH request to the given URL and returns the server response. @@ -198,7 +185,8 @@ ArangoRoute route = route.route("users/admin").withBody(body).patch(); // -- or -- VPackSlice body = arango.util().serialize("{ password: 'hunter2' }"); -ArangoRoute route = route.route("users/admin").withBody(body).withQueryParam("admin", true).patch(); +ArangoRoute route = route.route("users/admin") + .withBody(body).withQueryParam("admin", true).patch(); // response.getBody() is the response body of calling // PATCH _db/_system/my-foxx-service/users/admin?admin=true // with JSON request body {"password": "hunter2"} @@ -206,9 +194,7 @@ ArangoRoute route = route.route("users/admin").withBody(body).withQueryParam("ad ## ArangoRoute.post -``` -ArangoRoute.post() : Response -``` +`ArangoRoute.post() : Response` Performs a POST request to the given URL and returns the server response. @@ -240,7 +226,8 @@ ArangoRoute route = route.route("users").withBody(body).post(); // -- or -- VPackSlice body = arango.util().serialize("{ password: 'hunter2' }"); -ArangoRoute route = route.route("users").withBody(body).withQueryParam("admin", true).post(); +ArangoRoute route = route.route("users") + .withBody(body).withQueryParam("admin", true).post(); // response.getBody() is the response body of calling // POST _db/_system/my-foxx-service/users?admin=true // with JSON request body {"username": "admin", "password": "hunter2"} @@ -248,9 +235,7 @@ ArangoRoute route = route.route("users").withBody(body).withQueryParam("admin", ## ArangoRoute.put -``` -ArangoRoute.put() : Response -``` +`ArangoRoute.put() : Response` Performs a PUT request to the given URL and returns the server response. @@ -282,7 +267,8 @@ ArangoRoute route = route.route("users/admin").withBody(body).put(); // -- or -- VPackSlice body = arango.util().serialize("{ password: 'hunter2' }"); -ArangoRoute route = route.route("users/admin").withBody(body).withQueryParam("admin", true).put(); +ArangoRoute route = route.route("users/admin") + .withBody(body).withQueryParam("admin", true).put(); // response.getBody() is the response body of calling // PUT _db/_system/my-foxx-service/users/admin?admin=true // with JSON request body {"username": "admin", "password": "hunter2"} diff --git a/docs/Drivers/Java/Reference/Serialization.md b/docs/Drivers/Java/Reference/Serialization.md index 043724871..27126ff77 100644 --- a/docs/Drivers/Java/Reference/Serialization.md +++ b/docs/Drivers/Java/Reference/Serialization.md @@ -2,7 +2,8 @@ ## VelocyPack serialization -Since version `4.1.11` you can extend the VelocyPack serialization by registering additional `VPackModule`s on `ArangoDB.Builder`. +Since version `4.1.11` you can extend the VelocyPack serialization by +registering additional `VPackModule`s on `ArangoDB.Builder`. ### Java 8 types @@ -94,153 +95,158 @@ documents, edges and query results. One implementation is which is based on [Jackson](https://github.com/FasterXML/jackson) working with [jackson-dataformat-velocypack](https://github.com/arangodb/jackson-dataformat-velocypack). -**Note**: Any registered custom [serializer/deserializer or module](#custom-serialization) will be ignored. +**Note**: Any registered custom [serializer/deserializer or module](#custom-serialization) +will be ignored. ## custom serialization ```Java - ArangoDB arangoDB = new ArangoDB.Builder().registerModule(new VPackModule() { - @Override - public > void setup(final C context) { - context.registerDeserializer(MyObject.class, new VPackDeserializer() { - @Override - public MyObject deserialize(VPackSlice parent,VPackSlice vpack, - VPackDeserializationContext context) throws VPackException { - MyObject obj = new MyObject(); - obj.setName(vpack.get("name").getAsString()); - return obj; - } - }); - context.registerSerializer(MyObject.class, new VPackSerializer() { - @Override - public void serialize(VPackBuilder builder,String attribute,MyObject value, - VPackSerializationContext context) throws VPackException { - builder.add(attribute, ValueType.OBJECT); - builder.add("name", value.getName()); - builder.close(); - } - }); - } - }).build(); +ArangoDB arangoDB = new ArangoDB.Builder().registerModule(new VPackModule() { + @Override + public > void setup(final C context) { + context.registerDeserializer(MyObject.class, new VPackDeserializer() { + @Override + public MyObject deserialize(VPackSlice parent,VPackSlice vpack, + VPackDeserializationContext context) throws VPackException { + MyObject obj = new MyObject(); + obj.setName(vpack.get("name").getAsString()); + return obj; + } + }); + context.registerSerializer(MyObject.class, new VPackSerializer() { + @Override + public void serialize(VPackBuilder builder,String attribute,MyObject value, + VPackSerializationContext context) throws VPackException { + builder.add(attribute, ValueType.OBJECT); + builder.add("name", value.getName()); + builder.close(); + } + }); + } +}).build(); ``` ## JavaBeans -The driver can serialize/deserialize JavaBeans. They need at least a constructor without parameter. +The driver can serialize/deserialize JavaBeans. They need at least a +constructor without parameter. ```Java - public class MyObject { - - private String name; - private Gender gender; - private int age; +public class MyObject { - public MyObject() { - super(); - } + private String name; + private Gender gender; + private int age; + public MyObject() { + super(); } + +} ``` -## internal fields +## Internal fields -To use Arango-internal fields (like \_id, \_key, \_rev, \_from, \_to) in your JavaBeans, use the annotation `DocumentField`. +To use Arango-internal fields (like \_id, \_key, \_rev, \_from, \_to) in your +JavaBeans, use the annotation `DocumentField`. ```Java - public class MyObject { +public class MyObject { - @DocumentField(Type.KEY) - private String key; + @DocumentField(Type.KEY) + private String key; - private String name; - private Gender gender; - private int age; - - public MyObject() { - super(); - } + private String name; + private Gender gender; + private int age; + public MyObject() { + super(); } + +} ``` -## serialized fieldnames +## Serialized fieldnames To use a different serialized name for a field, use the annotation `SerializedName`. ```Java - public class MyObject { +public class MyObject { - @SerializedName("title") - private String name; + @SerializedName("title") + private String name; - private Gender gender; - private int age; - - public MyObject() { - super(); - } + private Gender gender; + private int age; + public MyObject() { + super(); } + +} ``` -## ignore fields +## Ignore fields To ignore fields at serialization/deserialization, use the annotation `Expose` ```Java - public class MyObject { - - @Expose - private String name; - @Expose(serialize = true, deserialize = false) - private Gender gender; - private int age; +public class MyObject { - public MyObject() { - super(); - } + @Expose + private String name; + @Expose(serialize = true, deserialize = false) + private Gender gender; + private int age; + public MyObject() { + super(); } + +} ``` -## custom serializer +## Custom serializer ```Java - ArangoDB arangoDB = new ArangoDB.Builder().registerModule(new VPackModule() { - @Override - public > void setup(final C context) { - context.registerDeserializer(MyObject.class, new VPackDeserializer() { - @Override - public MyObject deserialize(VPackSlice parent,VPackSlice vpack, - VPackDeserializationContext context) throws VPackException { - MyObject obj = new MyObject(); - obj.setName(vpack.get("name").getAsString()); - return obj; - } - }); - context.registerSerializer(MyObject.class, new VPackSerializer() { - @Override - public void serialize(VPackBuilder builder,String attribute,MyObject value, - VPackSerializationContext context) throws VPackException { - builder.add(attribute, ValueType.OBJECT); - builder.add("name", value.getName()); - builder.close(); - } - }); - } - }).build(); +ArangoDB arangoDB = new ArangoDB.Builder().registerModule(new VPackModule() { + @Override + public > void setup(final C context) { + context.registerDeserializer(MyObject.class, new VPackDeserializer() { + @Override + public MyObject deserialize(VPackSlice parent,VPackSlice vpack, + VPackDeserializationContext context) throws VPackException { + MyObject obj = new MyObject(); + obj.setName(vpack.get("name").getAsString()); + return obj; + } + }); + context.registerSerializer(MyObject.class, new VPackSerializer() { + @Override + public void serialize(VPackBuilder builder,String attribute,MyObject value, + VPackSerializationContext context) throws VPackException { + builder.add(attribute, ValueType.OBJECT); + builder.add("name", value.getName()); + builder.close(); + } + }); + } +}).build(); ``` -## manually serialization +## Manual serialization -To de-/serialize from and to VelocyPack before or after a database call, use the `ArangoUtil` from the method `util()` in `ArangoDB`, `ArangoDatabase`, `ArangoCollection`, `ArangoGraph`, `ArangoEdgeCollection`or `ArangoVertexCollection`. +To de-/serialize from and to VelocyPack before or after a database call, use the +`ArangoUtil` from the method `util()` in `ArangoDB`, `ArangoDatabase`, +`ArangoCollection`, `ArangoGraph`, `ArangoEdgeCollection`or `ArangoVertexCollection`. ```Java - ArangoDB arangoDB = new ArangoDB.Builder(); - VPackSlice vpack = arangoDB.util().serialize(myObj); +ArangoDB arangoDB = new ArangoDB.Builder(); +VPackSlice vpack = arangoDB.util().serialize(myObj); ``` ```Java - ArangoDB arangoDB = new ArangoDB.Builder(); - MyObject myObj = arangoDB.util().deserialize(vpack, MyObject.class); +ArangoDB arangoDB = new ArangoDB.Builder(); +MyObject myObj = arangoDB.util().deserialize(vpack, MyObject.class); ``` diff --git a/docs/Drivers/Java/Reference/Setup.md b/docs/Drivers/Java/Reference/Setup.md index 8dc314439..1dbe1cf5f 100644 --- a/docs/Drivers/Java/Reference/Setup.md +++ b/docs/Drivers/Java/Reference/Setup.md @@ -1,56 +1,67 @@ # Driver setup -Setup with default configuration, this automatically loads a properties file arangodb.properties if exists in the classpath: +Setup with default configuration, this automatically loads a properties file +`arangodb.properties` if exists in the classpath: ```Java - // this instance is thread-safe - ArangoDB arangoDB = new ArangoDB.Builder().build(); +// this instance is thread-safe +ArangoDB arangoDB = new ArangoDB.Builder().build(); ``` The driver is configured with some default values: - - - - - - - - - - -
property-keydescriptiondefault value
arangodb.hostsArangoDB hosts127.0.0.1:8529
arangodb.timeoutconnect & request timeout(millisecond)0
arangodb.userBasic Authentication User
arangodb.passwordBasic Authentication Password
arangodb.useSsluse SSL connectionfalse
arangodb.chunksizeVelocyStream Chunk content-size(bytes)30000
arangodb.connections.maxmax number of connections1 VST, 20 HTTP
arangodb.protocolused network protocolVST
+property-key | description | default value +-------------------------|-----------------------------------------|---------------- +arangodb.hosts | ArangoDB hosts | 127.0.0.1:8529 +arangodb.timeout | connect & request timeout (millisecond) | 0 +arangodb.user | Basic Authentication User | +arangodb.password | Basic Authentication Password | +arangodb.useSsl | use SSL connection | false +arangodb.chunksize | VelocyStream Chunk content-size (bytes) | 30000 +arangodb.connections.max | max number of connections | 1 VST, 20 HTTP +arangodb.protocol | used network protocol | VST To customize the configuration the parameters can be changed in the code... ```Java - ArangoDB arangoDB = new ArangoDB.Builder().host("192.168.182.50", 8888).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .host("192.168.182.50", 8888) + .build(); ``` ... or with a custom properties file (my.properties) ```Java - InputStream in = MyClass.class.getResourceAsStream("my.properties"); - ArangoDB arangoDB = new ArangoDB.Builder().loadProperties(in).build(); +InputStream in = MyClass.class.getResourceAsStream("my.properties"); +ArangoDB arangoDB = new ArangoDB.Builder() + .loadProperties(in) + .build(); ``` Example for arangodb.properties: -```Java - arangodb.hosts=127.0.0.1:8529,127.0.0.1:8529 - arangodb.user=root - arangodb.password= +``` +arangodb.hosts=127.0.0.1:8529,127.0.0.1:8529 +arangodb.user=root +arangodb.password= ``` ## Network protocol -The drivers default used network protocol is the binary protocol VelocyStream which offers the best performance within the driver. To use HTTP, you have to set the configuration `useProtocol` to `Protocol.HTTP_JSON` for HTTP with Json content or `Protocol.HTTP_VPACK` for HTTP with [VelocyPack](https://github.com/arangodb/velocypack/blob/master/VelocyPack.md) content. +The drivers default used network protocol is the binary protocol VelocyStream +which offers the best performance within the driver. To use HTTP, you have to +set the configuration `useProtocol` to `Protocol.HTTP_JSON` for HTTP with JSON +content or `Protocol.HTTP_VPACK` for HTTP with +[VelocyPack](https://github.com/arangodb/velocypack/blob/master/VelocyPack.md) content. ```Java - ArangoDB arangoDB = new ArangoDB.Builder().useProtocol(Protocol.VST).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .useProtocol(Protocol.VST) + .build(); ``` -In addition to set the configuration for HTTP you have to add the apache httpclient to your classpath. +In addition to set the configuration for HTTP you have to add the +apache httpclient to your classpath. ```XML @@ -60,7 +71,8 @@ In addition to set the configuration for HTTP you have to add the apache httpcli ``` -**Note**: If you are using ArangoDB 3.0.x you have to set the protocol to `Protocol.HTTP_JSON` because it is the only one supported. +**Note**: If you are using ArangoDB 3.0.x you have to set the protocol to +`Protocol.HTTP_JSON` because it is the only one supported. ## SSL @@ -68,18 +80,27 @@ To use SSL, you have to set the configuration `useSsl` to `true` and set a `SSLC (see [example code](https://github.com/arangodb/arangodb-java-driver/blob/master/src/test/java/com/arangodb/example/ssl/SslExample.java)). ```Java - ArangoDB arangoDB = new ArangoDB.Builder().useSsl(true).sslContext(sc).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .useSsl(true) + .sslContext(sc) + .build(); ``` ## Connection Pooling -The driver supports connection pooling for VelocyStream with a default of 1 and HTTP with a default of 20 maximum connections per host. To change this value use the method `maxConnections(Integer)` in `ArangoDB.Builder`. +The driver supports connection pooling for VelocyStream with a default of 1 and +HTTP with a default of 20 maximum connections per host. To change this value +use the method `maxConnections(Integer)` in `ArangoDB.Builder`. ```Java - ArangoDB arangoDB = new ArangoDB.Builder().maxConnections(8).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .maxConnections(8) + .build(); ``` -The driver does not explicitly release connections. To avoid exhaustion of resources when no connection is needed, you can clear the connection pool (close all connections to the server) or use [connection TTL](#connection-time-to-live). +The driver does not explicitly release connections. To avoid exhaustion of +resources when no connection is needed, you can clear the connection pool +(close all connections to the server) or use [connection TTL](#connection-time-to-live). ```Java arangoDB.shutdown(); @@ -87,46 +108,82 @@ arangoDB.shutdown(); ## Fallback hosts -The driver supports configuring multiple hosts. The first host is used to open a connection to. When this host is not reachable the next host from the list is used. To use this feature just call the method `host(String, int)` multiple times. +The driver supports configuring multiple hosts. The first host is used to open a +connection to. When this host is not reachable the next host from the list is used. +To use this feature just call the method `host(String, int)` multiple times. ```Java - ArangoDB arangoDB = new ArangoDB.Builder().host("host1", 8529).host("host2", 8529).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .host("host1", 8529) + .host("host2", 8529) + .build(); ``` -Since version 4.3 the driver support acquiring a list of known hosts in a cluster setup or a single server setup with followers. For this the driver has to be able to successfully open a connection to at least one host to get the list of hosts. Then it can use this list when fallback is needed. To use this feature just pass `true` to the method `acquireHostList(boolean)`. +Since version 4.3 the driver support acquiring a list of known hosts in a +cluster setup or a single server setup with followers. For this the driver has +to be able to successfully open a connection to at least one host to get the +list of hosts. Then it can use this list when fallback is needed. To use this +feature just pass `true` to the method `acquireHostList(boolean)`. ```Java - ArangoDB arangoDB = new ArangoDB.Builder().acquireHostList(true).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .acquireHostList(true) + .build(); ``` ## Load Balancing -Since version 4.3 the driver supports load balancing for cluster setups in two different ways. +Since version 4.3 the driver supports load balancing for cluster setups in +two different ways. -The first one is a round robin load balancing where the driver iterates through a list of known hosts and performs every request on a different host than the request before. +The first one is a round robin load balancing where the driver iterates +through a list of known hosts and performs every request on a different +host than the request before. ```Java - ArangoDB arangoDB = new ArangoDB.Builder().loadBalancingStrategy(LoadBalancingStrategy.ROUND_ROBIN).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .loadBalancingStrategy(LoadBalancingStrategy.ROUND_ROBIN) + .build(); ``` -Just like the Fallback hosts feature the round robin load balancing strategy can use the `acquireHostList` configuration to acquire a list of all known hosts in the cluster. Do so only requires the manually configuration of only one host. Because this list is updated frequently it makes load balancing over the whole cluster very comfortable. +Just like the Fallback hosts feature the round robin load balancing strategy +can use the `acquireHostList` configuration to acquire a list of all known hosts +in the cluster. Do so only requires the manually configuration of only one host. +Because this list is updated frequently it makes load balancing over the whole +cluster very comfortable. ```Java - ArangoDB arangoDB = new ArangoDB.Builder().loadBalancingStrategy(LoadBalancingStrategy.ROUND_ROBIN).acquireHostList(true).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .loadBalancingStrategy(LoadBalancingStrategy.ROUND_ROBIN) + .acquireHostList(true) + .build(); ``` -The second load balancing strategy allows to pick a random host from the configured or acquired list of hosts and sticks to that host as long as the connection is open. This strategy is useful for an application - using the driver - which provides a session management where each session has its own instance of `ArangoDB` build from a global configured list of hosts. In this case it could be wanted that every sessions sticks with all its requests to the same host but not all sessions should use the same host. This load balancing strategy also works together with `acquireHostList`. +The second load balancing strategy allows to pick a random host from the +configured or acquired list of hosts and sticks to that host as long as the +connection is open. This strategy is useful for an application - using the driver - +which provides a session management where each session has its own instance of +`ArangoDB` build from a global configured list of hosts. In this case it could +be wanted that every sessions sticks with all its requests to the same host but +not all sessions should use the same host. This load balancing strategy also +works together with `acquireHostList`. ```Java - ArangoDB arangoDB = new ArangoDB.Builder().loadBalancingStrategy(LoadBalancingStrategy.ONE_RANDOM).acquireHostList(true).build(); +ArangoDB arangoDB = new ArangoDB.Builder() + .loadBalancingStrategy(LoadBalancingStrategy.ONE_RANDOM) + .acquireHostList(true) + .build(); ``` ## Connection time to live -Since version 4.4 the driver supports setting a TTL for connections managed by the internal connection pool. +Since version 4.4 the driver supports setting a TTL for connections managed +by the internal connection pool. ```Java -ArangoDB arango = new ArangoDB.Builder().connectionTtl(5 * 60 * 1000).build(); +ArangoDB arango = new ArangoDB.Builder() + .connectionTtl(5 * 60 * 1000) + .build(); ``` In this example all connections will be closed/reopened after 5 minutes. diff --git a/docs/Drivers/Java/Reference/View/ArangoSearch.md b/docs/Drivers/Java/Reference/View/ArangoSearch.md index a88704321..e0f9ea305 100644 --- a/docs/Drivers/Java/Reference/View/ArangoSearch.md +++ b/docs/Drivers/Java/Reference/View/ArangoSearch.md @@ -5,11 +5,10 @@ These functions implement the ## ArangoDatabase.createArangoSearch -``` -ArangoDatabase.createArangoSearch(String name, ArangoSearchCreateOptions options) : ViewEntity -``` +`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** @@ -21,11 +20,22 @@ Creates a ArangoSearch view with the given _options_, then returns view informat - **consolidationIntervalMsec**: `Long` - Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, 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. + Wait at least this many milliseconds between committing index data changes + and making them visible to queries (default: 60000, 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. - **cleanupIntervalStep**: `Long` - Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits. + Wait at least this many commits between removing unused files in + data directory (default: 10, to disable use: 0). For the case where the + consolidation policies merge segments often (i.e. a lot of commit+consolidate), + a lower value will cause a lot of disk space to be wasted. For the case + where the consolidation policies rarely merge segments (i.e. few inserts/deletes), + a higher value will impact performance without any added benefits. - **consolidationPolicy**: @@ -35,11 +45,14 @@ Creates a ArangoSearch view with the given _options_, then returns view informat - **threshold**: `Double` - Select a given segment for "consolidation" if and only if the formula based on type (as defined above) evaluates to true, valid value range [0.0, 1.0] (default: 0.85) + Select a given segment for "consolidation" if and only if the formula + based on type (as defined above) evaluates to true, valid value range + [0.0, 1.0] (default: 0.85) - **segmentThreshold**: `Long` - Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} < number_of_segments + Apply the "consolidation" operation if and only if (default: 300): + `{segmentThreshold} < number_of_segments` - **link**: `CollectionLink[]` @@ -50,15 +63,13 @@ Creates a ArangoSearch view with the given _options_, then returns view informat ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -db.createArangoSearch("potatos", new ArangoSearchPropertiesOptions()); -// the ArangoSearch view "potatos" now exists +db.createArangoSearch("potatoes", new ArangoSearchPropertiesOptions()); +// the ArangoSearch view "potatoes" now exists ``` ## ArangoSearch.create -``` -ArangoSearch.create(ArangoSearchCreateOptions options) : ViewEntity -``` +`ArangoSearch.create(ArangoSearchCreateOptions options) : ViewEntity` Creates a ArangoSearch view with the given _options_, then returns view information from the server. @@ -70,11 +81,22 @@ Alternative for `ArangoDatabase.createArangoSearch`. - **consolidationIntervalMsec**: `Long` - Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, 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. + Wait at least this many milliseconds between committing index data changes + and making them visible to queries (default: 60000, 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. - **cleanupIntervalStep**: `Long` - Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits. + Wait at least this many commits between removing unused files in + data directory (default: 10, to disable use: 0). For the case where the + consolidation policies merge segments often (i.e. a lot of commit+consolidate), + a lower value will cause a lot of disk space to be wasted. For the case + where the consolidation policies rarely merge segments (i.e. few inserts/deletes), + a higher value will impact performance without any added benefits. - **consolidationPolicy**: @@ -84,11 +106,14 @@ Alternative for `ArangoDatabase.createArangoSearch`. - **threshold**: `Double` - Select a given segment for "consolidation" if and only if the formula based on type (as defined above) evaluates to true, valid value range [0.0, 1.0] (default: 0.85) + Select a given segment for "consolidation" if and only if the formula + based on type (as defined above) evaluates to true, valid value range + [0.0, 1.0] (default: 0.85) - **segmentThreshold**: `Long` - Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} < number_of_segments + Apply the "consolidation" operation if and only if (default: 300): + `{segmentThreshold} < number_of_segments` - **link**: `CollectionLink[]` @@ -99,17 +124,15 @@ Alternative for `ArangoDatabase.createArangoSearch`. ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoSearch view = db.arangoSearch("potatos"); +ArangoSearch view = db.arangoSearch("potatoes"); view.create(new ArangoSearchPropertiesOptions()); -// the ArangoSearch view "potatos" now exists +// the ArangoSearch view "potatoes" now exists ``` ## ArangoSearch.getProperties -``` -ArangoSearch.getProperties() : ArangoSearchPropertiesEntity -``` +`ArangoSearch.getProperties() : ArangoSearchPropertiesEntity` Reads the properties of the specified view. @@ -118,16 +141,14 @@ Reads the properties of the specified view. ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoSearch view = db.arangoSearch("potatos"); +ArangoSearch view = db.arangoSearch("potatoes"); ArangoSearchPropertiesEntity properties = view.getProperties(); ``` ## ArangoSearch.updateProperties -``` -ArangoSearch.updateProperties(ArangoSearchPropertiesOptions options) : ArangoSearchPropertiesEntity -``` +`ArangoSearch.updateProperties(ArangoSearchPropertiesOptions options) : ArangoSearchPropertiesEntity` Partially changes properties of the view. @@ -137,11 +158,22 @@ Partially changes properties of the view. - **consolidationIntervalMsec**: `Long` - Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, 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. + Wait at least this many milliseconds between committing index data changes + and making them visible to queries (default: 60000, 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. - **cleanupIntervalStep**: `Long` - Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits. + Wait at least this many commits between removing unused files in + data directory (default: 10, to disable use: 0). For the case where the + consolidation policies merge segments often (i.e. a lot of commit+consolidate), + a lower value will cause a lot of disk space to be wasted. For the case + where the consolidation policies rarely merge segments (i.e. few inserts/deletes), + a higher value will impact performance without any added benefits. - **consolidationPolicy**: @@ -151,11 +183,14 @@ Partially changes properties of the view. - **threshold**: `Double` - Select a given segment for "consolidation" if and only if the formula based on type (as defined above) evaluates to true, valid value range [0.0, 1.0] (default: 0.85) + Select a given segment for "consolidation" if and only if the formula + based on type (as defined above) evaluates to true, valid value range + [0.0, 1.0] (default: 0.85) - **segmentThreshold**: `Long` - Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} < number_of_segments + Apply the "consolidation" operation if and only if (default: 300): + `{segmentThreshold} < number_of_segments` - **link**: `CollectionLink[]` @@ -168,14 +203,15 @@ ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); ArangoSearch view = db.arangoSearch("some-view"); -view.updateProperties(new ArangoSearchPropertiesOptions().link(CollectionLink.on("myCollection").fields(FieldLink.on("value").analyzers("identity")))); +view.updateProperties( + new ArangoSearchPropertiesOptions() + .link(CollectionLink.on("myCollection").fields(FieldLink.on("value").analyzers("identity"))) +); ``` ## ArangoSearch.replaceProperties -``` -ArangoSearch.replaceProperties(ArangoSearchPropertiesOptions options) : ArangoSearchPropertiesEntity -``` +`ArangoSearch.replaceProperties(ArangoSearchPropertiesOptions options) : ArangoSearchPropertiesEntity` Changes properties of the view. @@ -185,11 +221,22 @@ Changes properties of the view. - **consolidationIntervalMsec**: `Long` - Wait at least this many milliseconds between committing index data changes and making them visible to queries (default: 60000, 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. + Wait at least this many milliseconds between committing index data changes + and making them visible to queries (default: 60000, 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. - **cleanupIntervalStep**: `Long` - Wait at least this many commits between removing unused files in data directory (default: 10, to disable use: 0). For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a lot of disk space to be wasted. For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact performance without any added benefits. + Wait at least this many commits between removing unused files in + data directory (default: 10, to disable use: 0). For the case where the + consolidation policies merge segments often (i.e. a lot of commit+consolidate), + a lower value will cause a lot of disk space to be wasted. For the case + where the consolidation policies rarely merge segments (i.e. few inserts/deletes), + a higher value will impact performance without any added benefits. - **consolidationPolicy**: @@ -199,11 +246,14 @@ Changes properties of the view. - **threshold**: `Double` - Select a given segment for "consolidation" if and only if the formula based on type (as defined above) evaluates to true, valid value range [0.0, 1.0] (default: 0.85) + Select a given segment for "consolidation" if and only if the formula + based on type (as defined above) evaluates to true, valid value range + [0.0, 1.0] (default: 0.85) - **segmentThreshold**: `Long` - Apply the "consolidation" operation if and only if (default: 300): {segmentThreshold} < number_of_segments + Apply the "consolidation" operation if and only if (default: 300): + `{segmentThreshold} < number_of_segments` - **link**: `CollectionLink[]` @@ -216,5 +266,8 @@ ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); ArangoSearch view = db.arangoSearch("some-view"); -view.replaceProperties(new ArangoSearchPropertiesOptions().link(CollectionLink.on("myCollection").fields(FieldLink.on("value").analyzers("identity")))); +view.replaceProperties( + new ArangoSearchPropertiesOptions() + .link(CollectionLink.on("myCollection").fields(FieldLink.on("value").analyzers("identity"))) +); ``` diff --git a/docs/Drivers/Java/Reference/View/README.md b/docs/Drivers/Java/Reference/View/README.md index c3690d856..82e99e6b8 100644 --- a/docs/Drivers/Java/Reference/View/README.md +++ b/docs/Drivers/Java/Reference/View/README.md @@ -11,9 +11,7 @@ for details. ## ArangoView.exists -``` -ArangoView.exists() : boolean -``` +`ArangoView.exists() : boolean` Checks whether the view exists @@ -22,16 +20,14 @@ Checks whether the view exists ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoView view = db.view("potatos"); +ArangoView view = db.view("potatoes"); boolean exists = view.exists(); ``` ## ArangoView.getInfo -``` -ArangoView.getInfo() : ViewEntity -``` +`ArangoView.getInfo() : ViewEntity` Returns information about the view. @@ -40,7 +36,7 @@ Returns information about the view. ```Java ArangoDB arango = new ArangoDB.Builder().build(); ArangoDatabase db = arango.db("myDB"); -ArangoView view = db.view("potatos"); +ArangoView view = db.view("potatoes"); ViewEntity info = view.getInfo(); ``` diff --git a/docs/Drivers/Java/Reference/View/ViewManipulation.md b/docs/Drivers/Java/Reference/View/ViewManipulation.md index caefca465..e995f3bcf 100644 --- a/docs/Drivers/Java/Reference/View/ViewManipulation.md +++ b/docs/Drivers/Java/Reference/View/ViewManipulation.md @@ -5,9 +5,7 @@ These functions implement ## ArangoDatabase.createView -``` -ArangoDatabase.createView(String name, ViewType type) : ViewEntity -``` +`ArangoDatabase.createView(String name, ViewType type) : ViewEntity` Creates a view of the given _type_, then returns view information from the server. @@ -27,14 +25,12 @@ 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 "potatos" now exists +// the view "potatoes" now exists ``` ## ArangoView.rename -``` -ArangoView.rename(String newName) : ViewEntity -``` +`ArangoView.rename(String newName) : ViewEntity` Renames the view. @@ -58,9 +54,7 @@ assertThat(result.getName(), is("new-view-name"); ## ArangoView.drop -``` -ArangoView.drop() : void -``` +`ArangoView.drop() : void` Deletes the view from the database. diff --git a/src/main/java/com/arangodb/ArangoCollection.java b/src/main/java/com/arangodb/ArangoCollection.java index 29e179fdd..1dcbd975a 100644 --- a/src/main/java/com/arangodb/ArangoCollection.java +++ b/src/main/java/com/arangodb/ArangoCollection.java @@ -77,7 +77,7 @@ public interface ArangoCollection extends ArangoSerializationAccessor { * @see API * Documentation * @param value - * A representation of a single document (POJO, VPackSlice or String for Json) + * A representation of a single document (POJO, VPackSlice or String for JSON) * @return information about the document * @throws ArangoDBException */ @@ -90,7 +90,7 @@ public interface ArangoCollection extends ArangoSerializationAccessor { * @see API * Documentation * @param value - * A representation of a single document (POJO, VPackSlice or String for Json) + * A representation of a single document (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the document @@ -105,7 +105,7 @@ public interface ArangoCollection extends ArangoSerializationAccessor { * @see API * Documentation * @param values - * A List of documents (POJO, VPackSlice or String for Json) + * A List of documents (POJO, VPackSlice or String for JSON) * @return information about the documents * @throws ArangoDBException */ @@ -118,7 +118,7 @@ public interface ArangoCollection extends ArangoSerializationAccessor { * @see API * Documentation * @param values - * A List of documents (POJO, VPackSlice or String for Json) + * A List of documents (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the documents @@ -180,7 +180,7 @@ MultiDocumentEntity> insertDocuments( * @param key * The key of the document * @param type - * The type of the document (POJO class, VPackSlice or String for Json) + * The type of the document (POJO class, VPackSlice or String for JSON) * @return the document identified by the key * @throws ArangoDBException */ @@ -194,7 +194,7 @@ MultiDocumentEntity> insertDocuments( * @param key * The key of the document * @param type - * The type of the document (POJO class, VPackSlice or String for Json) + * 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 @@ -208,7 +208,7 @@ MultiDocumentEntity> insertDocuments( * @param keys * The keys of the documents * @param type - * The type of the documents (POJO class, VPackSlice or String for Json) + * The type of the documents (POJO class, VPackSlice or String for JSON) * @return the documents and possible errors * @throws ArangoDBException */ @@ -220,7 +220,7 @@ MultiDocumentEntity> insertDocuments( * @param keys * The keys of the documents * @param type - * The type of the documents (POJO class, VPackSlice or String for Json) + * The type of the documents (POJO class, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return the documents and possible errors @@ -238,7 +238,7 @@ MultiDocumentEntity getDocuments(Collection keys, Class type, * @param key * The key of the document * @param value - * A representation of a single document (POJO, VPackSlice or String for Json) + * A representation of a single document (POJO, VPackSlice or String for JSON) * @return information about the document * @throws ArangoDBException */ @@ -253,7 +253,7 @@ MultiDocumentEntity getDocuments(Collection keys, Class type, * @param key * The key of the document * @param value - * A representation of a single document (POJO, VPackSlice or String for Json) + * A representation of a single document (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the document @@ -269,7 +269,7 @@ DocumentUpdateEntity replaceDocument(String key, T value, DocumentReplace * @see API * Documentation * @param values - * A List of documents (POJO, VPackSlice or String for Json) + * A List of documents (POJO, VPackSlice or String for JSON) * @return information about the documents * @throws ArangoDBException */ @@ -282,7 +282,7 @@ DocumentUpdateEntity replaceDocument(String key, T value, DocumentReplace * @see API * Documentation * @param values - * A List of documents (POJO, VPackSlice or String for Json) + * A List of documents (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the documents @@ -302,7 +302,7 @@ MultiDocumentEntity> replaceDocuments( * @param key * The key of the document * @param value - * A representation of a single document (POJO, VPackSlice or String for Json) + * A representation of a single document (POJO, VPackSlice or String for JSON) * @return information about the document * @throws ArangoDBException */ @@ -318,7 +318,7 @@ MultiDocumentEntity> replaceDocuments( * @param key * The key of the document * @param value - * A representation of a single document (POJO, VPackSlice or String for Json) + * A representation of a single document (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the document @@ -336,7 +336,7 @@ DocumentUpdateEntity updateDocument(String key, T value, DocumentUpdateOp * @see API * Documentation * @param values - * A list of documents (POJO, VPackSlice or String for Json) + * A list of documents (POJO, VPackSlice or String for JSON) * @return information about the documents * @throws ArangoDBException */ @@ -351,7 +351,7 @@ DocumentUpdateEntity updateDocument(String key, T value, DocumentUpdateOp * @see API * Documentation * @param values - * A list of documents (POJO, VPackSlice or String for Json) + * A list of documents (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the documents @@ -369,7 +369,7 @@ MultiDocumentEntity> updateDocuments( * @param key * The key of the document * @param type - * The type of the document (POJO class, VPackSlice or String for Json). Only necessary if + * The type of the document (POJO class, VPackSlice or String for JSON). Only necessary if * options.returnOld is set to true, otherwise can be null. * @param options * Additional options, can be null @@ -386,7 +386,7 @@ MultiDocumentEntity> updateDocuments( * @param key * The key of the document * @param type - * The type of the document (POJO class, VPackSlice or String for Json). Only necessary if + * The type of the document (POJO class, VPackSlice or String for JSON). Only necessary if * options.returnOld is set to true, otherwise can be null. * @param options * Additional options, can be null @@ -405,7 +405,7 @@ DocumentDeleteEntity deleteDocument(String key, Class type, DocumentDe * @param values * The keys of the documents or the documents themselves * @param type - * The type of the documents (POJO class, VPackSlice or String for Json). Only necessary if + * The type of the documents (POJO class, VPackSlice or String for JSON). Only necessary if * options.returnOld is set to true, otherwise can be null. * @return information about the documents * @throws ArangoDBException @@ -421,7 +421,7 @@ DocumentDeleteEntity deleteDocument(String key, Class type, DocumentDe * @param values * The keys of the documents or the documents themselves * @param type - * The type of the documents (POJO class, VPackSlice or String for Json). Only necessary if + * The type of the documents (POJO class, VPackSlice or String for JSON). Only necessary if * options.returnOld is set to true, otherwise can be null. * @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 5f81d3421..6f643aadb 100644 --- a/src/main/java/com/arangodb/ArangoDatabase.java +++ b/src/main/java/com/arangodb/ArangoDatabase.java @@ -292,7 +292,7 @@ public interface ArangoDatabase extends ArangoSerializationAccessor { * @param options * Additional options that will be passed to the query API, can be null * @param type - * The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) + * The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException */ @@ -310,7 +310,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @param options * Additional options that will be passed to the query API, can be null * @param type - * The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) + * The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException */ @@ -327,7 +327,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @param bindVars * key/value pairs defining the variables to bind the query to * @param type - * The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) + * The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException */ @@ -342,7 +342,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @param query * An AQL query string * @param type - * The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) + * The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException */ @@ -357,7 +357,7 @@ ArangoCursor query(String query, Map bindVars, AqlQueryOp * @param cursorId * The ID of the cursor * @param type - * The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map) + * The type of the result (POJO class, VPackSlice, String for JSON, or Collection/List/Map) * @return cursor of the results * @throws ArangoDBException */ @@ -599,7 +599,7 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * @param action * A String evaluating to a JavaScript function to be executed on the server. * @param type - * The type of the result (POJO class, VPackSlice or String for Json) + * 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 @@ -624,9 +624,9 @@ GraphEntity createGraph(String name, Collection edgeDefinitions, * @see API * Documentation * @param vertexClass - * The type of the vertex documents (POJO class, VPackSlice or String for Json) + * The type of the vertex documents (POJO class, VPackSlice or String for JSON) * @param edgeClass - * The type of the edge documents (POJO class, VPackSlice or String for Json) + * The type of the edge documents (POJO class, VPackSlice or String for JSON) * @param options * Additional options * @return Result of the executed traversal @@ -643,7 +643,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * @param id * The id of the document * @param type - * The type of the document (POJO class, VPackSlice or String for Json) + * The type of the document (POJO class, VPackSlice or String for JSON) * @return the document identified by the id * @throws ArangoDBException */ @@ -657,7 +657,7 @@ TraversalEntity executeTraversal(Class vertexClass, Class edg * @param id * The id of the document * @param type - * The type of the document (POJO class, VPackSlice or String for Json) + * 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 diff --git a/src/main/java/com/arangodb/ArangoEdgeCollection.java b/src/main/java/com/arangodb/ArangoEdgeCollection.java index 223c682ec..66f3bee66 100644 --- a/src/main/java/com/arangodb/ArangoEdgeCollection.java +++ b/src/main/java/com/arangodb/ArangoEdgeCollection.java @@ -55,7 +55,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * * @see API Documentation * @param value - * A representation of a single edge (POJO, VPackSlice or String for Json) + * A representation of a single edge (POJO, VPackSlice or String for JSON) * @return information about the edge * @throws ArangoDBException */ @@ -66,7 +66,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * * @see API Documentation * @param value - * A representation of a single edge (POJO, VPackSlice or String for Json) + * A representation of a single edge (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the edge @@ -81,7 +81,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * @param key * The key of the edge * @param type - * The type of the edge-document (POJO class, VPackSlice or String for Json) + * The type of the edge-document (POJO class, VPackSlice or String for JSON) * @return the edge identified by the key * @throws ArangoDBException */ @@ -94,7 +94,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * @param key * The key of the edge * @param type - * The type of the edge-document (POJO class, VPackSlice or String for Json) + * 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 @@ -110,7 +110,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * @param key * The key of the edge * @param type - * The type of the edge-document (POJO class, VPackSlice or String for Json) + * The type of the edge-document (POJO class, VPackSlice or String for JSON) * @return information about the edge * @throws ArangoDBException */ @@ -124,7 +124,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * @param key * The key of the edge * @param type - * The type of the edge-document (POJO class, VPackSlice or String for Json) + * The type of the edge-document (POJO class, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the edge @@ -141,7 +141,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * @param key * The key of the edge * @param type - * The type of the edge-document (POJO class, VPackSlice or String for Json) + * The type of the edge-document (POJO class, VPackSlice or String for JSON) * @return information about the edge * @throws ArangoDBException */ @@ -156,7 +156,7 @@ public interface ArangoEdgeCollection extends ArangoSerializationAccessor { * @param key * The key of the edge * @param type - * The type of the edge-document (POJO class, VPackSlice or String for Json) + * The type of the edge-document (POJO class, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the edge diff --git a/src/main/java/com/arangodb/ArangoVertexCollection.java b/src/main/java/com/arangodb/ArangoVertexCollection.java index dbd7619a0..117f2ba3a 100644 --- a/src/main/java/com/arangodb/ArangoVertexCollection.java +++ b/src/main/java/com/arangodb/ArangoVertexCollection.java @@ -65,7 +65,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * * @see API Documentation * @param value - * A representation of a single vertex (POJO, VPackSlice or String for Json) + * A representation of a single vertex (POJO, VPackSlice or String for JSON) * @return information about the vertex * @throws ArangoDBException */ @@ -76,7 +76,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * * @see API Documentation * @param value - * A representation of a single vertex (POJO, VPackSlice or String for Json) + * A representation of a single vertex (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the vertex @@ -91,7 +91,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * @param key * The key of the vertex * @param type - * The type of the vertex-document (POJO class, VPackSlice or String for Json) + * The type of the vertex-document (POJO class, VPackSlice or String for JSON) * @return the vertex identified by the key * @throws ArangoDBException */ @@ -104,7 +104,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * @param key * The key of the vertex * @param type - * The type of the vertex-document (POJO class, VPackSlice or String for Json) + * 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 @@ -121,7 +121,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * @param key * The key of the vertex * @param value - * A representation of a single vertex (POJO, VPackSlice or String for Json) + * A representation of a single vertex (POJO, VPackSlice or String for JSON) * @return information about the vertex * @throws ArangoDBException */ @@ -136,7 +136,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * @param key * The key of the vertex * @param value - * A representation of a single vertex (POJO, VPackSlice or String for Json) + * A representation of a single vertex (POJO, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the vertex @@ -153,7 +153,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * @param key * The key of the vertex * @param type - * The type of the vertex-document (POJO class, VPackSlice or String for Json) + * The type of the vertex-document (POJO class, VPackSlice or String for JSON) * @return information about the vertex * @throws ArangoDBException */ @@ -168,7 +168,7 @@ public interface ArangoVertexCollection extends ArangoSerializationAccessor { * @param key * The key of the vertex * @param type - * The type of the vertex-document (POJO class, VPackSlice or String for Json) + * The type of the vertex-document (POJO class, VPackSlice or String for JSON) * @param options * Additional options, can be null * @return information about the vertex diff --git a/src/main/java/com/arangodb/Protocol.java b/src/main/java/com/arangodb/Protocol.java index a647ce505..066861ba6 100644 --- a/src/main/java/com/arangodb/Protocol.java +++ b/src/main/java/com/arangodb/Protocol.java @@ -32,7 +32,7 @@ public enum Protocol { */ VST, /** - * HTTP with Json body + * HTTP with JSON body */ HTTP_JSON, /** diff --git a/src/main/java/com/arangodb/model/CollectionCreateOptions.java b/src/main/java/com/arangodb/model/CollectionCreateOptions.java index 6e6649fec..79d691e50 100644 --- a/src/main/java/com/arangodb/model/CollectionCreateOptions.java +++ b/src/main/java/com/arangodb/model/CollectionCreateOptions.java @@ -261,7 +261,7 @@ public Integer getIndexBuckets() { /** * @param indexBuckets - * The: number of buckets into which indexes using a hash table are split. The default is 16 and this + * The number of buckets into which indexes using a hash table are split. The default is 16 and this * number has to be a power of 2 and less than or equal to 1024. For very large collections one should * increase this to avoid long pauses when the hash table has to be initially built or resized, since * buckets are resized individually and can be initially built in parallel. For example, 64 might be a diff --git a/src/main/java/com/arangodb/model/DocumentImportOptions.java b/src/main/java/com/arangodb/model/DocumentImportOptions.java index 6bd658386..5695826ce 100644 --- a/src/main/java/com/arangodb/model/DocumentImportOptions.java +++ b/src/main/java/com/arangodb/model/DocumentImportOptions.java @@ -79,7 +79,7 @@ public Boolean getOverwrite() { /** * @param overwrite * If this parameter has a value of true, then all data in the collection will be removed prior to the - * import. Note that any existing index definitions will be preseved. + * import. Note that any existing index definitions will be preserved. * @return options */ public DocumentImportOptions overwrite(final Boolean overwrite) { @@ -113,7 +113,7 @@ public OnDuplicate getOnDuplicate() { * This is the default setting. *
  • update: this will update an existing document in the database with the data specified in the * request. Attributes of the existing document that are not present in the request will be - * preseved.
    • + * preserved. *
  • replace: this will replace an existing document in the database with the data specified in the * request.
    • *
  • ignore: this will not update an existing document and simply ignore the error caused by the unique diff --git a/src/main/java/com/arangodb/util/ArangoDeserializer.java b/src/main/java/com/arangodb/util/ArangoDeserializer.java index 0ddfeba29..ffb30d8d6 100644 --- a/src/main/java/com/arangodb/util/ArangoDeserializer.java +++ b/src/main/java/com/arangodb/util/ArangoDeserializer.java @@ -37,7 +37,7 @@ public interface ArangoDeserializer { * @param vpack * The VelocyPack to deserialize * @param type - * The target type to deserialize to. Use String for raw Json. + * The target type to deserialize to. Use String for raw JSON. * @return The deserialized VelocyPack * @throws ArangoDBException */ diff --git a/src/main/java/com/arangodb/util/ArangoSerializer.java b/src/main/java/com/arangodb/util/ArangoSerializer.java index 738a31ce4..219a5be30 100644 --- a/src/main/java/com/arangodb/util/ArangoSerializer.java +++ b/src/main/java/com/arangodb/util/ArangoSerializer.java @@ -112,7 +112,7 @@ public boolean isStringAsJson() { * Serialize a given Object to VelocyPack * * @param entity - * The Object to serialize. If it is from type String, it will be handled as a Json. + * The Object to serialize. If it is from type String, it will be handled as a JSON. * @return The serialized VelocyPack * @throws ArangoDBException */ @@ -122,7 +122,7 @@ public boolean isStringAsJson() { * Serialize a given Object to VelocyPack * * @param entity - * The Object to serialize. If it is from type String, it will be handled as a Json. + * The Object to serialize. If it is from type String, it will be handled as a JSON. * @param options * Additional options * @return the serialized VelocyPack