ArangoDriver (arangodb-java-driver 2.2.1 API)

java.lang.Object
- com.arangodb.BaseArangoDriver
- - com.arangodb.ArangoDriver

```
public class ArangoDriver
extends BaseArangoDriver
```
ArangoDB driver. All of the functionality to use ArangoDB is provided via this class.

Version:

2.2.

Author:

tamtam180 - kirscheless at gmail.com, gschwab - [email protected], fbartels - [email protected]

Constructor Summary

Constructors
Constructor and Description
`ArangoDriver(ArangoConfigure configure)` Constructor to create an instance of the driver that uses the default database.
`ArangoDriver(ArangoConfigure configure, String database)` Constructor to create an instance of the driver that uses the provided database.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancelBatchMode()` This method cancels the batch execution mode.
`long`	`checkDocument(long collectionId, long documentId)` This method returns the current revision of a document.
`long`	`checkDocument(long collectionId, String documentKey)` This method returns the current revision of a document.
`long`	`checkDocument(String documentHandle)` This method returns the current revision of a document.
`long`	`checkDocument(String collectionName, long documentId)` This method returns the current revision of a document.
`long`	`checkDocument(String collectionName, String documentKey)` This method returns the current revision of a document.
`<T> CursorEntity<T>`	`continueQuery(long cursorId, Class<?>... clazz)` Continues data retrieval for an existing cursor
`DefaultEntity`	`createAqlFunction(String name, String code)` Creates an AQL Function
`IndexEntity`	`createCappedByDocumentSizeIndex(long collectionId, int byteSize)` This method creates a capped index for a collection.
`IndexEntity`	`createCappedByDocumentSizeIndex(String collectionName, int byteSize)` This method creates a capped index for a collection.
`IndexEntity`	`createCappedIndex(long collectionId, int size)` This method creates a capped index for a collection.
`IndexEntity`	`createCappedIndex(String collectionName, int size)` This method creates a capped index for a collection.
`CollectionEntity`	`createCollection(String name)` Creates a new collection.
`CollectionEntity`	`createCollection(String name, CollectionOptions collectionOptions)` Creates a new collection.
`BooleanResultEntity`	`createDatabase(String database, UserEntity... users)` This method creates a database
`DocumentEntity<?>`	`createDocument(long collectionId, Object value)` Creates a document in the collection defined by The collection id
`DocumentEntity<?>`	`createDocument(long collectionId, Object value, Boolean createCollection, Boolean waitForSync)` Creates a document in the collection defined by The collection id.
`DocumentEntity<?>`	`createDocument(long collectionId, String documentKey, Object value)` Creates a document in the collection defined by the collection's name.
`DocumentEntity<?>`	`createDocument(long collectionId, String documentKey, Object value, Boolean createCollection, Boolean waitForSync)` Creates a document in the collection defined by the collection's id.
`<T> DocumentEntity<T>`	`createDocument(String collectionName, Object value)` Creates a document in the collection defined by the collection's name
`<T> DocumentEntity<T>`	`createDocument(String collectionName, Object value, Boolean createCollection, Boolean waitForSync)` Creates a document in the collection defined by the collection's name.
`<T> DocumentEntity<T>`	`createDocument(String collectionName, String documentKey, Object value)` Creates a document in the collection defined by the collection's name.
`<T> DocumentEntity<T>`	`createDocument(String collectionName, String documentKey, Object value, Boolean createCollection, Boolean waitForSync)` Creates a document in the collection defined by the collection's name.
`BooleanResultEntity`	`createEndpoint(String endpoint, String... databases)` This method creates an endpoint.
`IndexEntity`	`createFulltextIndex(long collectionId, Integer minLength, String... fields)` This method creates a full text index for a collection.
`IndexEntity`	`createFulltextIndex(long collectionId, String... fields)` This method creates a full text index for a collection.
`IndexEntity`	`createFulltextIndex(String collectionName, Integer minLength, String... fields)` This method creates a full text index for a collection.
`IndexEntity`	`createFulltextIndex(String collectionName, String... fields)` This method creates a full text index for a collection.
`IndexEntity`	`createGeoIndex(String collectionName, boolean unique, String... fields)` This method creates a geo index for a collection.
`GraphEntity`	`createGraph(String graphName, Boolean waitForSync)` Creates an empty graph.
`GraphEntity`	`createGraph(String graphName, List<EdgeDefinitionEntity> edgeDefinitions, List<String> orphanCollections, Boolean waitForSync)` Creates a graph.
`IndexEntity`	`createHashIndex(String collectionName, boolean unique, String... fields)` This method creates a hash index for a collection.
`IndexEntity`	`createIndex(long collectionId, IndexType type, boolean unique, String... fields)` This method creates an index for a collection.
`IndexEntity`	`createIndex(String collectionName, IndexType type, boolean unique, String... fields)` This method creates an index for a collection.
`IndexEntity`	`createSkipListIndex(String collectionName, boolean unique, String... fields)` This method creates a skip list index for a collection.
`TransactionEntity`	`createTransaction(String action)` Creates a transaction entity.
`DefaultEntity`	`createUser(String username, String passwd, Boolean active, Map<String,Object> extra)` Creates a database user.
`void`	`deleteAllJobs()` Deletes all job from ArangoDB.
`DefaultEntity`	`deleteAqlFunction(String name, boolean isNameSpace)` Delete an AQL function.
`CollectionEntity`	`deleteCollection(long id)` Deletes a collection by id.
`CollectionEntity`	`deleteCollection(String name)` Deletes a collection by name.
`BooleanResultEntity`	`deleteDatabase(String database)` This method deletes a database
`DocumentEntity<?>`	`deleteDocument(long collectionId, long documentId)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(long collectionId, long documentId, Long rev, Policy policy)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(long collectionId, String documentKey)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(long collectionId, String documentKey, Long rev, Policy policy)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(String documentHandle)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(String collectionName, long documentId)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(String collectionName, long documentId, Long rev, Policy policy)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(String documentHandle, Long rev, Policy policy)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(String collectionName, String documentKey)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(String collectionName, String documentKey, Long rev, Policy policy)` Deletes a document from the database.
`BooleanResultEntity`	`deleteEndpoint(String endpoint)` This method deletes an endpoint
`void`	`deleteExpiredJobs(int timeStamp)` Deletes all jobs by a provided expiration date.
`DeletedEntity`	`deleteGraph(String graphName)` Delete a graph by its name.
`void`	`deleteGraph(String graphName, Boolean dropCollections)` Delete a graph by its name.
`IndexEntity`	`deleteIndex(String indexHandle)` Deletes an index from a collection
`void`	`deleteJobById(String JobId)` Deletes a job from ArangoDB.
`DefaultEntity`	`deleteUser(String username)` Deletes a database user.
`DefaultEntity`	`executeBatch()` This method sends all stacked requests as batch to ArangoDB.
`<T> CursorEntity<T>`	`executeQuery(String query, Map<String,Object> bindVars, Class<T> clazz, Boolean calcCount, Integer batchSize)` This method executes an AQL query and returns a CursorEntity
`<T> CursorResultSet<T>`	`executeQueryWithResultSet(String query, Map<String,Object> bindVars, Class<T> clazz, Boolean calcCount, Integer batchSize)` This method executes an AQL query and returns a CursorResultSet
`DefaultEntity`	`executeScript(String jsCode)` Executes a javascript code.
`<T> CursorEntity<T>`	`executeSimpleAll(String collectionName, int skip, int limit, Class<?> clazz)` Returns all documents of a collections.
`<T> CursorEntity<DocumentEntity<T>>`	`executeSimpleAllWithDocument(String collectionName, int skip, int limit, Class<?> clazz)` Returns all documents of a collections.
`<T> CursorResultSet<DocumentEntity<T>>`	`executeSimpleAllWithDocumentResultSet(String collectionName, int skip, int limit, Class<?> clazz)` Returns all documents of a collections.
`<T> CursorResultSet<T>`	`executeSimpleAllWithResultSet(String collectionName, int skip, int limit, Class<?> clazz)` Returns all documents of a collections.
`<T> ScalarExampleEntity<T>`	`executeSimpleAny(String collectionName, Class<?> clazz)` Returns a random document from the collection
`<T> CursorEntity<T>`	`executeSimpleByExample(String collectionName, Map<String,Object> example, int skip, int limit, Class<T> clazz)` This will find all documents matching a given example.
`<T> CursorEntity<DocumentEntity<T>>`	`executeSimpleByExampleWithDocument(String collectionName, Map<String,Object> example, int skip, int limit, Class<?> clazz)` This will find all documents matching a given example.
`<T> CursorResultSet<DocumentEntity<T>>`	`executeSimpleByExampleWithDocumentResusltSet(String collectionName, Map<String,Object> example, int skip, int limit, Class<?> clazz)` This will find all documents matching a given example.
`<T> CursorResultSet<T>`	`executeSimpleByExampleWithResusltSet(String collectionName, Map<String,Object> example, int skip, int limit, Class<?> clazz)` This will find all documents matching a given example.
`<T> DocumentResultEntity<T>`	`executeSimpleFirst(String collectionName, Integer count, Class<?> clazz)` This will return the first document(s) from the collection, in the order of insertion/update time.
`<T> ScalarExampleEntity<T>`	`executeSimpleFirstExample(String collectionName, Map<String,Object> example, Class<?> clazz)` Returns the first document matching the example
`<T> CursorEntity<T>`	`executeSimpleFulltext(String collectionName, String attribute, String query, int skip, int limit, String index, Class<?> clazz)` This will find all documents from the collection that match the fulltext query specified in query.
`<T> CursorEntity<DocumentEntity<T>>`	`executeSimpleFulltextWithDocument(String collectionName, String attribute, String query, int skip, int limit, String index, Class<?> clazz)` This will find all documents from the collection that match the fulltext query specified in query.
`<T> CursorResultSet<DocumentEntity<T>>`	`executeSimpleFulltextWithDocumentResultSet(String collectionName, String attribute, String query, int skip, int limit, String index, Class<?> clazz)` This will find all documents from the collection that match the fulltext query specified in query.
`<T> CursorResultSet<T>`	`executeSimpleFulltextWithResultSet(String collectionName, String attribute, String query, int skip, int limit, String index, Class<?> clazz)` This will find all documents from the collection that match the fulltext query specified in query.
`<T> DocumentResultEntity<T>`	`executeSimpleLast(String collectionName, Integer count, Class<?> clazz)` This will return the last document(s) from the collection, in the order of insertion/update time.
`<T> CursorEntity<T>`	`executeSimpleRange(String collectionName, String attribute, Object left, Object right, Boolean closed, int skip, int limit, Class<?> clazz)` This will find all documents within a given range.
`<T> CursorEntity<DocumentEntity<T>>`	`executeSimpleRangeWithDocument(String collectionName, String attribute, Object left, Object right, Boolean closed, int skip, int limit, Class<?> clazz)` This will find all documents within a given range.
`<T> CursorResultSet<DocumentEntity<T>>`	`executeSimpleRangeWithDocumentResultSet(String collectionName, String attribute, Object left, Object right, Boolean closed, int skip, int limit, Class<?> clazz)` This will find all documents within a given range.
`<T> CursorResultSet<T>`	`executeSimpleRangeWithResultSet(String collectionName, String attribute, Object left, Object right, Boolean closed, int skip, int limit, Class<?> clazz)` This will find all documents within a given range.
`SimpleByResultEntity`	`executeSimpleRemoveByExample(String collectionName, Map<String,Object> example, Boolean waitForSync, Integer limit)` This will remove all documents in the collection that match the specified example object.
`SimpleByResultEntity`	`executeSimpleReplaceByExample(String collectionName, Map<String,Object> example, Map<String,Object> newValue, Boolean waitForSync, Integer limit)` This will replace all documents in the collection that match the specified example object.
`SimpleByResultEntity`	`executeSimpleUpdateByExample(String collectionName, Map<String,Object> example, Map<String,Object> newValue, Boolean keepNull, Boolean waitForSync, Integer limit)` This will update all documents in the collection that match the specified example object.
`TransactionResultEntity`	`executeTransaction(TransactionEntity transactionEntity)` Executes the transaction on the database server.
`DefaultEntity`	`finishQuery(long cursorId)` Deletes a cursor from the database.
`AqlFunctionsEntity`	`getAqlFunctions(String namespace)` Gets all AQL functions whithin a given namespace
`<T> T`	`getBatchResponseByRequestId(String requestId)` This method returns the result of a call to ArangoDB executed within a batch request.
`CollectionEntity`	`getCollection(long id)` Returns a collection from ArangoDB by id
`CollectionEntity`	`getCollection(String name)` Returns a collection from ArangoDB by name
`CollectionEntity`	`getCollectionChecksum(String name, Boolean withRevisions, Boolean withData)` Returns a collection from ArangoDB by name including the collection checksum
`CollectionEntity`	`getCollectionCount(long id)` Returns a collection from ArangoDB by id including the document count
`CollectionEntity`	`getCollectionCount(String name)` Returns a collection from ArangoDB by name including the document count
`CollectionEntity`	`getCollectionFigures(long id)` Returns a collection from ArangoDB by id including the collection figures
`CollectionEntity`	`getCollectionFigures(String name)` Returns a collection from ArangoDB by name including the collection figures
`CollectionEntity`	`getCollectionProperties(long id)` Returns a collection from ArangoDB including all properties by id
`CollectionEntity`	`getCollectionProperties(String name)` Returns a collection from ArangoDB including all properties by name
`CollectionEntity`	`getCollectionRevision(long id)` Returns a collection from ArangoDB including revision by id
`CollectionEntity`	`getCollectionRevision(String name)` Returns a collection from ArangoDB including revision by name
`CollectionsEntity`	`getCollections()` Returns all collections from ArangoDB
`CollectionsEntity`	`getCollections(Boolean excludeSystem)` Returns all collections from ArangoDB
`DatabaseEntity`	`getCurrentDatabase()` Returns the current database
`StringsResultEntity`	`getDatabases()` Returns all databases
`StringsResultEntity`	`getDatabases(boolean currentUserAccessableOnly)` Returns all databases
`StringsResultEntity`	`getDatabases(String username, String password)` Returns all databases the user identified by his credentials can access
`String`	`getDefaultDatabase()` Returns the default database.
`<T> DocumentEntity<T>`	`getDocument(long collectionId, long documentId, Class<?> clazz)` Returns a document entity.
`<T> DocumentEntity<T>`	`getDocument(long collectionId, String documentKey, Class<?> clazz)` Returns a document entity.
`<T> DocumentEntity<T>`	`getDocument(String documentHandle, Class<?> clazz)` Returns a document entity.
`<T> DocumentEntity<T>`	`getDocument(String documentHandle, Class<?> clazz, Long ifNoneMatchRevision, Long ifMatchRevision)` Returns a document entity.
`<T> DocumentEntity<T>`	`getDocument(String collectionName, long documentId, Class<?> clazz)` Returns a document entity.
`<T> DocumentEntity<T>`	`getDocument(String collectionName, String documentKey, Class<?> clazz)` Returns a document entity.
`List<String>`	`getDocuments(long collectionId)` This method returns all document handles from a collection.
`List<String>`	`getDocuments(long collectionId, boolean handleConvert)` This method returns all document handles from a collection.
`List<String>`	`getDocuments(String collectionName)` This method returns all document handles from a collection.
`List<String>`	`getDocuments(String collectionName, boolean handleConvert)` This method returns all document handles from a collection.
`List<Endpoint>`	`getEndpoints()` This method returns all endpoints.
`GraphEntity`	`getGraph(String graphName)` Get graph object by name, including its edge definitions and vertex collections.
`List<String>`	`getGraphList()` Creates a list of the names of all available graphs of the default database.
`GraphsEntity`	`getGraphs()` Returns a GraphsEntity containing all graph as GraphEntity object of the default database.
`IndexEntity`	`getIndex(String indexHandle)` Returns an index from a collection.
`IndexesEntity`	`getIndexes(long collectionId)` Returns all indices from a collection.
`IndexesEntity`	`getIndexes(String collectionName)` Returns all indices from a collection.
`List<String>`	`getJobIds()` Returns a list of all job ids of asynchronous executed jobs.
`<T> T`	`getJobResult(String jobId)` Returns the job result for a given job id.
`List<String>`	`getJobs(JobsEntity.JobState jobState)` Returns a list of all job ids of asynchronous executed jobs, filtered by job state.
`List<String>`	`getJobs(JobsEntity.JobState jobState, int count)` Returns a list of all job ids of asynchronous executed jobs, filtered by job state.
`String`	`getLastJobId()` Returns the id of the last asynchronous executed job.
`ReplicationApplierConfigEntity`	`getReplicationApplierConfig()` Returns the configuration of the replication applier.
`ReplicationApplierStateEntity`	`getReplicationApplierState()` Returns the state of the replication applier, regardless of whether the applier is currently running or not.
`<T> void`	`getReplicationDump(String collectionName, Long from, Long to, Integer chunkSize, Boolean ticks, Class<T> clazz, DumpHandler<T> handler)` Returns the data from the collection for the requested range.
`ReplicationInventoryEntity`	`getReplicationInventory()` Returns the list of collections and indexes available on the server.
`ReplicationInventoryEntity`	`getReplicationInventory(boolean includeSystem)` Returns the list of collections and indexes available on the server.
`ReplicationLoggerConfigEntity`	`getReplicationLoggerConfig()` Returns the configuration of the replication logger
`ReplicationLoggerStateEntity`	`getReplicationLoggerState()` Returns the current state of the server's replication logger.
`String`	`getReplicationServerId()` Returns the servers id.
`AdminLogEntity`	`getServerLog(Integer logLevel, Boolean logLevelUpTo, Integer start, Integer size, Integer offset, Boolean sortAsc, String text)` Returns the server log, for the parameters logLevel and logLevelUpTo please note the following: fatal or 0 error or 1 warning or 2 info or 3 debug or 4 The default value is info.
`StatisticsEntity`	`getStatistics()` Returns the current statistics
`StatisticsDescriptionEntity`	`getStatisticsDescription()` Returns the statistics description
`ArangoUnixTime`	`getTime()` Returns the current server time
`UserEntity`	`getUser(String username)` Returns a database user.
`List<UserEntity>`	`getUsers()` Returns all database user.
`List<DocumentEntity<UserEntity>>`	`getUsersDocument()` Returns all database user as document.
`ArangoVersion`	`getVersion()` Returns the database version
`<T> EdgeEntity<T>`	`graphCreateEdge(String graphName, String edgeCollectionName, String fromHandle, String toHandle, Object value, Boolean waitForSync)` Stores a new edge with the information contained within the body into the given collection.
`<T> EdgeEntity<T>`	`graphCreateEdge(String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle)` Stores a new edge with the information contained within the body into the given collection.
`<T> EdgeEntity<T>`	`graphCreateEdge(String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle, Object value, Boolean waitForSync)` Stores a new edge with the information contained within the body into the given collection.
`GraphEntity`	`graphCreateEdgeDefinition(String graphName, EdgeDefinitionEntity edgeDefinition)` Adds a new edge definition to an existing graph
`<T> DocumentEntity<T>`	`graphCreateVertex(String graphName, String collectionName, T vertex, Boolean waitForSync)` Stores a new vertex with the information contained within the document into the given collection.
`GraphEntity`	`graphCreateVertexCollection(String graphName, String collectionName)` Creates a vertex collection
`DeletedEntity`	`graphDeleteEdge(String graphName, String edgeCollectionName, String key)` Deletes an edge with the given id, if it is contained within the graph.
`DeletedEntity`	`graphDeleteEdge(String graphName, String edgeCollectionName, String key, Boolean waitForSync)` Deletes an edge with the given id, if it is contained within the graph.
`DeletedEntity`	`graphDeleteEdge(String graphName, String edgeCollectionName, String key, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision)` Deletes an edge with the given id, if it is contained within the graph.
`GraphEntity`	`graphDeleteEdgeDefinition(String graphName, String edgeCollectionName, Boolean dropCollection)` Removes an existing edge definition from this graph.
`DeletedEntity`	`graphDeleteVertex(String graphName, String collectionName, String key)` Deletes a vertex with the given key, if it is contained within the graph.
`DeletedEntity`	`graphDeleteVertex(String graphName, String collectionName, String key, Boolean waitForSync)` Deletes a vertex with the given key, if it is contained within the graph.
`DeletedEntity`	`graphDeleteVertex(String graphName, String collectionName, String key, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision)` Deletes a vertex with the given key, if it is contained within the graph.
`DeletedEntity`	`graphDeleteVertexCollection(String graphName, String collectionName, Boolean dropCollection)` Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph.
`<T> EdgeEntity<T>`	`graphGetEdge(String graphName, String edgeCollectionName, String key, Class<?> clazz)` Loads an edge with the given key if it is contained within your graph.
`<T> EdgeEntity<T>`	`graphGetEdge(String graphName, String edgeCollectionName, String key, Class<?> clazz, Long ifMatchRevision, Long ifNoneMatchRevision)` Loads an edge with the given key if it is contained within your graph.
`List<String>`	`graphGetEdgeCollections(String graphName)` Returns a list of all edge collection of a graph that are defined in the graphs edgeDefinitions
`CursorEntity<PlainEdgeEntity>`	`graphGetEdges(String graphName)` Returns all Edges of a graph, each edge as a PlainEdgeEntity.
`<T> CursorEntity<T>`	`graphGetEdges(String graphName, Class<T> clazz, String vertexDocumentHandle)` Returns all Edges of a given vertex.
`<T> CursorEntity<T>`	`graphGetEdgesByExampleMap(String graphName, Class<T> clazzT, Map<String,Object> vertexExample)` Returns all Edges of vertices matching the map.
`<T,S> CursorEntity<T>`	`graphGetEdgesByExampleObject(String graphName, Class<T> clazzT, S vertexExample)` Returns all Edges of vertices matching the example object (non-primitive set to null will not be used for comparing).
`<T> DocumentEntity<T>`	`graphGetVertex(String graphName, String collectionName, String key, Class<?> clazz)` Gets a vertex with the given key if it is contained within your graph.
`<T> DocumentEntity<T>`	`graphGetVertex(String graphName, String collectionName, String key, Class<?> clazz, Long ifNoneMatchRevision, Long ifMatchRevision)` Gets a vertex with the given key if it is contained within your graph.
`List<String>`	`graphGetVertexCollections(String graphName)` Returns a list of all vertex collection of a graph that are defined in the graphs edgeDefinitions (in "from", "to", and "orphanCollections")
`<T> EdgeEntity<T>`	`graphReplaceEdge(String graphName, String edgeCollectionName, String key, Object value)` Replaces an edge with the given key by the content in the body.
`<T> EdgeEntity<T>`	`graphReplaceEdge(String graphName, String edgeCollectionName, String key, Object value, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision)` Replaces an edge with the given key by the content in the body.
`GraphEntity`	`graphReplaceEdgeDefinition(String graphName, String edgeCollectionName, EdgeDefinitionEntity edgeDefinition)` Replaces an existing edge definition to an existing graph.
`<T> DocumentEntity<T>`	`graphReplaceVertex(String graphName, String collectionName, String key, Object vertex)` Replaces a vertex with the given key by the content in the body.
`<T> DocumentEntity<T>`	`graphReplaceVertex(String graphName, String collectionName, String key, Object vertex, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision)` Replaces a vertex with the given key by the content in the body.
`<T> EdgeEntity<T>`	`graphUpdateEdge(String graphName, String edgeCollectionName, String key, Object value, Boolean keepNull)` Updates an edge with the given key by adding the content in the body.
`<T> EdgeEntity<T>`	`graphUpdateEdge(String graphName, String edgeCollectionName, String key, Object value, Boolean waitForSync, Boolean keepNull, Long ifMatchRevision, Long ifNoneMatchRevision)` Updates an edge with the given key by adding the content in the body.
`<T> DocumentEntity<T>`	`graphUpdateVertex(String graphName, String collectionName, String key, Object vertex, Boolean keepNull)` Updates a vertex with the given key by adding the content in the body.
`<T> DocumentEntity<T>`	`graphUpdateVertex(String graphName, String collectionName, String key, Object vertex, Boolean keepNull, Boolean waitForSync, Long ifMatchRevision, Long ifNoneMatchRevision)` Updates a vertex with the given key by adding the content in the body.
`ImportResultEntity`	`importDocuments(String collection, Boolean createCollection, Collection<?> values)` Creates documents in the collection.
`ImportResultEntity`	`importDocumentsByHeaderValues(String collection, Boolean createCollection, Collection<? extends Collection<?>> headerValues)` Creates documents in the collection.
`CollectionEntity`	`loadCollection(long id)` Returns the collection and loads it into memory.
`CollectionEntity`	`loadCollection(long id, Boolean count)` Returns the collection and loads it into memory.
`CollectionEntity`	`loadCollection(String name)` Returns the collection and loads it into memory.
`CollectionEntity`	`loadCollection(String name, Boolean count)` Returns the collection and loads it into memory.
`DefaultEntity`	`reloadRouting()` Triggers the routes reloading in ArangoDB
`CollectionEntity`	`renameCollection(long id, String newName)` Returns the collection and changes it's name.
`CollectionEntity`	`renameCollection(String name, String newName)` Returns the collection and changes it's name.
`DocumentEntity<?>`	`replaceDocument(long collectionId, long documentId, Object value)` This method replaces the content of the document defined by documentId.
`DocumentEntity<?>`	`replaceDocument(long collectionId, long documentId, Object value, Long rev, Policy policy, Boolean waitForSync)` This method replaces the content of the document defined by documentId.
`DocumentEntity<?>`	`replaceDocument(long collectionId, String documentKey, Object value)` This method replaces the content of the document defined by documentKey.
`DocumentEntity<?>`	`replaceDocument(long collectionId, String documentKey, Object value, Long rev, Policy policy, Boolean waitForSync)` This method replaces the content of the document defined by documentKey.
`DocumentEntity<?>`	`replaceDocument(String collectionName, long documentId, Object value)` This method replaces the content of the document defined by documentId.
`DocumentEntity<?>`	`replaceDocument(String collectionName, long documentId, Object value, Long rev, Policy policy, Boolean waitForSync)` This method replaces the content of the document defined by documentId.
`<T> DocumentEntity<T>`	`replaceDocument(String documentHandle, Object value)` This method replaces the content of the document defined by documentHandle.
`<T> DocumentEntity<T>`	`replaceDocument(String documentHandle, Object value, Long rev, Policy policy, Boolean waitForSync)` This method replaces the content of the document defined by documentHandle.
`DocumentEntity<?>`	`replaceDocument(String collectionName, String documentKey, Object value)` This method replaces the content of the document defined by documentKey.
`DocumentEntity<?>`	`replaceDocument(String collectionName, String documentKey, Object value, Long rev, Policy policy, Boolean waitForSync)` This method replaces the content of the document defined by documentKey.
`DefaultEntity`	`replaceUser(String username, String passwd, Boolean active, Map<String,Object> extra)` Replaces the data of a database user.
`CollectionEntity`	`setCollectionProperties(long id, Boolean newWaitForSync, Long journalSize)` Returns the collection and changes it's journalSize and waitForSync.
`CollectionEntity`	`setCollectionProperties(String name, Boolean newWaitForSync, Long journalSize)` Returns the collection and changes it's journalSize and waitForSync.
`void`	`setDefaultDatabase(String database)` Sets the default database.
`ReplicationApplierConfigEntity`	`setReplicationApplierConfig(ReplicationApplierConfigEntity replicationApplierConfigEntity)` Sets the configuration of the replication applier.
`ReplicationApplierConfigEntity`	`setReplicationApplierConfig(String endpoint, String database, String username, String password, Integer maxConnectRetries, Integer connectTimeout, Integer requestTimeout, Integer chunkSize, Boolean autoStart, Boolean adaptivePolling)` Sets the configuration of the replication applier.
`ReplicationLoggerConfigEntity`	`setReplicationLoggerConfig(Boolean autoStart, Boolean logRemoteChanges, Long maxEvents, Long maxEventsSize)` Sets the replication logger configuration
`void`	`startAsyncMode(boolean fireAndForget)` This method sets the driver to asynchronous execution.
`void`	`startBatchMode()` This method enables batch execution.
`ReplicationApplierStateEntity`	`startReplicationApplier(Long from)` Starts the replication applier.
`boolean`	`startReplicationLogger()` Starts the replication logger
`void`	`stopAsyncMode()` This method sets the driver back to synchronous execution.
`ReplicationApplierStateEntity`	`stopReplicationApplier()` Stops the replication applier.
`boolean`	`stopReplicationLogger()` Stops the replication logger
`ReplicationSyncEntity`	`syncReplication(String endpoint, String database, String username, String password, RestrictType restrictType, String... restrictCollections)` Starts a full data synchronization from a remote endpoint into the local ArangoDB database.
`CollectionEntity`	`truncateCollection(long id)` Returns the collection and deletes all documents.
`CollectionEntity`	`truncateCollection(String name)` Returns the collection and deletes all documents.
`CollectionEntity`	`unloadCollection(long id)` Returns the collection and deletes it from memory.
`CollectionEntity`	`unloadCollection(String name)` Returns the collection and deletes it from memory.
`DocumentEntity<?>`	`updateDocument(long collectionId, long documentId, Object value)` This method updates a document defined by documentId.
`DocumentEntity<?>`	`updateDocument(long collectionId, long documentId, Object value, Boolean keepNull)` This method updates a document defined by documentId.
`DocumentEntity<?>`	`updateDocument(long collectionId, long documentId, Object value, Long rev, Policy policy, Boolean waitForSync, Boolean keepNull)` This method updates a document defined by documentId.
`DocumentEntity<?>`	`updateDocument(long collectionId, String documentKey, Object value)` This method updates a document defined by documentKey.
`DocumentEntity<?>`	`updateDocument(long collectionId, String documentKey, Object value, Boolean keepNull)` This method updates a document defined by documentKey.
`DocumentEntity<?>`	`updateDocument(long collectionId, String documentKey, Object value, Long rev, Policy policy, Boolean waitForSync, Boolean keepNull)` This method updates a document defined by documentKey.
`DocumentEntity<?>`	`updateDocument(String collectionName, long documentId, Object value)` This method updates a document defined by documentId.
`DocumentEntity<?>`	`updateDocument(String collectionName, long documentId, Object value, Boolean keepNull)` This method updates a document defined by documentId.
`DocumentEntity<?>`	`updateDocument(String collectionName, long documentId, Object value, Long rev, Policy policy, Boolean waitForSync, Boolean keepNull)` This method updates a document defined by documentId.
`<T> DocumentEntity<T>`	`updateDocument(String documentHandle, Object value)` This method updates a document defined by documentHandle.
`<T> DocumentEntity<T>`	`updateDocument(String documentHandle, Object value, Boolean keepNull)` This method updates a document defined by documentKey.
`<T> DocumentEntity<T>`	`updateDocument(String documentHandle, Object value, Long rev, Policy policy, Boolean waitForSync, Boolean keepNull)` This method updates a document defined by documentHandle.
`DocumentEntity<?>`	`updateDocument(String collectionName, String documentKey, Object value)` This method updates a document defined by documentKey.
`DocumentEntity<?>`	`updateDocument(String collectionName, String documentKey, Object value, Boolean keepNull)` This method updates a document defined by documentKey.
`DocumentEntity<?>`	`updateDocument(String collectionName, String documentKey, Object value, Long rev, Policy policy, Boolean waitForSync, Boolean keepNull)` This method updates a document defined by documentKey.
`DefaultEntity`	`updateUser(String username, String passwd, Boolean active, Map<String,Object> extra)` Updates the data of a database user.
`CursorEntity<?>`	`validateQuery(String query)` This method validates a given AQL query string and returns a CursorEntity

Methods inherited from class com.arangodb.BaseArangoDriver
createDocumentHandle, createDocumentHandle, createEndpointUrl, createEntity, createEntity, createEntity, createEntity, createEntityImpl, setKeyValueHeader, setStatusCode, toReplicationDumpHeader, validate, validateCollectionName, validateDatabaseName, validateDocumentHandle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ArangoDriver
```
public ArangoDriver(ArangoConfigure configure)
```
  Constructor to create an instance of the driver that uses the default database.
  
  Parameters:
  
  ArangoConfigure - configure - A configuration object.
- ArangoDriver
```
public ArangoDriver(ArangoConfigure configure,
                    String database)
```
  Constructor to create an instance of the driver that uses the provided database.
  
  Parameters:
  
  ArangoConfigure - configure - A configuration object.
  
  String - database - the database that will be used.

Method Detail

startBatchMode
```
public void startBatchMode()
                    throws ArangoException
```
This method enables batch execution. Until 'cancelBatchMode' or 'executeBatch' is called every other call is stacked and will be either executed or discarded when the batch mode is canceled. Each call will return a 'requestId' in the http response, that can be used to select the matching result from the batch execution.

Throws:

ArangoException

See Also:

cancelBatchMode(), executeBatch(), getBatchResponseByRequestId(String)

startAsyncMode
```
public void startAsyncMode(boolean fireAndForget)
                    throws ArangoException
```
This method sets the driver to asynchronous execution. If the parameter 'fireAndforget' is set to true each call to ArangoDB will be send without a return value. If set to false the return value will be the 'job id'. Each job result can be received by the method 'getJobResult'.

Parameters:

boolean - fireAndForget - if set to true the asynchronous mode is set to 'fire and forget'.

Throws:

ArangoException

See Also:

stopAsyncMode(), getJobResult(String), getJobs(com.arangodb.entity.JobsEntity.JobState, int), deleteExpiredJobs(int), getLastJobId()

stopAsyncMode
```
public void stopAsyncMode()
                   throws ArangoException
```
This method sets the driver back to synchronous execution.

Throws:

ArangoException

See Also:

startAsyncMode(boolean), getJobResult(String), getJobs(com.arangodb.entity.JobsEntity.JobState, int), deleteExpiredJobs(int), getLastJobId()

getLastJobId
```
public String getLastJobId()
```
Returns the id of the last asynchronous executed job.

Returns:

String

See Also:

startAsyncMode(boolean), stopAsyncMode(), getJobResult(String), getJobs(com.arangodb.entity.JobsEntity.JobState, int), deleteExpiredJobs(int), getLastJobId()

getJobIds
```
public List<String> getJobIds()
```
Returns a list of all job ids of asynchronous executed jobs.

Returns:

List

See Also:

startAsyncMode(boolean), stopAsyncMode(), getJobResult(String), getJobs(com.arangodb.entity.JobsEntity.JobState, int), deleteExpiredJobs(int), getLastJobId()

getJobs
```
public List<String> getJobs(JobsEntity.JobState jobState,
                            int count)
                     throws ArangoException
```
Returns a list of all job ids of asynchronous executed jobs, filtered by job state.

Parameters:

JobsEntity - .JobState jobState - the job state as a filter.

int - count - a limit for the result set.

Returns:

List

Throws:

ArangoException

See Also:

startAsyncMode(boolean), stopAsyncMode(), getJobResult(String), getJobIds(), deleteExpiredJobs(int), getLastJobId()

getJobs
```
public List<String> getJobs(JobsEntity.JobState jobState)
                     throws ArangoException
```
Returns a list of all job ids of asynchronous executed jobs, filtered by job state.

Parameters:

JobsEntity - .JobState jobState - the job state as a filter.

Returns:

List

Throws:

ArangoException

See Also:

startAsyncMode(boolean), stopAsyncMode(), getJobResult(String), getJobIds(), deleteExpiredJobs(int), getLastJobId()

deleteAllJobs
```
public void deleteAllJobs()
                   throws ArangoException
```
Deletes all job from ArangoDB.

Throws:

ArangoException

See Also:

startAsyncMode(boolean), stopAsyncMode(), getJobResult(String), getJobIds(), deleteExpiredJobs(int), getLastJobId()

deleteJobById
```
public void deleteJobById(String JobId)
                   throws ArangoException
```
Deletes a job from ArangoDB.

Parameters:

String - jobId - the id of the job

Throws:

ArangoException

See Also:

startAsyncMode(boolean), stopAsyncMode(), getJobResult(String), getJobIds(), deleteExpiredJobs(int), getLastJobId()

deleteExpiredJobs
```
public void deleteExpiredJobs(int timeStamp)
                       throws ArangoException
```
Deletes all jobs by a provided expiration date.

Parameters:

int - timeStamp - a unix timestamp, every older job is deleted.

Throws:

ArangoException

See Also:

startAsyncMode(boolean), stopAsyncMode(), getJobResult(String), getJobIds(), deleteExpiredJobs(int), getLastJobId()

getJobResult
```
public <T> T getJobResult(String jobId)
                   throws ArangoException
```
Returns the job result for a given job id.

Parameters:

String - jobId - the job id.

Returns:

- A generic return value, containing the job result

Throws:

ArangoException

See Also:

startAsyncMode(boolean), stopAsyncMode(), getJobResult(String), getJobIds(), deleteExpiredJobs(int), getLastJobId()

executeBatch
```
public DefaultEntity executeBatch()
                           throws ArangoException
```
This method sends all stacked requests as batch to ArangoDB.

Throws:

ArangoException

See Also:

startBatchMode(), cancelBatchMode()

getBatchResponseByRequestId
```
public <T> T getBatchResponseByRequestId(String requestId)
                                  throws ArangoException
```
This method returns the result of a call to ArangoDB executed within a batch request.

Parameters:

String - requestId - the id of a request.

Returns:

- A generic return value, containing the result.

Throws:

ArangoException

See Also:

startBatchMode(), executeBatch(), cancelBatchMode()

cancelBatchMode
```
public void cancelBatchMode()
                     throws ArangoException
```
This method cancels the batch execution mode. All stacked calls are discarded.

Throws:

ArangoException

See Also:

startBatchMode(), executeBatch()

getDefaultDatabase
```
public String getDefaultDatabase()
```
Returns the default database.

Returns:

String

setDefaultDatabase
```
public void setDefaultDatabase(String database)
```
Sets the default database.

Parameters:

database -

createCollection
```
public CollectionEntity createCollection(String name)
                                  throws ArangoException
```
Creates a new collection.

Parameters:

name - - the name of the collection

Returns:

CollectionEntity - the created collectionEntity.

Throws:

ArangoException

createCollection

public CollectionEntity createCollection(String name,
                                         CollectionOptions collectionOptions)
                                  throws ArangoException

Creates a new collection.

Parameters:: name - - the name of the collection; collectionOptions - - an object containing the various options.
Returns:: CollectionEntity - the created collectionEntity.
Throws:: ArangoException

getCollection
```
public CollectionEntity getCollection(long id)
                               throws ArangoException
```
Returns a collection from ArangoDB by id

Parameters:

id - - the id of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollection
```
public CollectionEntity getCollection(String name)
                               throws ArangoException
```
Returns a collection from ArangoDB by name

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionProperties
```
public CollectionEntity getCollectionProperties(long id)
                                         throws ArangoException
```
Returns a collection from ArangoDB including all properties by id

Parameters:

id - - the id of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionProperties
```
public CollectionEntity getCollectionProperties(String name)
                                         throws ArangoException
```
Returns a collection from ArangoDB including all properties by name

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionRevision
```
public CollectionEntity getCollectionRevision(long id)
                                       throws ArangoException
```
Returns a collection from ArangoDB including revision by id

Parameters:

name - - the id of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionRevision
```
public CollectionEntity getCollectionRevision(String name)
                                       throws ArangoException
```
Returns a collection from ArangoDB including revision by name

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionCount
```
public CollectionEntity getCollectionCount(long id)
                                    throws ArangoException
```
Returns a collection from ArangoDB by id including the document count

Parameters:

id - - the id of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionCount
```
public CollectionEntity getCollectionCount(String name)
                                    throws ArangoException
```
Returns a collection from ArangoDB by name including the document count

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionFigures
```
public CollectionEntity getCollectionFigures(long id)
                                      throws ArangoException
```
Returns a collection from ArangoDB by id including the collection figures

Parameters:

id - - the id of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionFigures
```
public CollectionEntity getCollectionFigures(String name)
                                      throws ArangoException
```
Returns a collection from ArangoDB by name including the collection figures

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the requested collectionEntity.

Throws:

ArangoException

getCollectionChecksum

public CollectionEntity getCollectionChecksum(String name,
                                              Boolean withRevisions,
                                              Boolean withData)
                                       throws ArangoException

Returns a collection from ArangoDB by name including the collection checksum

Parameters:: name - - the id of the collection.
Returns:: CollectionEntity - the requested collectionEntity.
Throws:: ArangoException

getCollections
```
public CollectionsEntity getCollections()
                                 throws ArangoException
```
Returns all collections from ArangoDB

Returns:

CollectionsEntity - the CollectionsEntity.

Throws:

ArangoException

getCollections
```
public CollectionsEntity getCollections(Boolean excludeSystem)
                                 throws ArangoException
```
Returns all collections from ArangoDB

Parameters:

excludeSystem - - if set to true system collections will not be added to the result

Returns:

CollectionsEntity - the CollectionsEntity.

Throws:

ArangoException

loadCollection
```
public CollectionEntity loadCollection(long id)
                                throws ArangoException
```
Returns the collection and loads it into memory.

Parameters:

id - - the id of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

loadCollection
```
public CollectionEntity loadCollection(String name)
                                throws ArangoException
```
Returns the collection and loads it into memory.

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

loadCollection
```
public CollectionEntity loadCollection(long id,
                                       Boolean count)
                                throws ArangoException
```
Returns the collection and loads it into memory.

Parameters:

id - - the id of the collection.

count - - if set to true the documents count is returned.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

loadCollection
```
public CollectionEntity loadCollection(String name,
                                       Boolean count)
                                throws ArangoException
```
Returns the collection and loads it into memory.

Parameters:

name - - the name of the collection.

count - - if set to true the documents count is returned.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

unloadCollection
```
public CollectionEntity unloadCollection(long id)
                                  throws ArangoException
```
Returns the collection and deletes it from memory.

Parameters:

id - - the id of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

unloadCollection
```
public CollectionEntity unloadCollection(String name)
                                  throws ArangoException
```
Returns the collection and deletes it from memory.

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

truncateCollection
```
public CollectionEntity truncateCollection(long id)
                                    throws ArangoException
```
Returns the collection and deletes all documents.

Parameters:

id - - the id of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

truncateCollection
```
public CollectionEntity truncateCollection(String name)
                                    throws ArangoException
```
Returns the collection and deletes all documents.

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

setCollectionProperties

public CollectionEntity setCollectionProperties(long id,
                                                Boolean newWaitForSync,
                                                Long journalSize)
                                         throws ArangoException

Returns the collection and changes it's journalSize and waitForSync.

Parameters:: id - - the id of the collection.; newWaitForSync - - a new value for the waitForSyncProperty; journalSize - - a new value for the collections journalSize
Returns:: CollectionEntity - the collectionEntity.
Throws:: ArangoException

setCollectionProperties

public CollectionEntity setCollectionProperties(String name,
                                                Boolean newWaitForSync,
                                                Long journalSize)
                                         throws ArangoException

Returns the collection and changes it's journalSize and waitForSync.

Parameters:: name - - the name of the collection.; newWaitForSync - - a new value for the waitForSyncProperty; journalSize - - a new value for the collections journalSize
Returns:: CollectionEntity - the collectionEntity.
Throws:: ArangoException

renameCollection

public CollectionEntity renameCollection(long id,
                                         String newName)
                                  throws ArangoException

Returns the collection and changes it's name.

Parameters:: id - - the id of the collection.; newName - - the new name for the collection
Returns:: CollectionEntity - the collectionEntity.
Throws:: ArangoException

renameCollection

public CollectionEntity renameCollection(String name,
                                         String newName)
                                  throws ArangoException

Returns the collection and changes it's name.

Parameters:: name - - the name of the collection.; newName - - the new name for the collection
Returns:: CollectionEntity - the collectionEntity.
Throws:: ArangoException

deleteCollection
```
public CollectionEntity deleteCollection(long id)
                                  throws ArangoException
```
Deletes a collection by id.

Parameters:

id - - the id of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

deleteCollection
```
public CollectionEntity deleteCollection(String name)
                                  throws ArangoException
```
Deletes a collection by name.

Parameters:

name - - the name of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

createDocument
```
public DocumentEntity<?> createDocument(long collectionId,
                                        Object value)
                                 throws ArangoException
```
Creates a document in the collection defined by The collection id

Parameters:

collectionId - - The id of the collection

value - - An object containing the documents attributes

Returns:

DocumentEntity

Throws:

ArangoException

createDocument

public <T> DocumentEntity<T> createDocument(String collectionName,
                                            Object value)
                                     throws ArangoException

Creates a document in the collection defined by the collection's name

Parameters:: collectionName - - The name of the collection; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

createDocument
```
public DocumentEntity<?> createDocument(long collectionId,
                                        String documentKey,
                                        Object value)
                                 throws ArangoException
```
Creates a document in the collection defined by the collection's name. This method allows to define to documents key. Note that the collection's property CollectionKeyOption.allowUserKeys has to be set accordingly.

Parameters:

collectionId - - The id of the collection

documentKey - - the desired document key

value - - An object containing the documents attributes

Returns:

DocumentEntity

Throws:

ArangoException

See Also:

CollectionKeyOption.allowUserKeys

createDocument
```
public <T> DocumentEntity<T> createDocument(String collectionName,
                                            String documentKey,
                                            Object value)
                                     throws ArangoException
```
Creates a document in the collection defined by the collection's name. This method allows to define to documents key. Note that the collection's property CollectionKeyOption.allowUserKeys has to be set accordingly.

Parameters:

collectionName - - The name of the collection

documentKey - - the desired document key

value - - An object containing the documents attributes

Returns:

DocumentEntity

Throws:

ArangoException

See Also:

CollectionKeyOption.allowUserKeys

createDocument
```
public DocumentEntity<?> createDocument(long collectionId,
                                        Object value,
                                        Boolean createCollection,
                                        Boolean waitForSync)
                                 throws ArangoException
```
Creates a document in the collection defined by The collection id.

Parameters:

collectionId - - The id of the collection

value - - An object containing the documents attributes

createCollection - - if set to true the collection is created if it does not exist

waitForSync - - if set to true the response is returned when the server has finished.

Returns:

DocumentEntity

Throws:

ArangoException

See Also:

CollectionKeyOption.allowUserKeys

createDocument

public <T> DocumentEntity<T> createDocument(String collectionName,
                                            Object value,
                                            Boolean createCollection,
                                            Boolean waitForSync)
                                     throws ArangoException

Creates a document in the collection defined by the collection's name.

Parameters:: collectionName - - The name of the collection; value - - An object containing the documents attributes; createCollection - - if set to true the collection is created if it does not exist; waitForSync - - if set to true the response is returned when the server has finished.
Returns:: DocumentEntity
Throws:: ArangoException
See Also:: CollectionKeyOption.allowUserKeys

createDocument
```
public DocumentEntity<?> createDocument(long collectionId,
                                        String documentKey,
                                        Object value,
                                        Boolean createCollection,
                                        Boolean waitForSync)
                                 throws ArangoException
```
Creates a document in the collection defined by the collection's id. This method allows to define to documents key. Note that the collection's property CollectionKeyOption.allowUserKeys has to be set accordingly.

Parameters:

collectionId - - The id of the collection

documentKey - - the desired document key

value - - An object containing the documents attributes

createCollection - - if set to true the collection is created if it does not exist

waitForSync - - if set to true the response is returned when the server has finished.

Returns:

DocumentEntity

Throws:

ArangoException

See Also:

CollectionKeyOption.allowUserKeys

createDocument
```
public <T> DocumentEntity<T> createDocument(String collectionName,
                                            String documentKey,
                                            Object value,
                                            Boolean createCollection,
                                            Boolean waitForSync)
                                     throws ArangoException
```
Creates a document in the collection defined by the collection's name. This method allows to define to documents key. Note that the collection's property CollectionKeyOption.allowUserKeys has to be set accordingly.

Parameters:

collectionName - - The name of the collection

documentKey - - the desired document key

value - - An object containing the documents attributes

createCollection - - if set to true the collection is created if it does not exist

waitForSync - - if set to true the response is returned when the server has finished.

Returns:

DocumentEntity

Throws:

ArangoException

See Also:

CollectionKeyOption.allowUserKeys

replaceDocument

public DocumentEntity<?> replaceDocument(long collectionId,
                                         long documentId,
                                         Object value)
                                  throws ArangoException

This method replaces the content of the document defined by documentId.

Parameters:: collectionId - - The collection's id.; documentId - - The document's id.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

replaceDocument

public DocumentEntity<?> replaceDocument(String collectionName,
                                         long documentId,
                                         Object value)
                                  throws ArangoException

This method replaces the content of the document defined by documentId.

Parameters:: collectionName - - The collection's name.; documentId - - The document's id.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

replaceDocument

public DocumentEntity<?> replaceDocument(long collectionId,
                                         String documentKey,
                                         Object value)
                                  throws ArangoException

This method replaces the content of the document defined by documentKey.

Parameters:: collectionId - - The collection's id.; documentKey - - The document's key.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

replaceDocument

public DocumentEntity<?> replaceDocument(String collectionName,
                                         String documentKey,
                                         Object value)
                                  throws ArangoException

This method replaces the content of the document defined by documentKey.

Parameters:: collectionName - - The collection's name.; documentKey - - The document's key.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

replaceDocument

public <T> DocumentEntity<T> replaceDocument(String documentHandle,
                                             Object value)
                                      throws ArangoException

This method replaces the content of the document defined by documentHandle.

Parameters:: documentHandle - - The document handle.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

replaceDocument
```
public DocumentEntity<?> replaceDocument(long collectionId,
                                         long documentId,
                                         Object value,
                                         Long rev,
                                         Policy policy,
                                         Boolean waitForSync)
                                  throws ArangoException
```
This method replaces the content of the document defined by documentId. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionId - - The collection's id.

documentId - - The document's id.

value - - An object containing the new attributes of the document.

rev - - the desired revision.

policy - - The update policy

waitForSync - - if set to true the response is returned when the server has finished.

Returns:

Throws:

ArangoException

replaceDocument
```
public DocumentEntity<?> replaceDocument(String collectionName,
                                         long documentId,
                                         Object value,
                                         Long rev,
                                         Policy policy,
                                         Boolean waitForSync)
                                  throws ArangoException
```
This method replaces the content of the document defined by documentId. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionName - - The collection's name.

documentId - - The document's id.

value - - An object containing the new attributes of the document.

rev - - the desired revision.

policy - - The update policy

waitForSync - - if set to true the response is returned when the server has finished.

Returns:

Throws:

ArangoException

replaceDocument
```
public DocumentEntity<?> replaceDocument(long collectionId,
                                         String documentKey,
                                         Object value,
                                         Long rev,
                                         Policy policy,
                                         Boolean waitForSync)
                                  throws ArangoException
```
This method replaces the content of the document defined by documentKey. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionId - - The collection's id.

documentKey - - The document's key.

value - - An object containing the new attributes of the document.

rev - - the desired revision.

policy - - The update policy

waitForSync - - if set to true the response is returned when the server has finished.

Returns:

Throws:

ArangoException

replaceDocument
```
public DocumentEntity<?> replaceDocument(String collectionName,
                                         String documentKey,
                                         Object value,
                                         Long rev,
                                         Policy policy,
                                         Boolean waitForSync)
                                  throws ArangoException
```
This method replaces the content of the document defined by documentKey. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionName - - The collection's name.

documentKey - - The document's key.

value - - An object containing the new attributes of the document.

rev - - the desired revision.

policy - - The update policy

waitForSync - - if set to true the response is returned when the server has finished.

Returns:

Throws:

ArangoException

replaceDocument
```
public <T> DocumentEntity<T> replaceDocument(String documentHandle,
                                             Object value,
                                             Long rev,
                                             Policy policy,
                                             Boolean waitForSync)
                                      throws ArangoException
```
This method replaces the content of the document defined by documentHandle. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

documentHandle - - The document's handle.

value - - An object containing the new attributes of the document.

rev - - the desired revision.

policy - - The update policy

waitForSync - - if set to true the response is returned when the server has finished.

Returns:

Throws:

ArangoException

updateDocument

public DocumentEntity<?> updateDocument(long collectionId,
                                        long documentId,
                                        Object value)
                                 throws ArangoException

This method updates a document defined by documentId.

Parameters:: collectionId - - The collection's id.; documentId - - The document's id.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public DocumentEntity<?> updateDocument(String collectionName,
                                        long documentId,
                                        Object value)
                                 throws ArangoException

This method updates a document defined by documentId.

Parameters:: collectionName - - The collection's name.; documentId - - The document's id.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public DocumentEntity<?> updateDocument(long collectionId,
                                        String documentKey,
                                        Object value)
                                 throws ArangoException

This method updates a document defined by documentKey.

Parameters:: collectionId - - The collection's id.; documentKey - - The document's key.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public DocumentEntity<?> updateDocument(String collectionName,
                                        String documentKey,
                                        Object value)
                                 throws ArangoException

This method updates a document defined by documentKey.

Parameters:: collectionName - - The collection's name.; documentKey - - The document's key.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public <T> DocumentEntity<T> updateDocument(String documentHandle,
                                            Object value)
                                     throws ArangoException

This method updates a document defined by documentHandle.

Parameters:: documentHandle - - The document's handle.; value - - An object containing the documents attributes
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public DocumentEntity<?> updateDocument(long collectionId,
                                        long documentId,
                                        Object value,
                                        Boolean keepNull)
                                 throws ArangoException

This method updates a document defined by documentId.

Parameters:: collectionId - - The collection id.; documentId - - The document id.; value - - An object containing the documents attributes; keepNull - - If true null values are kept.
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public DocumentEntity<?> updateDocument(String collectionName,
                                        long documentId,
                                        Object value,
                                        Boolean keepNull)
                                 throws ArangoException

This method updates a document defined by documentId.

Parameters:: collectionName - - The collection name.; documentId - - The document id.; value - - An object containing the documents attributes; keepNull - - If true null values are kept.
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public DocumentEntity<?> updateDocument(long collectionId,
                                        String documentKey,
                                        Object value,
                                        Boolean keepNull)
                                 throws ArangoException

This method updates a document defined by documentKey.

Parameters:: collectionId - - The collection id.; documentKey - - The document key.; value - - An object containing the documents attributes; keepNull - - If true null values are kept.
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public DocumentEntity<?> updateDocument(String collectionName,
                                        String documentKey,
                                        Object value,
                                        Boolean keepNull)
                                 throws ArangoException

This method updates a document defined by documentKey.

Parameters:: collectionName - - The collection name.; documentKey - - The document key.; value - - An object containing the documents attributes; keepNull - - If true null values are kept.
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public <T> DocumentEntity<T> updateDocument(String documentHandle,
                                            Object value,
                                            Boolean keepNull)
                                     throws ArangoException

This method updates a document defined by documentKey.

Parameters:: documentHandle - - The document handle.; value - - An object containing the documents attributes; keepNull - - If true null values are kept.
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument
```
public DocumentEntity<?> updateDocument(long collectionId,
                                        long documentId,
                                        Object value,
                                        Long rev,
                                        Policy policy,
                                        Boolean waitForSync,
                                        Boolean keepNull)
                                 throws ArangoException
```
This method updates a document defined by documentId. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionId - - The collection id.

documentId - - The document id.

value - - An object containing the documents attributes

rev - - The desired revision

policy - - The update policy

waitForSync - - if set to true the response is returned when the server has finished.

keepNull - - If true null values are kept.

Returns:

DocumentEntity

Throws:

ArangoException

updateDocument
```
public DocumentEntity<?> updateDocument(String collectionName,
                                        long documentId,
                                        Object value,
                                        Long rev,
                                        Policy policy,
                                        Boolean waitForSync,
                                        Boolean keepNull)
                                 throws ArangoException
```
This method updates a document defined by documentId. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionName - - The collection name.

documentId - - The document id.

value - - An object containing the documents attributes

rev - - The desired revision

policy - - The update policy

waitForSync - - if set to true the response is returned when the server has finished.

keepNull - - If true null values are kept.

Returns:

DocumentEntity

Throws:

ArangoException

updateDocument

public DocumentEntity<?> updateDocument(long collectionId,
                                        String documentKey,
                                        Object value,
                                        Long rev,
                                        Policy policy,
                                        Boolean waitForSync,
                                        Boolean keepNull)
                                 throws ArangoException

This method updates a document defined by documentKey. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:: collectionId - - The collection id.; documentKey - - The document key.; value - - An object containing the documents attributes; rev - - The desired revision; policy - - The update policy; waitForSync - - if set to true the response is returned when the server has finished.; keepNull - - If true null values are kept.
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public DocumentEntity<?> updateDocument(String collectionName,
                                        String documentKey,
                                        Object value,
                                        Long rev,
                                        Policy policy,
                                        Boolean waitForSync,
                                        Boolean keepNull)
                                 throws ArangoException

Parameters:: collectionName - - The collection name.; documentKey - - The document key.; value - - An object containing the documents attributes; rev - - The desired revision; policy - - The update policy; waitForSync - - if set to true the response is returned when the server has finished.; keepNull - - If true null values are kept.
Returns:: DocumentEntity
Throws:: ArangoException

updateDocument

public <T> DocumentEntity<T> updateDocument(String documentHandle,
                                            Object value,
                                            Long rev,
                                            Policy policy,
                                            Boolean waitForSync,
                                            Boolean keepNull)
                                     throws ArangoException

This method updates a document defined by documentHandle. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:: documentKey - - The document handle.; value - - An object containing the documents attributes; rev - - The desired revision; policy - - The update policy; waitForSync - - if set to true the response is returned when the server has finished.; keepNull - - If true null values are kept.
Returns:: DocumentEntity
Throws:: ArangoException

getDocuments
```
public List<String> getDocuments(long collectionId)
                          throws ArangoException
```
This method returns all document handles from a collection.

Parameters:

collectionId - - The collection id.

Returns:

List - The list of document handles

Throws:

ArangoException

getDocuments
```
public List<String> getDocuments(String collectionName)
                          throws ArangoException
```
This method returns all document handles from a collection.

Parameters:

collectionName - - The collection name.

Returns:

List - The list of document handles

Throws:

ArangoException

getDocuments
```
public List<String> getDocuments(long collectionId,
                                 boolean handleConvert)
                          throws ArangoException
```
This method returns all document handles from a collection.

Parameters:

collectionId - - The collection id.

handleConvert - - if set to true only the document ids are returned

Returns:

List - The list of document handles

Throws:

ArangoException

getDocuments
```
public List<String> getDocuments(String collectionName,
                                 boolean handleConvert)
                          throws ArangoException
```
This method returns all document handles from a collection.

Parameters:

collectionName - - The collection name.

handleConvert - - if set to true only the document ids are returned

Returns:

List - The list of document handles

Throws:

ArangoException

checkDocument
```
public long checkDocument(long collectionId,
                          long documentId)
                   throws ArangoException
```
This method returns the current revision of a document.

Parameters:

collectionId - - The collection id.

documentId - - The document id

Returns:

long

Throws:

ArangoException

checkDocument
```
public long checkDocument(String collectionName,
                          long documentId)
                   throws ArangoException
```
This method returns the current revision of a document.

Parameters:

collectionName - - The collection name.

documentId - - The document id

Returns:

long

Throws:

ArangoException

checkDocument
```
public long checkDocument(long collectionId,
                          String documentKey)
                   throws ArangoException
```
This method returns the current revision of a document.

Parameters:

collectionId - - The collection id.

documentKey - - The document key

Returns:

long

Throws:

ArangoException

checkDocument
```
public long checkDocument(String collectionName,
                          String documentKey)
                   throws ArangoException
```
This method returns the current revision of a document.

Parameters:

collectionName - - The collection name.

documentKey - - The document key

Returns:

long

Throws:

ArangoException

checkDocument
```
public long checkDocument(String documentHandle)
                   throws ArangoException
```
This method returns the current revision of a document.

Parameters:

documentHandle - - The document handle

Returns:

long

Throws:

ArangoException

getDocument
```
public <T> DocumentEntity<T> getDocument(long collectionId,
                                         long documentId,
                                         Class<?> clazz)
                                  throws ArangoException
```
Returns a document entity.

Type Parameters:

T -

Parameters:

collectionId - - The collection id.

documentId - - The document id

clazz - - The expected class, the result from the server request is deserialized to an instance of this class.

Returns:

DocumentEntity

Throws:

ArangoException

getDocument
```
public <T> DocumentEntity<T> getDocument(String collectionName,
                                         long documentId,
                                         Class<?> clazz)
                                  throws ArangoException
```
Returns a document entity.

Type Parameters:

T -

Parameters:

collectionName - - The collection name.

documentId - - The document id

clazz - - The expected class, the result from the server request is deserialized to an instance of this class.

Returns:

DocumentEntity

Throws:

ArangoException

getDocument

public <T> DocumentEntity<T> getDocument(long collectionId,
                                         String documentKey,
                                         Class<?> clazz)
                                  throws ArangoException

Returns a document entity.

Type Parameters:: T -
Parameters:: collectionId - - The collection id.; documentKey - - The document key; clazz - - The expected class, the result from the server request is deserialized to an instance of this class.
Returns:: DocumentEntity
Throws:: ArangoException

getDocument

public <T> DocumentEntity<T> getDocument(String collectionName,
                                         String documentKey,
                                         Class<?> clazz)
                                  throws ArangoException

Returns a document entity.

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; documentKey - - The document key; clazz - - The expected class, the result from the server request is deserialized to an instance of this class.
Returns:: DocumentEntity
Throws:: ArangoException

getDocument
```
public <T> DocumentEntity<T> getDocument(String documentHandle,
                                         Class<?> clazz)
                                  throws ArangoException
```
Returns a document entity.

Type Parameters:

T -

Parameters:

documentHandle - - The document handle

clazz - - The expected class, the result from the server request is deserialized to an instance of this class.

Returns:

DocumentEntity

Throws:

ArangoException

getDocument
```
public <T> DocumentEntity<T> getDocument(String documentHandle,
                                         Class<?> clazz,
                                         Long ifNoneMatchRevision,
                                         Long ifMatchRevision)
                                  throws ArangoException
```
Returns a document entity. Note that the *ifNoneMatchRevision* and *ifMatchRevision* can not be used at the same time, one of these two has to be null.

Type Parameters:

T -

Parameters:

documentHandle - - The document handle

clazz - - The expected class, the result from the server request is deserialized to an instance of this class.

ifNoneMatchRevision - - if set the document is only returned id it has a different revision.

ifMatchRevision - - if set the document is only returned id it has the same revision.

Returns:

DocumentEntity

Throws:

ArangoException

deleteDocument

public DocumentEntity<?> deleteDocument(long collectionId,
                                        long documentId)
                                 throws ArangoException

Deletes a document from the database.

Parameters:: collectionId - - The collection id.; documentId - - The document id.
Returns:: DocumentEntity
Throws:: ArangoException

deleteDocument

public DocumentEntity<?> deleteDocument(String collectionName,
                                        long documentId)
                                 throws ArangoException

Deletes a document from the database.

Parameters:: collectionName - - The collection name.; documentId - - The document id.
Returns:: DocumentEntity
Throws:: ArangoException

deleteDocument

public DocumentEntity<?> deleteDocument(long collectionId,
                                        String documentKey)
                                 throws ArangoException

Deletes a document from the database.

Parameters:: collectionId - - The collection id.; documentKey - - The document key.
Returns:: DocumentEntity
Throws:: ArangoException

deleteDocument

public DocumentEntity<?> deleteDocument(String collectionName,
                                        String documentKey)
                                 throws ArangoException

Deletes a document from the database.

Parameters:: collectionName - - The collection name.; documentKey - - The document key.
Returns:: DocumentEntity
Throws:: ArangoException

deleteDocument
```
public DocumentEntity<?> deleteDocument(String documentHandle)
                                 throws ArangoException
```
Deletes a document from the database.

Parameters:

documentHandle - - The document handle.

Returns:

DocumentEntity

Throws:

ArangoException

deleteDocument
```
public DocumentEntity<?> deleteDocument(long collectionId,
                                        long documentId,
                                        Long rev,
                                        Policy policy)
                                 throws ArangoException
```
Deletes a document from the database. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionId - - The collection id.

documentId - - The document id.

rev - - The desired revision

policy - - The update policy

Returns:

DocumentEntity

Throws:

ArangoException

deleteDocument
```
public DocumentEntity<?> deleteDocument(String collectionName,
                                        long documentId,
                                        Long rev,
                                        Policy policy)
                                 throws ArangoException
```
Deletes a document from the database. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionName - - The collection name.

documentId - - The document id.

rev - - The desired revision

policy - - The update policy

Returns:

DocumentEntity

Throws:

ArangoException

deleteDocument
```
public DocumentEntity<?> deleteDocument(long collectionId,
                                        String documentKey,
                                        Long rev,
                                        Policy policy)
                                 throws ArangoException
```
Deletes a document from the database. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionId - - The collection id.

documentKey - - The document key.

rev - - The desired revision

policy - - The update policy

Returns:

DocumentEntity

Throws:

ArangoException

deleteDocument
```
public DocumentEntity<?> deleteDocument(String collectionName,
                                        String documentKey,
                                        Long rev,
                                        Policy policy)
                                 throws ArangoException
```
Deletes a document from the database. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

collectionName - - The collection name.

documentKey - - The document key.

rev - - The desired revision

policy - - The update policy

Returns:

DocumentEntity

Throws:

ArangoException

deleteDocument
```
public DocumentEntity<?> deleteDocument(String documentHandle,
                                        Long rev,
                                        Policy policy)
                                 throws ArangoException
```
Deletes a document from the database. This method offers a parameter rev (revision). If the revision of the document on the server does not match the given revision the policy parameter is used. If it is set to *last* the operation is performed anyway. if it is set to *error* an error is thrown.

Parameters:

documentHandle - - The document handle.

rev - - The desired revision

policy - - The update policy

Returns:

DocumentEntity

Throws:

ArangoException

validateQuery
```
public CursorEntity<?> validateQuery(String query)
                              throws ArangoException
```
This method validates a given AQL query string and returns a CursorEntity

Parameters:

query - - an AQL query as string

Returns:

CursorEntity

Throws:

ArangoException

executeQuery

public <T> CursorEntity<T> executeQuery(String query,
                                        Map<String,Object> bindVars,
                                        Class<T> clazz,
                                        Boolean calcCount,
                                        Integer batchSize)
                                 throws ArangoException

This method executes an AQL query and returns a CursorEntity

Type Parameters:: T -
Parameters:: query - - an AQL query as string; bindVars - - a map containing all bind variables,; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.; calcCount - - if set to true the result count is returned; batchSize - - the batch size of the result cursor
Returns:: CursorEntity
Throws:: ArangoException

continueQuery
```
public <T> CursorEntity<T> continueQuery(long cursorId,
                                         Class<?>... clazz)
                                  throws ArangoException
```
Continues data retrieval for an existing cursor

Type Parameters:

T -

Parameters:

cursorId - - The id of a cursor.

clazz - - the expected class, the result from the server request is deserialized to an instance of this class.

Returns:

CursorEntity

Throws:

ArangoException

finishQuery
```
public DefaultEntity finishQuery(long cursorId)
                          throws ArangoException
```
Deletes a cursor from the database.

Parameters:

cursorId - - The id of a cursor.

Returns:

DefaultEntity

Throws:

ArangoException

executeQueryWithResultSet

public <T> CursorResultSet<T> executeQueryWithResultSet(String query,
                                                        Map<String,Object> bindVars,
                                                        Class<T> clazz,
                                                        Boolean calcCount,
                                                        Integer batchSize)
                                                 throws ArangoException

This method executes an AQL query and returns a CursorResultSet

Type Parameters:: T -
Parameters:: query - - an AQL query as string; bindVars - - a map containing all bind variables,; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.; calcCount - - if set to true the result count is returned; batchSize - - the batch size of the result cursor
Returns:: CursorResultSet
Throws:: ArangoException

createIndex

public IndexEntity createIndex(long collectionId,
                               IndexType type,
                               boolean unique,
                               String... fields)
                        throws ArangoException

This method creates an index for a collection.

Parameters:: collectionId - - The collection id.; type - - the index type.; unique - - if set to true the index will be a unique index; fields - - the fields (document attributes) the index is created on
Returns:: IndexEntity
Throws:: ArangoException

createIndex

public IndexEntity createIndex(String collectionName,
                               IndexType type,
                               boolean unique,
                               String... fields)
                        throws ArangoException

This method creates an index for a collection.

Parameters:: collectionName - - The collection name.; type - - the index type.; unique - - if set to true the index will be a unique index; fields - - the fields (document attributes) the index is created on
Returns:: IndexEntity
Throws:: ArangoException

createHashIndex
```
public IndexEntity createHashIndex(String collectionName,
                                   boolean unique,
                                   String... fields)
                            throws ArangoException
```
This method creates a hash index for a collection.

Parameters:

collectionName - - The collection name.

unique - - if set to true the index will be a unique index

fields - - the fields (document attributes) the index is created on

Returns:

IndexEntity

Throws:

ArangoException

createGeoIndex
```
public IndexEntity createGeoIndex(String collectionName,
                                  boolean unique,
                                  String... fields)
                           throws ArangoException
```
This method creates a geo index for a collection.

Parameters:

collectionName - - The collection name.

unique - - if set to true the index will be a unique index

fields - - the fields (document attributes) the index is created on

Returns:

IndexEntity

Throws:

ArangoException

createSkipListIndex
```
public IndexEntity createSkipListIndex(String collectionName,
                                       boolean unique,
                                       String... fields)
                                throws ArangoException
```
This method creates a skip list index for a collection.

Parameters:

collectionName - - The collection name.

unique - - if set to true the index will be a unique index

fields - - the fields (document attributes) the index is created on

Returns:

IndexEntity

Throws:

ArangoException

createCappedIndex
```
public IndexEntity createCappedIndex(long collectionId,
                                     int size)
                              throws ArangoException
```
This method creates a capped index for a collection.

Parameters:

collectionId - - The collection id.

size - - the maximum amount of documents

Returns:

IndexEntity

Throws:

ArangoException

createCappedIndex
```
public IndexEntity createCappedIndex(String collectionName,
                                     int size)
                              throws ArangoException
```
This method creates a capped index for a collection.

Parameters:

collectionName - - The collection name.

size - - the maximum amount of documents

Returns:

IndexEntity

Throws:

ArangoException

createCappedByDocumentSizeIndex
```
public IndexEntity createCappedByDocumentSizeIndex(long collectionId,
                                                   int byteSize)
                                            throws ArangoException
```
This method creates a capped index for a collection.

Parameters:

collectionId - - The collection id.

byteSize - - the maximum size of the document data in bytes

Returns:

IndexEntity

Throws:

ArangoException

createCappedByDocumentSizeIndex
```
public IndexEntity createCappedByDocumentSizeIndex(String collectionName,
                                                   int byteSize)
                                            throws ArangoException
```
This method creates a capped index for a collection.

Parameters:

collectionName - - The collection name.

byteSize - - the maximum size of the document data in bytes

Returns:

IndexEntity

Throws:

ArangoException

createFulltextIndex
```
public IndexEntity createFulltextIndex(long collectionId,
                                       String... fields)
                                throws ArangoException
```
This method creates a full text index for a collection.

Parameters:

collectionId - - The collection id.

fields - - the fields (document attributes) the index is created on

Returns:

IndexEntity

Throws:

ArangoException

createFulltextIndex
```
public IndexEntity createFulltextIndex(String collectionName,
                                       String... fields)
                                throws ArangoException
```
This method creates a full text index for a collection.

Parameters:

collectionName - - The collection name.

fields - - the fields (document attributes) the index is created on

Returns:

IndexEntity

Throws:

ArangoException

createFulltextIndex

public IndexEntity createFulltextIndex(long collectionId,
                                       Integer minLength,
                                       String... fields)
                                throws ArangoException

This method creates a full text index for a collection.

Parameters:: collectionId - - The collection id.; minLength - - Minimum character length of words to index.; fields - - the fields (document attributes) the index is created on
Returns:: IndexEntity
Throws:: ArangoException

createFulltextIndex

public IndexEntity createFulltextIndex(String collectionName,
                                       Integer minLength,
                                       String... fields)
                                throws ArangoException

This method creates a full text index for a collection.

Parameters:: collectionName - - The collection name.; minLength - - Minimum character length of words to index.; fields - - the fields (document attributes) the index is created on
Returns:: IndexEntity
Throws:: ArangoException

deleteIndex
```
public IndexEntity deleteIndex(String indexHandle)
                        throws ArangoException
```
Deletes an index from a collection

Parameters:

indexHandle - - the index handle

Returns:

IndexEntity

Throws:

ArangoException

getIndex
```
public IndexEntity getIndex(String indexHandle)
                     throws ArangoException
```
Returns an index from a collection.

Parameters:

indexHandle - - the index handle

Returns:

IndexEntity

Throws:

ArangoException

getIndexes
```
public IndexesEntity getIndexes(long collectionId)
                         throws ArangoException
```
Returns all indices from a collection.

Parameters:

collectionId - - The collection id.

Returns:

IndexesEntity

Throws:

ArangoException

getIndexes
```
public IndexesEntity getIndexes(String collectionName)
                         throws ArangoException
```
Returns all indices from a collection.

Parameters:

collectionName - - The collection name.

Returns:

IndexesEntity

Throws:

ArangoException

getServerLog
```
public AdminLogEntity getServerLog(Integer logLevel,
                                   Boolean logLevelUpTo,
                                   Integer start,
                                   Integer size,
                                   Integer offset,
                                   Boolean sortAsc,
                                   String text)
                            throws ArangoException
```
Returns the server log, for the parameters *logLevel* and *logLevelUpTo* please note the following: fatal or 0 error or 1 warning or 2 info or 3 debug or 4 The default value is info.

Parameters:

logLevel - - if set only logs with this *logLevel* are returned

logLevelUpTo - - if set all logs up to the *logLevelUpTo* are returned

start - - Returns all log entries such that their log entry identifier (lid value) is greater or equal to start.

size - - Restricts the result to at most size log entries.

offset - - Starts to return log entries skipping the first offset log entries.

sortAsc - - if set to true the default sort order (descending) is reverted to ascending

text - - Only return the log entries containing the text specified in text.

Returns:

Throws:

ArangoException

getStatistics

public StatisticsEntity getStatistics()
                               throws ArangoException

Returns the current statistics

Returns:: StatisticsEntity
Throws:: ArangoException

getStatisticsDescription

public StatisticsDescriptionEntity getStatisticsDescription()
                                                     throws ArangoException

Returns the statistics description

Returns:: StatisticsDescriptionEntity
Throws:: ArangoException

getVersion

public ArangoVersion getVersion()
                         throws ArangoException

Returns the database version

Returns:: ArangoVersion
Throws:: ArangoException

getTime

public ArangoUnixTime getTime()
                       throws ArangoException

Returns the current server time

Returns:: ArangoUnixTime
Throws:: ArangoException

reloadRouting
```
public DefaultEntity reloadRouting()
                            throws ArangoException
```
Triggers the routes reloading in ArangoDB

Returns:

DefaultEntity

Throws:

ArangoException

executeScript
```
public DefaultEntity executeScript(String jsCode)
                            throws ArangoException
```
Executes a javascript code.

Parameters:

jsCode - - a javascript function as string

Returns:

DefaultEntity

Throws:

ArangoException

executeSimpleByExample

public <T> CursorEntity<T> executeSimpleByExample(String collectionName,
                                                  Map<String,Object> example,
                                                  int skip,
                                                  int limit,
                                                  Class<T> clazz)
                                           throws ArangoException

This will find all documents matching a given example.

Type Parameters:: T -
Parameters:: collectionName - - - The collection name.; example - - The example as a map.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorEntity
Throws:: ArangoException

executeSimpleByExampleWithResusltSet

public <T> CursorResultSet<T> executeSimpleByExampleWithResusltSet(String collectionName,
                                                                   Map<String,Object> example,
                                                                   int skip,
                                                                   int limit,
                                                                   Class<?> clazz)
                                                            throws ArangoException

This will find all documents matching a given example.

Type Parameters:: T -
Parameters:: collectionName - - - The collection name.; example - - The example as a map.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorResultSet
Throws:: ArangoException

executeSimpleByExampleWithDocument

public <T> CursorEntity<DocumentEntity<T>> executeSimpleByExampleWithDocument(String collectionName,
                                                                              Map<String,Object> example,
                                                                              int skip,
                                                                              int limit,
                                                                              Class<?> clazz)
                                                                       throws ArangoException

This will find all documents matching a given example.

Type Parameters:: T -
Parameters:: collectionName - - - The collection name.; example - - The example as a map.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorEntity>
Throws:: ArangoException

executeSimpleByExampleWithDocumentResusltSet

public <T> CursorResultSet<DocumentEntity<T>> executeSimpleByExampleWithDocumentResusltSet(String collectionName,
                                                                                           Map<String,Object> example,
                                                                                           int skip,
                                                                                           int limit,
                                                                                           Class<?> clazz)
                                                                                    throws ArangoException

This will find all documents matching a given example.

Type Parameters:: T -
Parameters:: collectionName - - - The collection name.; example - - The example as a map.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorResultSet>
Throws:: ArangoException

executeSimpleAll
```
public <T> CursorEntity<T> executeSimpleAll(String collectionName,
                                            int skip,
                                            int limit,
                                            Class<?> clazz)
                                     throws ArangoException
```
Returns all documents of a collections.

Type Parameters:

T -

Parameters:

collectionName - - - The collection name.

skip - - The number of documents to skip in the query.

limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.

clazz - - the expected class, the result from the server request is deserialized to an instance of this class.

Returns:

CursorEntity

Throws:

ArangoException

executeSimpleAllWithResultSet
```
public <T> CursorResultSet<T> executeSimpleAllWithResultSet(String collectionName,
                                                            int skip,
                                                            int limit,
                                                            Class<?> clazz)
                                                     throws ArangoException
```
Returns all documents of a collections.

Type Parameters:

T -

Parameters:

collectionName - - - The collection name.

skip - - The number of documents to skip in the query.

limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.

clazz - - the expected class, the result from the server request is deserialized to an instance of this class.

Returns:

CursorResultSet

Throws:

ArangoException

executeSimpleAllWithDocument

public <T> CursorEntity<DocumentEntity<T>> executeSimpleAllWithDocument(String collectionName,
                                                                        int skip,
                                                                        int limit,
                                                                        Class<?> clazz)
                                                                 throws ArangoException

Returns all documents of a collections.

Type Parameters:: T -
Parameters:: collectionName - - - The collection name.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorEntity>
Throws:: ArangoException

executeSimpleAllWithDocumentResultSet

public <T> CursorResultSet<DocumentEntity<T>> executeSimpleAllWithDocumentResultSet(String collectionName,
                                                                                    int skip,
                                                                                    int limit,
                                                                                    Class<?> clazz)
                                                                             throws ArangoException

Returns all documents of a collections.

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorResultSet>
Throws:: ArangoException

executeSimpleFirstExample

public <T> ScalarExampleEntity<T> executeSimpleFirstExample(String collectionName,
                                                            Map<String,Object> example,
                                                            Class<?> clazz)
                                                     throws ArangoException

Returns the first document matching the example

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; example - - The example as a map.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: ScalarExampleEntity
Throws:: ArangoException

executeSimpleAny
```
public <T> ScalarExampleEntity<T> executeSimpleAny(String collectionName,
                                                   Class<?> clazz)
                                            throws ArangoException
```
Returns a random document from the collection

Type Parameters:

T -

Parameters:

collectionName - - The collection name.

clazz - - the expected class, the result from the server request is deserialized to an instance of this class.

Returns:

ScalarExampleEntity

Throws:

ArangoException

executeSimpleRange

public <T> CursorEntity<T> executeSimpleRange(String collectionName,
                                              String attribute,
                                              Object left,
                                              Object right,
                                              Boolean closed,
                                              int skip,
                                              int limit,
                                              Class<?> clazz)
                                       throws ArangoException

This will find all documents within a given range. In order to execute a range query, a skip-list index on the queried attribute must be present.

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; attribute - - The attribute path to check.; left - - The lower bound; right - - The upper bound; closed - - If true, use interval including left and right, otherwise exclude right, but include left.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorEntity
Throws:: ArangoException

executeSimpleRangeWithResultSet

public <T> CursorResultSet<T> executeSimpleRangeWithResultSet(String collectionName,
                                                              String attribute,
                                                              Object left,
                                                              Object right,
                                                              Boolean closed,
                                                              int skip,
                                                              int limit,
                                                              Class<?> clazz)
                                                       throws ArangoException

This will find all documents within a given range. In order to execute a range query, a skip-list index on the queried attribute must be present.

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; attribute - - The attribute path to check.; left - - The lower bound; right - - The upper bound; closed - - If true, use interval including left and right, otherwise exclude right, but include left.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorResultSet
Throws:: ArangoException

executeSimpleRangeWithDocument

public <T> CursorEntity<DocumentEntity<T>> executeSimpleRangeWithDocument(String collectionName,
                                                                          String attribute,
                                                                          Object left,
                                                                          Object right,
                                                                          Boolean closed,
                                                                          int skip,
                                                                          int limit,
                                                                          Class<?> clazz)
                                                                   throws ArangoException

This will find all documents within a given range. In order to execute a range query, a skip-list index on the queried attribute must be present.

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; attribute - - The attribute path to check.; left - - The lower bound; right - - The upper bound; closed - - If true, use interval including left and right, otherwise exclude right, but include left.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorEntity>
Throws:: ArangoException

executeSimpleRangeWithDocumentResultSet

public <T> CursorResultSet<DocumentEntity<T>> executeSimpleRangeWithDocumentResultSet(String collectionName,
                                                                                      String attribute,
                                                                                      Object left,
                                                                                      Object right,
                                                                                      Boolean closed,
                                                                                      int skip,
                                                                                      int limit,
                                                                                      Class<?> clazz)
                                                                               throws ArangoException

This will find all documents within a given range. In order to execute a range query, a skip-list index on the queried attribute must be present.

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; attribute - - The attribute path to check.; left - - The lower bound; right - - The upper bound; closed - - If true, use interval including left and right, otherwise exclude right, but include left.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorResultSet>
Throws:: ArangoException

executeSimpleFulltext

public <T> CursorEntity<T> executeSimpleFulltext(String collectionName,
                                                 String attribute,
                                                 String query,
                                                 int skip,
                                                 int limit,
                                                 String index,
                                                 Class<?> clazz)
                                          throws ArangoException

This will find all documents from the collection that match the fulltext query specified in query. In order to use the fulltext operator, a fulltext index must be defined for the collection and the specified attribute.

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; attribute - - The attribute path to check.; query - - The fulltext query as string.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorEntity
Throws:: ArangoException

executeSimpleFulltextWithResultSet

public <T> CursorResultSet<T> executeSimpleFulltextWithResultSet(String collectionName,
                                                                 String attribute,
                                                                 String query,
                                                                 int skip,
                                                                 int limit,
                                                                 String index,
                                                                 Class<?> clazz)
                                                          throws ArangoException

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; attribute - - The attribute path to check.; query - - The fulltext query as string.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorResultSet
Throws:: ArangoException

executeSimpleFulltextWithDocument

public <T> CursorEntity<DocumentEntity<T>> executeSimpleFulltextWithDocument(String collectionName,
                                                                             String attribute,
                                                                             String query,
                                                                             int skip,
                                                                             int limit,
                                                                             String index,
                                                                             Class<?> clazz)
                                                                      throws ArangoException

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; attribute - - The attribute path to check.; query - - The fulltext query as string.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorEntity>
Throws:: ArangoException

executeSimpleFulltextWithDocumentResultSet

public <T> CursorResultSet<DocumentEntity<T>> executeSimpleFulltextWithDocumentResultSet(String collectionName,
                                                                                         String attribute,
                                                                                         String query,
                                                                                         int skip,
                                                                                         int limit,
                                                                                         String index,
                                                                                         Class<?> clazz)
                                                                                  throws ArangoException

Type Parameters:: T -
Parameters:: collectionName - - The collection name.; attribute - - The attribute path to check.; query - - The fulltext query as string.; skip - - The number of documents to skip in the query.; limit - - The maximal amount of documents to return. The skip is applied before the limit restriction.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorResultSet>
Throws:: ArangoException

executeSimpleRemoveByExample

public SimpleByResultEntity executeSimpleRemoveByExample(String collectionName,
                                                         Map<String,Object> example,
                                                         Boolean waitForSync,
                                                         Integer limit)
                                                  throws ArangoException

This will remove all documents in the collection that match the specified example object.

Parameters:: collectionName - - The collection name.; example - - The example as a map.; waitForSync - - if set to true the response is returned when the server has finished.; limit - - limits the amount of documents which will be deleted.
Returns:: SimpleByResultEntity
Throws:: ArangoException

executeSimpleReplaceByExample

public SimpleByResultEntity executeSimpleReplaceByExample(String collectionName,
                                                          Map<String,Object> example,
                                                          Map<String,Object> newValue,
                                                          Boolean waitForSync,
                                                          Integer limit)
                                                   throws ArangoException

This will replace all documents in the collection that match the specified example object.

Parameters:: collectionName - - The collection name.; example - - The example as a map.; newValue - - The new values.; waitForSync - - if set to true the response is returned when the server has finished.; limit - - limits the amount of documents which will be replaced.
Returns:: SimpleByResultEntity
Throws:: ArangoException

executeSimpleUpdateByExample

public SimpleByResultEntity executeSimpleUpdateByExample(String collectionName,
                                                         Map<String,Object> example,
                                                         Map<String,Object> newValue,
                                                         Boolean keepNull,
                                                         Boolean waitForSync,
                                                         Integer limit)
                                                  throws ArangoException

This will update all documents in the collection that match the specified example object.

Parameters:: collectionName - - The collection name.; example - - The example as a map.; newValue - - The new values.; keepNull - - - If true null values are kept.; waitForSync - - if set to true the response is returned when the server has finished.; limit - - limits the amount of documents which will be updated.
Returns:: SimpleByResultEntity
Throws:: ArangoException

executeSimpleFirst
```
public <T> DocumentResultEntity<T> executeSimpleFirst(String collectionName,
                                                      Integer count,
                                                      Class<?> clazz)
                                               throws ArangoException
```
This will return the first document(s) from the collection, in the order of insertion/update time.

Parameters:

collectionName - - The collection name.

count - - the number of documents to return at most. Specifiying count is optional. If it is not specified, it defaults to 1.

clazz - - the expected class, the result from the server request is deserialized to an instance of this class.

Returns:

DocumentResultEntity

Throws:

ArangoException

executeSimpleLast
```
public <T> DocumentResultEntity<T> executeSimpleLast(String collectionName,
                                                     Integer count,
                                                     Class<?> clazz)
                                              throws ArangoException
```
This will return the last document(s) from the collection, in the order of insertion/update time.

Parameters:

collectionName - - The collection name.

count - - the number of documents to return at most. Specifiying count is optional. If it is not specified, it defaults to 1.

clazz - - the expected class, the result from the server request is deserialized to an instance of this class.

Returns:

DocumentResultEntity

Throws:

ArangoException

createUser

public DefaultEntity createUser(String username,
                                String passwd,
                                Boolean active,
                                Map<String,Object> extra)
                         throws ArangoException

Creates a database user.

Parameters:: username - - the username as string; passwd - - the username as string; active - - if true the user is active; extra - - additional user data
Returns:: DefaultEntity
Throws:: ArangoException

replaceUser

public DefaultEntity replaceUser(String username,
                                 String passwd,
                                 Boolean active,
                                 Map<String,Object> extra)
                          throws ArangoException

Replaces the data of a database user.

Parameters:: username - - the username as string; passwd - - the username as string; active - - if true the user is active; extra - - additional user data
Returns:: DefaultEntity
Throws:: ArangoException

updateUser

public DefaultEntity updateUser(String username,
                                String passwd,
                                Boolean active,
                                Map<String,Object> extra)
                         throws ArangoException

Updates the data of a database user.

Parameters:: username - - the username as string; passwd - - the username as string; active - - if true the user is active; extra - - additional user data
Returns:: DefaultEntity
Throws:: ArangoException

deleteUser
```
public DefaultEntity deleteUser(String username)
                         throws ArangoException
```
Deletes a database user.

Parameters:

username - - the username as string

Returns:

DefaultEntity

Throws:

ArangoException

getUser
```
public UserEntity getUser(String username)
                   throws ArangoException
```
Returns a database user.

Parameters:

username - - the username as string

Returns:

UserEntity

Throws:

ArangoException

getUsersDocument

public List<DocumentEntity<UserEntity>> getUsersDocument()
                                                  throws ArangoException

Returns all database user as document.

Returns:: List>
Throws:: ArangoException

getUsers

public List<UserEntity> getUsers()
                          throws ArangoException

Returns all database user.

Returns:: List
Throws:: ArangoException

importDocuments

public ImportResultEntity importDocuments(String collection,
                                          Boolean createCollection,
                                          Collection<?> values)
                                   throws ArangoException

Creates documents in the collection.

Parameters:: collection - - the collection as a string; createCollection - - if set to true the collection is created if it does not exist; values - - a list of Objects that will be stored as documents
Returns:: ImportResultEntity
Throws:: ArangoException

importDocumentsByHeaderValues

public ImportResultEntity importDocumentsByHeaderValues(String collection,
                                                        Boolean createCollection,
                                                        Collection<? extends Collection<?>> headerValues)
                                                 throws ArangoException

Creates documents in the collection.

Parameters:: collection - - the collection as a string; createCollection - - if set to true the collection is created if it does not exist; headerValues - - a list of lists that will be stored as documents
Returns:: ImportResultEntity
Throws:: ArangoException

getCurrentDatabase

public DatabaseEntity getCurrentDatabase()
                                  throws ArangoException

Returns the current database

Returns:: DatabaseEntity
Throws:: ArangoException

getDatabases

public StringsResultEntity getDatabases()
                                 throws ArangoException

Returns all databases

Returns:: StringsResultEntity
Throws:: ArangoException

getDatabases
```
public StringsResultEntity getDatabases(boolean currentUserAccessableOnly)
                                 throws ArangoException
```
Returns all databases

Parameters:

currentUserAccessableOnly - - If true only the databases are returned that the current user can access

Returns:

StringsResultEntity

Throws:

ArangoException

getDatabases

public StringsResultEntity getDatabases(String username,
                                        String password)
                                 throws ArangoException

Returns all databases the user identified by his credentials can access

Parameters:: username - - the username as string; password - - the password as string
Returns:: StringsResultEntity
Throws:: ArangoException

createDatabase

public BooleanResultEntity createDatabase(String database,
                                          UserEntity... users)
                                   throws ArangoException

This method creates a database

Parameters:: database - - the database name as a string; users - - a list of users which are supposed to have access to the database
Returns:: BooleanResultEntity
Throws:: ArangoException

deleteDatabase
```
public BooleanResultEntity deleteDatabase(String database)
                                   throws ArangoException
```
This method deletes a database

Parameters:

database - - the database name as a string

Returns:

BooleanResultEntity

Throws:

ArangoException

createEndpoint

public BooleanResultEntity createEndpoint(String endpoint,
                                          String... databases)
                                   throws ArangoException

This method creates an endpoint.

Parameters:: endpoint - - the endpoint as string; databases - - a list of databases that are allowed on this endpoint
Returns:: BooleanResultEntity
Throws:: ArangoException

getEndpoints

public List<Endpoint> getEndpoints()
                            throws ArangoException

This method returns all endpoints.

Returns:: List
Throws:: ArangoException

deleteEndpoint
```
public BooleanResultEntity deleteEndpoint(String endpoint)
                                   throws ArangoException
```
This method deletes an endpoint

Parameters:

endpoint - - the endpoint as string

Returns:

BooleanResultEntity

Throws:

ArangoException

getReplicationInventory
```
public ReplicationInventoryEntity getReplicationInventory()
                                                   throws ArangoException
```
Returns the list of collections and indexes available on the server. This list can be used by replication clients to initiate an initial sync with the server.

Returns:

ReplicationInventoryEntity

Throws:

ArangoException

getReplicationInventory
```
public ReplicationInventoryEntity getReplicationInventory(boolean includeSystem)
                                                   throws ArangoException
```
Returns the list of collections and indexes available on the server. This list can be used by replication clients to initiate an initial sync with the server.

Parameters:

includeSystem - - if true the system collections are included into the result

Returns:

ReplicationInventoryEntity

Throws:

ArangoException

getReplicationDump

public <T> void getReplicationDump(String collectionName,
                                   Long from,
                                   Long to,
                                   Integer chunkSize,
                                   Boolean ticks,
                                   Class<T> clazz,
                                   DumpHandler<T> handler)
                            throws ArangoException

Returns the data from the collection for the requested range.

Parameters:: collectionName - - the collection name; from - - Lower bound tick value for results.; to - - Upper bound tick value for results.; chunkSize - - Approximate maximum size of the returned result.; ticks - - Whether or not to include tick values in the dump. Default value is true.; clazz - - the expected class, the result from the server request is deserialized to an instance of this class.; handler - - a handler object that processes the dump
Throws:: ArangoException

syncReplication

public ReplicationSyncEntity syncReplication(String endpoint,
                                             String database,
                                             String username,
                                             String password,
                                             RestrictType restrictType,
                                             String... restrictCollections)
                                      throws ArangoException

Starts a full data synchronization from a remote endpoint into the local ArangoDB database.

Parameters:: endpoint - - the endpoint as string; database - - the database name as a string; username - - the username as string; password - - the password as string; restrictType - - collection filtering. When specified, the allowed values are include or exclude.; restrictCollections - - If restrictType is include, only the specified collections will be sychronised. If restrictType is exclude, all but the specified collections will be synchronized.
Returns:: ReplicationSyncEntity
Throws:: ArangoException

getReplicationServerId
```
public String getReplicationServerId()
                              throws ArangoException
```
Returns the servers id. The id is also returned by other replication API methods, and this method is an easy means of determining a server's id.

Returns:

String

Throws:

ArangoException

startReplicationLogger

public boolean startReplicationLogger()
                               throws ArangoException

Starts the replication logger

Returns:: boolean
Throws:: ArangoException

stopReplicationLogger

public boolean stopReplicationLogger()
                              throws ArangoException

Stops the replication logger

Returns:: boolean
Throws:: ArangoException

getReplicationLoggerState
```
public ReplicationLoggerStateEntity getReplicationLoggerState()
                                                       throws ArangoException
```
Returns the current state of the server's replication logger. The state will include information about whether the logger is running and about the last logged tick value.

Returns:

ReplicationLoggerStateEntity

Throws:

ArangoException

Since:

1.4.0

getReplicationLoggerConfig

public ReplicationLoggerConfigEntity getReplicationLoggerConfig()
                                                         throws ArangoException

Returns the configuration of the replication logger

Returns:: ReplicationLoggerConfigEntity
Throws:: ArangoException

setReplicationLoggerConfig

public ReplicationLoggerConfigEntity setReplicationLoggerConfig(Boolean autoStart,
                                                                Boolean logRemoteChanges,
                                                                Long maxEvents,
                                                                Long maxEventsSize)
                                                         throws ArangoException

Sets the replication logger configuration

Parameters:: autoStart - - if true autoStart is activated; logRemoteChanges - - if true remote changes are logged; maxEvents - - the maximum amount of events to log; maxEventsSize - - the maximum size of events
Returns:: ReplicationLoggerConfigEntity
Throws:: ArangoException

getReplicationApplierConfig

public ReplicationApplierConfigEntity getReplicationApplierConfig()
                                                           throws ArangoException

Returns the configuration of the replication applier.

Returns:: ReplicationApplierConfigEntity
Throws:: ArangoException
Since:: 1.4.0

setReplicationApplierConfig

public ReplicationApplierConfigEntity setReplicationApplierConfig(String endpoint,
                                                                  String database,
                                                                  String username,
                                                                  String password,
                                                                  Integer maxConnectRetries,
                                                                  Integer connectTimeout,
                                                                  Integer requestTimeout,
                                                                  Integer chunkSize,
                                                                  Boolean autoStart,
                                                                  Boolean adaptivePolling)
                                                           throws ArangoException

Sets the configuration of the replication applier.

Parameters:: endpoint - - the logger server to connect to (e.g. "tcp://192.168.173.13:8529").; database - - the name of the database on the endpoint.; username - - an optional ArangoDB username to use when connecting to the endpoint; password - - the password to use when connecting to the endpoint.; maxConnectRetries - - the maximum number of connection attempts the applier will make in a row. If the applier cannot establish a connection to the endpoint in this number of attempts, it will stop itself.; connectTimeout - - the timeout (in seconds) when attempting to connect to the endpoint. This value is used for each connection attempt.; requestTimeout - - the timeout (in seconds) for individual requests to the endpoint.; chunkSize - - the requested maximum size for log transfer packets that is used when the endpoint is contacted.; autoStart - - whether or not to auto-start the replication applier on (next and following) server starts; adaptivePolling - - if set to true, the replication applier will fall to sleep for an increasingly long period in case the logger server at the endpoint does not have any more replication events to apply.
Returns:: ReplicationApplierConfigEntity
Throws:: ArangoException

setReplicationApplierConfig
```
public ReplicationApplierConfigEntity setReplicationApplierConfig(ReplicationApplierConfigEntity replicationApplierConfigEntity)
                                                           throws ArangoException
```
Sets the configuration of the replication applier.

Parameters:

replicationApplierConfigEntity - - an instance of ReplicationApplierConfigEntity containing the complete config

Returns:

ReplicationApplierConfigEntity

Throws:

ArangoException

startReplicationApplier
```
public ReplicationApplierStateEntity startReplicationApplier(Long from)
                                                      throws ArangoException
```
Starts the replication applier. This will return immediately if the replication applier is already running.

Parameters:

from - - The remote lastLogTick value from which to start applying.

Returns:

ReplicationApplierStateEntity

Throws:

ArangoException

stopReplicationApplier
```
public ReplicationApplierStateEntity stopReplicationApplier()
                                                     throws ArangoException
```
Stops the replication applier. This will return immediately if the replication applier is not running.

Returns:

ReplicationApplierStateEntity

Throws:

ArangoException

getReplicationApplierState
```
public ReplicationApplierStateEntity getReplicationApplierState()
                                                         throws ArangoException
```
Returns the state of the replication applier, regardless of whether the applier is currently running or not.

Returns:

ReplicationApplierStateEntity

Throws:

ArangoException

getGraphs
```
public GraphsEntity getGraphs()
                       throws ArangoException
```
Returns a GraphsEntity containing all graph as GraphEntity object of the default database.

Returns:

GraphsEntity Object containing all graphs of the database.

Throws:

ArangoException

getGraphList
```
public List<String> getGraphList()
                          throws ArangoException
```
Creates a list of the names of all available graphs of the default database.

Returns:

List All graph names of the database.

Throws:

ArangoException

createGraph

public GraphEntity createGraph(String graphName,
                               List<EdgeDefinitionEntity> edgeDefinitions,
                               List<String> orphanCollections,
                               Boolean waitForSync)
                        throws ArangoException

Creates a graph.

Parameters:: graphName - The name of the graph to be created.; edgeDefinitions - List of the graphs edge definitions.; orphanCollections - List of the graphs orphan collections.; waitForSync - Wait for sync.
Returns:: GraphEntity The new graph.
Throws:: ArangoException

createGraph

public GraphEntity createGraph(String graphName,
                               Boolean waitForSync)
                        throws ArangoException

Creates an empty graph.

Parameters:: graphName - The name of the graph to be created.; waitForSync - Wait for sync.
Returns:: GraphEntity The new graph.
Throws:: ArangoException

getGraph
```
public GraphEntity getGraph(String graphName)
                     throws ArangoException
```
Get graph object by name, including its edge definitions and vertex collections.

Parameters:

graphName - The name of the graph.

Returns:

GraphEntity The graph.

Throws:

ArangoException

deleteGraph
```
public DeletedEntity deleteGraph(String graphName)
                          throws ArangoException
```
Delete a graph by its name. The collections of the graph will not be dropped.

Parameters:

graphName - Name of the graph to be deleted.

Returns:

DeletedEntity

Throws:

ArangoException

deleteGraph
```
public void deleteGraph(String graphName,
                        Boolean dropCollections)
                 throws ArangoException
```
Delete a graph by its name. If dropCollections is true, all collections of the graph will be dropped, if they are not used in another graph.

Parameters:

graphName - Name of the graph to be deleted.

dropCollections - Indicates if the collections of the graph will be dropped

Throws:

ArangoException

graphGetVertexCollections
```
public List<String> graphGetVertexCollections(String graphName)
                                       throws ArangoException
```
Returns a list of all vertex collection of a graph that are defined in the graphs edgeDefinitions (in "from", "to", and "orphanCollections")

Parameters:

graphName - The graph name.

Returns:

List List of the names of the vertex collections

Throws:

ArangoException

graphDeleteVertexCollection

public DeletedEntity graphDeleteVertexCollection(String graphName,
                                                 String collectionName,
                                                 Boolean dropCollection)
                                          throws ArangoException

Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph.

Parameters:: graphName - The graph name.; collectionName - The name of the vertex collection to be removed from the graph.; dropCollection - Indicates if the collection will be dropped
Throws:: ArangoException

graphCreateVertexCollection

public GraphEntity graphCreateVertexCollection(String graphName,
                                               String collectionName)
                                        throws ArangoException

Creates a vertex collection

Parameters:: graphName - The graph name.; collectionName - The name of the collection to be created.
Returns:: GraphEntity The graph, including the new collection.
Throws:: ArangoException

graphGetEdgeCollections
```
public List<String> graphGetEdgeCollections(String graphName)
                                     throws ArangoException
```
Returns a list of all edge collection of a graph that are defined in the graphs edgeDefinitions

Parameters:

graphName - The graph name.

Returns:

List List of the names of all edge collections of the graph.

Throws:

ArangoException

graphCreateEdgeDefinition

public GraphEntity graphCreateEdgeDefinition(String graphName,
                                             EdgeDefinitionEntity edgeDefinition)
                                      throws ArangoException

Adds a new edge definition to an existing graph

Parameters:: graphName - The graph name.; edgeDefinition - The edge definition to be added.
Returns:: GraphEntity The graph, including the new edge definition.
Throws:: ArangoException

graphReplaceEdgeDefinition
```
public GraphEntity graphReplaceEdgeDefinition(String graphName,
                                              String edgeCollectionName,
                                              EdgeDefinitionEntity edgeDefinition)
                                       throws ArangoException
```
Replaces an existing edge definition to an existing graph. This will also change the edge definitions of all other graphs using this definition as well.

Parameters:

graphName - The name of the graph.

edgeCollectionName - The name of the edge collection of the edge definition that has to be replaced.

edgeDefinition - The new edge definition.

Returns:

GraphEntity The graph, including the changed edge definition.

Throws:

ArangoException

graphDeleteEdgeDefinition
```
public GraphEntity graphDeleteEdgeDefinition(String graphName,
                                             String edgeCollectionName,
                                             Boolean dropCollection)
                                      throws ArangoException
```
Removes an existing edge definition from this graph. All data stored in the collections is dropped as well as long as it is not used in other graphs.

Parameters:

graphName - The name of the graph.

edgeCollectionName - The name of edge collection of the edge definition which has to be deleted.

Returns:

The graph, excluding the deleted edge definition.

Throws:

ArangoException

graphCreateVertex

public <T> DocumentEntity<T> graphCreateVertex(String graphName,
                                               String collectionName,
                                               T vertex,
                                               Boolean waitForSync)
                                        throws ArangoException

Stores a new vertex with the information contained within the document into the given collection.

Parameters:: graphName - The name of the graph.; collectionName - The name of the collection, where the vertex will be created.; vertex - The vertex object to be stored; waitForSync - Wait for sync.
Returns:: DocumentEntity The resulting DocumentEntity containing the vertex document.
Throws:: ArangoException

graphGetVertex

public <T> DocumentEntity<T> graphGetVertex(String graphName,
                                            String collectionName,
                                            String key,
                                            Class<?> clazz)
                                     throws ArangoException

Gets a vertex with the given key if it is contained within your graph.

Parameters:: graphName - The name of the graph.; collectionName - The collection, containing the vertex to get.; key - The key (document handle) of the vertex to get.; clazz - The class of the vertex to get.
Returns:: DocumentEntity The resulting DocumentEntity containing the vertex document.
Throws:: ArangoException

graphGetVertex

public <T> DocumentEntity<T> graphGetVertex(String graphName,
                                            String collectionName,
                                            String key,
                                            Class<?> clazz,
                                            Long ifNoneMatchRevision,
                                            Long ifMatchRevision)
                                     throws ArangoException

Gets a vertex with the given key if it is contained within your graph.

Parameters:: graphName - The name of the graph.; collectionName - The collection, containing the vertex to get.; key - The key (document handle) of the vertex to get.; clazz - The class of the vertex to get.; ifMatchRevision - If not null the revision of the vertex in the database has to be equal to return a document.; ifNoneMatchRevision - If not null the revision of the vertex in the database has to be different to return a document.
Returns:: DocumentEntity The resulting DocumentEntity containing the vertex document.
Throws:: ArangoException

graphDeleteVertex
```
public DeletedEntity graphDeleteVertex(String graphName,
                                       String collectionName,
                                       String key)
                                throws ArangoException
```
Deletes a vertex with the given key, if it is contained within the graph. Furthermore all edges connected to this vertex will be deleted.

Parameters:

graphName - The name of the graph.

collectionName - The collection, containing the vertex to delete.

key - The key (document handle) of the vertex to delete.

Returns:

DeletedEntity

Throws:

ArangoException

graphDeleteVertex

public DeletedEntity graphDeleteVertex(String graphName,
                                       String collectionName,
                                       String key,
                                       Boolean waitForSync)
                                throws ArangoException

Deletes a vertex with the given key, if it is contained within the graph. Furthermore all edges connected to this vertex will be deleted.

Parameters:: graphName - The name of the graph.; collectionName - The collection, containing the vertex to delete.; key - The key (document handle) of the vertex to delete.; waitForSync - Wait for sync.
Returns:: DeletedEntity
Throws:: ArangoException

graphDeleteVertex

public DeletedEntity graphDeleteVertex(String graphName,
                                       String collectionName,
                                       String key,
                                       Boolean waitForSync,
                                       Long ifMatchRevision,
                                       Long ifNoneMatchRevision)
                                throws ArangoException

Deletes a vertex with the given key, if it is contained within the graph. Furthermore all edges connected to this vertex will be deleted.

Parameters:: graphName - The name of the graph.; collectionName - The collection, containing the vertex to delete.; key - The key (document handle) of the vertex to delete.; waitForSync - Wait for sync.; ifMatchRevision - If not null the revision of the vertex in the database has to be equal to return a document.; ifNoneMatchRevision - If not null the revision of the vertex in the database has to be different to return a document.
Returns:: DeletedEntity
Throws:: ArangoException

graphReplaceVertex

public <T> DocumentEntity<T> graphReplaceVertex(String graphName,
                                                String collectionName,
                                                String key,
                                                Object vertex)
                                         throws ArangoException

Replaces a vertex with the given key by the content in the body. This will only run successfully if the vertex is contained within the graph.

Parameters:: graphName - The name of the graph.; collectionName - The collection, containing the vertex to replace.; key - The key (document handle) of the vertex to replace.; vertex - The object to replace the existing vertex.
Returns:: DocumentEntity
Throws:: ArangoException

graphReplaceVertex

public <T> DocumentEntity<T> graphReplaceVertex(String graphName,
                                                String collectionName,
                                                String key,
                                                Object vertex,
                                                Boolean waitForSync,
                                                Long ifMatchRevision,
                                                Long ifNoneMatchRevision)
                                         throws ArangoException

Replaces a vertex with the given key by the content in the body. This will only run successfully if the vertex is contained within the graph.

Parameters:: graphName - The name of the graph.; collectionName - The collection, containing the vertex to replace.; key - The key (document handle) of the vertex to replace.; vertex - The object to replace the existing vertex.; waitForSync - Wait for sync.; ifMatchRevision - If not null the revision of the vertex in the database has to be equal to replace the document.; ifNoneMatchRevision - If not null the revision of the vertex in the database has to be different to replace the document.
Returns:
Throws:: ArangoException

graphUpdateVertex

public <T> DocumentEntity<T> graphUpdateVertex(String graphName,
                                               String collectionName,
                                               String key,
                                               Object vertex,
                                               Boolean keepNull)
                                        throws ArangoException

Updates a vertex with the given key by adding the content in the body. This will only run successfully if the vertex is contained within the graph.

Parameters:: graphName - The name of the graph.; collectionName - The collection, containing the vertex to update.; key - The key (document handle) of the vertex to be updated.; vertex - The object to update the existing vertex.; keepNull -
Returns:: DocumentEntity
Throws:: ArangoException

graphUpdateVertex

public <T> DocumentEntity<T> graphUpdateVertex(String graphName,
                                               String collectionName,
                                               String key,
                                               Object vertex,
                                               Boolean keepNull,
                                               Boolean waitForSync,
                                               Long ifMatchRevision,
                                               Long ifNoneMatchRevision)
                                        throws ArangoException

Updates a vertex with the given key by adding the content in the body. This will only run successfully if the vertex is contained within the graph.

Parameters:: graphName - The name of the graph.; collectionName - The collection, containing the vertex to update.; key - The key (document handle) of the vertex to be updated.; vertex - The object to update the existing vertex.; keepNull -; waitForSync - Wait for sync.; ifMatchRevision - If not null the revision of the vertex in the database has to be equal to update the document.; ifNoneMatchRevision - If not null the revision of the vertex in the database has to be different to update the document.
Returns:: DocumentEntity
Throws:: ArangoException

graphCreateEdge

public <T> EdgeEntity<T> graphCreateEdge(String graphName,
                                         String edgeCollectionName,
                                         String fromHandle,
                                         String toHandle,
                                         Object value,
                                         Boolean waitForSync)
                                  throws ArangoException

Stores a new edge with the information contained within the body into the given collection.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection where the edge will be created.; fromHandle - Document handle of vertex, where the edge comes from.; toHandle - Document handle of vertex, where the edge goes to.; value - Object to be stored with edge.; waitForSync - Wait for sync.
Returns:: EdgeEntity
Throws:: ArangoException

graphCreateEdge

public <T> EdgeEntity<T> graphCreateEdge(String graphName,
                                         String edgeCollectionName,
                                         String key,
                                         String fromHandle,
                                         String toHandle,
                                         Object value,
                                         Boolean waitForSync)
                                  throws ArangoException

Stores a new edge with the information contained within the body into the given collection.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection where the edge will be created.; key - The key of the edge to create (has to be unique).; fromHandle - Document handle of vertex, where the edge comes from.; toHandle - Document handle of vertex, where the edge goes to.; value - Object to be stored with edge.; waitForSync - Wait for sync.
Returns:: EdgeEntity
Throws:: ArangoException

graphCreateEdge

public <T> EdgeEntity<T> graphCreateEdge(String graphName,
                                         String edgeCollectionName,
                                         String key,
                                         String fromHandle,
                                         String toHandle)
                                  throws ArangoException

Stores a new edge with the information contained within the body into the given collection.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection where the edge will be created.; key - The key of the edge to create (has to be unique).; fromHandle - Document handle of vertex, where the edge comes from.; toHandle - Document handle of vertex, where the edge goes to.
Returns:: EdgeEntity
Throws:: ArangoException

graphGetEdge

public <T> EdgeEntity<T> graphGetEdge(String graphName,
                                      String edgeCollectionName,
                                      String key,
                                      Class<?> clazz,
                                      Long ifMatchRevision,
                                      Long ifNoneMatchRevision)
                               throws ArangoException

Loads an edge with the given key if it is contained within your graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to get.; key - The key of the edge to get.; clazz - The class of the edge to get.; ifMatchRevision - If not null the revision of the vertex in the database has to be equal to load the edge.; ifNoneMatchRevision - If not null the revision of the vertex in the database has to be different to load the edge.
Returns:: EdgeEntity
Throws:: ArangoException

graphGetEdge

public <T> EdgeEntity<T> graphGetEdge(String graphName,
                                      String edgeCollectionName,
                                      String key,
                                      Class<?> clazz)
                               throws ArangoException

Loads an edge with the given key if it is contained within your graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to get.; key - The key of the edge to get.; clazz - The class of the edge to get.
Returns:: EdgeEntity
Throws:: ArangoException

graphDeleteEdge

public DeletedEntity graphDeleteEdge(String graphName,
                                     String edgeCollectionName,
                                     String key)
                              throws ArangoException

Deletes an edge with the given id, if it is contained within the graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to delete.; key - The key of the edge to delete.
Returns:: DeletedEntity
Throws:: ArangoException

graphDeleteEdge

public DeletedEntity graphDeleteEdge(String graphName,
                                     String edgeCollectionName,
                                     String key,
                                     Boolean waitForSync)
                              throws ArangoException

Deletes an edge with the given id, if it is contained within the graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to delete.; key - The key of the edge to delete.; waitForSync - Wait for sync.
Returns:
Throws:: ArangoException

graphDeleteEdge

public DeletedEntity graphDeleteEdge(String graphName,
                                     String edgeCollectionName,
                                     String key,
                                     Boolean waitForSync,
                                     Long ifMatchRevision,
                                     Long ifNoneMatchRevision)
                              throws ArangoException

Deletes an edge with the given id, if it is contained within the graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to delete.; key - The key of the edge to delete.; waitForSync - Wait for sync.; ifMatchRevision - If not null the revision of the vertex in the database has to be equal to delete the edge.; ifNoneMatchRevision - If not null the revision of the vertex in the database has to be different to delete the edge.
Returns:: DeletedEntity
Throws:: ArangoException

graphReplaceEdge

public <T> EdgeEntity<T> graphReplaceEdge(String graphName,
                                          String edgeCollectionName,
                                          String key,
                                          Object value)
                                   throws ArangoException

Replaces an edge with the given key by the content in the body. This will only run successfully if the edge is contained within the graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to replace.; key - The key of the edge to replace.; value - The object to replace the existing edge.
Returns:
Throws:: ArangoException

graphReplaceEdge

public <T> EdgeEntity<T> graphReplaceEdge(String graphName,
                                          String edgeCollectionName,
                                          String key,
                                          Object value,
                                          Boolean waitForSync,
                                          Long ifMatchRevision,
                                          Long ifNoneMatchRevision)
                                   throws ArangoException

Replaces an edge with the given key by the content in the body. This will only run successfully if the edge is contained within the graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to replace.; key - The key of the edge to replace.; value - The object to replace the existing edge.; waitForSync - Wait for sync.; ifMatchRevision - If not null the revision of the vertex in the database has to be equal to replace the edge.; ifNoneMatchRevision - If not null the revision of the vertex in the database has to be different to replace the edge.
Returns:: EdgeEntity
Throws:: ArangoException

graphUpdateEdge

public <T> EdgeEntity<T> graphUpdateEdge(String graphName,
                                         String edgeCollectionName,
                                         String key,
                                         Object value,
                                         Boolean keepNull)
                                  throws ArangoException

Updates an edge with the given key by adding the content in the body. This will only run successfully if the edge is contained within the graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to update.; key - The key of the edge to update.; value - The object to update the existing edge.; keepNull -
Returns:: EdgeEntity
Throws:: ArangoException

graphUpdateEdge

public <T> EdgeEntity<T> graphUpdateEdge(String graphName,
                                         String edgeCollectionName,
                                         String key,
                                         Object value,
                                         Boolean waitForSync,
                                         Boolean keepNull,
                                         Long ifMatchRevision,
                                         Long ifNoneMatchRevision)
                                  throws ArangoException

Updates an edge with the given key by adding the content in the body. This will only run successfully if the edge is contained within the graph.

Parameters:: graphName - The name of the graph.; edgeCollectionName - The name of the collection containing edge to update.; key - The key of the edge to update.; value - The object to update the existing edge.; waitForSync - Wait for sync.; keepNull -; ifMatchRevision - If not null the revision of the vertex in the database has to be equal to update the edge.; ifNoneMatchRevision - If not null the revision of the vertex in the database has to be different to update the edge.
Returns:
Throws:: ArangoException

graphGetEdges
```
public CursorEntity<PlainEdgeEntity> graphGetEdges(String graphName)
                                            throws ArangoException
```
Returns all Edges of a graph, each edge as a PlainEdgeEntity.

Parameters:

graphName - The name of the graph.

Returns:

CursorEntity

Throws:

ArangoException

graphGetEdges

public <T> CursorEntity<T> graphGetEdges(String graphName,
                                         Class<T> clazz,
                                         String vertexDocumentHandle)
                                  throws ArangoException

Returns all Edges of a given vertex.

Parameters:: graphName -; clazz -; vertexDocumentHandle -
Returns:: CursorEntity
Throws:: ArangoException

graphGetEdgesByExampleObject

public <T,S> CursorEntity<T> graphGetEdgesByExampleObject(String graphName,
                                                          Class<T> clazzT,
                                                          S vertexExample)
                                                   throws ArangoException

Returns all Edges of vertices matching the example object (non-primitive set to null will not be used for comparing).

Parameters:: graphName -; clazzT -; vertexExample -
Returns:: CursorEntity
Throws:: ArangoException

graphGetEdgesByExampleMap

public <T> CursorEntity<T> graphGetEdgesByExampleMap(String graphName,
                                                     Class<T> clazzT,
                                                     Map<String,Object> vertexExample)
                                              throws ArangoException

Returns all Edges of vertices matching the map.

Parameters:: graphName - The name of the graph.; clazzT - Class of returned edge documents.; vertexExample - Map with example of vertex, where edges start or end.
Returns:: CursorEntity
Throws:: ArangoException

createAqlFunction

public DefaultEntity createAqlFunction(String name,
                                       String code)
                                throws ArangoException

Creates an AQL Function

Parameters:: name - - the name of the function as string; code - - the function as javascript string
Returns:: DefaultEntity
Throws:: ArangoException

getAqlFunctions
```
public AqlFunctionsEntity getAqlFunctions(String namespace)
                                   throws ArangoException
```
Gets all AQL functions whithin a given namespace

Parameters:

namespace - - the namespace

Returns:

AqlFunctionsEntity

Throws:

ArangoException

deleteAqlFunction
```
public DefaultEntity deleteAqlFunction(String name,
                                       boolean isNameSpace)
                                throws ArangoException
```
Delete an AQL function. If *isNameSpace* is set to true all functions within the namespace *name* are deleted.

Parameters:

name - - This is either the name of a function or a namespace

isNameSpace - - If set to true the param *name* is treated as a namespace

Returns:

DefaultEntity

Throws:

ArangoException

createTransaction
```
public TransactionEntity createTransaction(String action)
```
Creates a transaction entity.

Parameters:

action - - the transaction as javascript code

Returns:

TransactionEntity

executeTransaction
```
public TransactionResultEntity executeTransaction(TransactionEntity transactionEntity)
                                           throws ArangoException
```
Executes the transaction on the database server.

Parameters:

transactionEntity - - The configuration object containing all data for the transaction

Returns:

TransactionResultEntity

Throws:

ArangoException

Class ArangoDriver

Constructor Summary

Method Summary

Methods inherited from class com.arangodb.BaseArangoDriver

Methods inherited from class java.lang.Object

Constructor Detail

ArangoDriver

ArangoDriver

Method Detail

startBatchMode

startAsyncMode

stopAsyncMode

getLastJobId

getJobIds

getJobs

getJobs

deleteAllJobs

deleteJobById

deleteExpiredJobs

getJobResult

executeBatch

getBatchResponseByRequestId

cancelBatchMode

getDefaultDatabase

setDefaultDatabase

createCollection

createCollection

getCollection

getCollection

getCollectionProperties

getCollectionProperties

getCollectionRevision

getCollectionRevision

getCollectionCount

getCollectionCount

getCollectionFigures

getCollectionFigures

getCollectionChecksum

getCollections

getCollections

loadCollection

loadCollection

loadCollection

loadCollection

unloadCollection

unloadCollection

truncateCollection

truncateCollection

setCollectionProperties

setCollectionProperties

renameCollection

renameCollection

deleteCollection

deleteCollection

createDocument

createDocument

createDocument

createDocument

createDocument

createDocument

createDocument

createDocument

replaceDocument

replaceDocument

replaceDocument

replaceDocument

replaceDocument

replaceDocument

replaceDocument

replaceDocument

replaceDocument

replaceDocument

updateDocument

updateDocument

updateDocument

updateDocument

updateDocument

updateDocument

updateDocument

updateDocument