ArangoDriver (arangodb-java-driver 3.1.0 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, fbartels, a-brandt

See Also:

ArangoDB documentation

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 Deprecated Methods
Modifier and Type	Method and Description
`void`	`cancelBatchMode()` This method cancels the batch execution mode.
`String`	`checkDocument(String documentHandle)` This method returns the current revision of a document.
`String`	`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
`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
`<T> DocumentEntity<T>`	`createDocument(String collectionName, String documentKey, T value)` Creates a document in the collection defined by the collection's name.
`<T> DocumentEntity<T>`	`createDocument(String collectionName, String documentKey, T value, Boolean waitForSync)` Creates a document in the collection defined by the collection's name.
`<T> DocumentEntity<T>`	`createDocument(String collectionName, T value)` Creates a document in the collection defined by the collection's name
`<T> DocumentEntity<T>`	`createDocument(String collectionName, T value, Boolean waitForSync)` Creates a document in the collection defined by the collection's name.
`DocumentEntity<String>`	`createDocumentRaw(String collectionName, String rawJsonString, Boolean waitForSync)` Creates a document in the collection defined by the collection's name
`<T> EdgeEntity<T>`	`createEdge(String collectionName, String documentKey, T value, String fromHandle, String toHandle, Boolean waitForSync)` Create an edge in an edge collection.
`<T> EdgeEntity<T>`	`createEdge(String collectionName, T value, String fromHandle, String toHandle, Boolean waitForSync)` Create an edge in an edge collection.
`BooleanResultEntity`	`createEndpoint(String endpoint, String... databases)` This method creates an endpoint.
`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(GraphEntity graph, Boolean waitForSync)` Creates a graph.
`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, boolean sparse, String... fields)` This method creates a hash index for a collection.
`IndexEntity`	`createHashIndex(String collectionName, boolean unique, String... fields)` This method creates a hash index for a collection.
`IndexEntity`	`createIndex(String collectionName, IndexType type, boolean unique, boolean sparse, 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`	`createPersistentIndex(String collectionName, boolean unique, boolean sparse, String... fields)` It is possible to define a persistent index on one or more attributes (or paths) of documents.
`IndexEntity`	`createSkipListIndex(String collectionName, boolean unique, boolean sparse, String... fields)` This method creates a skip list 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(String name)` Deletes a collection by name.
`BooleanResultEntity`	`deleteDatabase(String database)` This method deletes a database
`DocumentEntity<?>`	`deleteDocument(String documentHandle)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(String collectionName, String documentKey)` Deletes a document from the database.
`DocumentEntity<?>`	`deleteDocument(String collectionName, String documentKey, String rev)` 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`	`deleteQueryCache()` Clears the AQL query cache (since ArangoDB 2.7)
`DefaultEntity`	`deleteSlowQueries()` Clears the list of slow AQL queries of the default database
`DefaultEntity`	`deleteSlowQueries(String database)` Clears the list of slow AQL queries of the default database
`DefaultEntity`	`deleteUser(String username)` Deletes a database user.
`<T> CursorResult<T>`	`executeAqlQuery(String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions, Class<T> clazz)` This method executes an AQL query and returns a CursorResult
`String`	`executeAqlQueryJSON(String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions)` Executes an AQL query and returns the raw JSON response
`CursorRawResult`	`executeAqlQueryRaw(String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions)` This method executes an AQL query and returns a CursorRawResult.
`<T,S extends DocumentEntity<T>> DocumentCursorResult<T,S>`	`executeAqlQueryWithDocumentCursorResult(String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions, Class<S> classDocumentEntity, Class<T> clazz)` This method executes an AQL query and returns a DocumentCursorResult
`DefaultEntity`	`executeBatch()` This method sends all stacked requests as batch to ArangoDB.
`<T> CursorEntity<T>`	`executeCursorEntityQuery(String query, Map<String,Object> bindVars, Boolean calcCount, Integer batchSize, Boolean fullCount, Class<?>... clazz)` This method executes an AQL query and returns a CursorEntity.
`<T> DocumentCursor<T>`	`executeDocumentQuery(String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions, Class<T> clazz)` This method executes an AQL query and returns a DocumentCursor
`<T> EdgeCursor<T>`	`executeEdgeQuery(String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions, Class<T> clazz)` Returns edges as an EdgeCursor by a given query
`DefaultEntity`	`executeScript(String jsCode)` Executes a javascript code.
`<T> DocumentCursor<T>`	`executeSimpleAllDocuments(String collectionName, int skip, int limit, Class<T> clazz)` Returns all documents of a collections.
`<T> ScalarExampleEntity<T>`	`executeSimpleAny(String collectionName, Class<T> clazz)` Returns a random document from the collection
`<T> DocumentCursor<T>`	`executeSimpleByExampleDocuments(String collectionName, Map<String,Object> example, int skip, int limit, Class<T> clazz)` This will find all documents matching a given example.
`<T> ScalarExampleEntity<T>`	`executeSimpleFirstExample(String collectionName, Map<String,Object> example, Class<T> clazz)` Returns the first document matching the example
`<T> DocumentCursor<T>`	`executeSimpleFulltextWithDocuments(String collectionName, String attribute, String query, int skip, int limit, String index, Class<T> clazz)` This will find all documents from the collection that match the fulltext query specified in query.
`<T> DocumentCursor<T>`	`executeSimpleRangeWithDocuments(String collectionName, String attribute, Object left, Object right, Boolean closed, int skip, int limit, Class<T> 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.
`<T> VertexCursor<T>`	`executeVertexQuery(String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions, Class<T> clazz)` Returns vertices as a VertexCursor by a given query
`boolean`	`exists(String documentHandle)` The exists method determines whether a document exists given its identifier.
`boolean`	`exists(String collectionName, String documentKey)` The exists method determines whether a document exists given its identifier.
`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(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(String name)` Returns a collection from ArangoDB by name including the document count
`CollectionEntity`	`getCollectionFigures(String name)` Returns a collection from ArangoDB by name including the collection figures
`CollectionEntity`	`getCollectionProperties(String name)` Returns a collection from ArangoDB including all properties by name
`CollectionsEntity`	`getCollections()` Returns all collections from ArangoDB
`CollectionsEntity`	`getCollections(Boolean excludeSystem)` Returns all collections from ArangoDB
`DatabaseEntity`	`getCurrentDatabase()` Returns the current database
`QueriesResultEntity`	`getCurrentlyRunningQueries()` Returns a list of currently running AQL queries of the default database
`QueriesResultEntity`	`getCurrentlyRunningQueries(String database)` Returns a list of currently running AQL queries of a 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
`AqlQueryOptions`	`getDefaultAqlQueryOptions()` Creates a default AqlQueryOptions object
`String`	`getDefaultDatabase()` Returns the default database.
`<T> DocumentEntity<T>`	`getDocument(String documentHandle, Class<T> clazz)` Returns a document entity.
`<T> DocumentEntity<T>`	`getDocument(String documentHandle, Class<T> clazz, String ifNoneMatchRevision, String ifMatchRevision)` Returns a document entity.
`<T> DocumentEntity<T>`	`getDocument(String collectionName, String documentKey, Class<T> clazz)` Returns a document entity.
`String`	`getDocumentRaw(String documentHandle, String ifNoneMatchRevision, String ifMatchRevision)` Returns the document as a JSON string.
`List<String>`	`getDocuments(String collectionName)` 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.
`HttpManager`	`getHttpManager()` Returns the HTTP manager of the driver
`IndexEntity`	`getIndex(String indexHandle)` Returns an index from a collection.
`IndexesEntity`	`getIndexes(String collectionName)` Returns all indices from a collection.
`List<String>`	`getJobIds()` Returns a list of all job identifiers 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 identifiers of asynchronous executed jobs, filtered by job state.
`List<String>`	`getJobs(JobsEntity.JobState jobState, int count)` Returns a list of all job identifiers of asynchronous executed jobs, filtered by job state.
`String`	`getLastJobId()` Returns the identifier of the last asynchronous executed job.
`QueryCachePropertiesEntity`	`getQueryCacheProperties()` Returns the global configuration for the AQL query cache (since ArangoDB 2.7)
`QueryTrackingPropertiesEntity`	`getQueryTrackingProperties()` Returns the configuration for the AQL query tracking
`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.
`QueriesResultEntity`	`getSlowQueries()` Returns a list of slow running AQL queries of the default database
`QueriesResultEntity`	`getSlowQueries(String database)` Returns a list of slow running AQL queries of a database
`StatisticsEntity`	`getStatistics()` Returns the current statistics
`StatisticsDescriptionEntity`	`getStatisticsDescription()` Returns the statistics description
`ArangoUnixTime`	`getTime()` Returns the current server time
`<V,E> TraversalEntity<V,E>`	`getTraversal(TraversalQueryOptions traversalQueryOptions, Class<V> vertexClazz, Class<E> edgeClazz)` Do a graph traversal.
`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
`DefaultEntity`	`grantDatabaseAccess(String username, String database)` Grants the User access to the given database.
`<T> EdgeEntity<T>`	`graphCreateEdge(String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle)` Stores a new edge with no further information into the given collection.
`<T> EdgeEntity<T>`	`graphCreateEdge(String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle, T 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 fromHandle, String toHandle, T 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> VertexEntity<T>`	`graphCreateVertex(String graphName, String collectionName, String key, T vertex, Boolean waitForSync)` Stores a new vertex with the information contained within the document into the given collection.
`<T> VertexEntity<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, String ifMatchRevision, String 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, String ifMatchRevision, String 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<T> 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<T> clazz, String ifMatchRevision, String 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
`EdgeCursor<PlainEdgeEntity>`	`graphGetEdgeCursor(String graphName)` Returns all Edges of a graph, each edge as a PlainEdgeEntity.
`<T> EdgeCursor<T>`	`graphGetEdgeCursor(String graphName, Class<T> clazz, Object vertexExample, GraphEdgesOptions graphEdgesOptions, AqlQueryOptions aqlQueryOptions)` Deprecated. use AQL instead
`<T> EdgeCursor<T>`	`graphGetEdgeCursorByExample(String graphName, Class<T> clazz, Object vertexExample)` Returns all Edges of a given vertex.
`<V,E> ShortestPathEntity<V,E>`	`graphGetShortestPath(String graphName, Object startVertexExample, Object endVertexExample, ShortestPathOptions shortestPathOptions, Class<V> vertexClass, Class<E> edgeClass)` Deprecated. use AQL instead
`<T> VertexEntity<T>`	`graphGetVertex(String graphName, String collectionName, String key, Class<T> clazz)` Gets a vertex with the given key if it is contained within your graph.
`<T> VertexEntity<T>`	`graphGetVertex(String graphName, String collectionName, String key, Class<T> clazz, String ifNoneMatchRevision, String 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")
`List<String>`	`graphGetVertexCollections(String graphName, boolean excludeOrphan)` Returns a list of all vertex collection of a graph that are defined in the graphs edgeDefinitions (in "from", "to", and "orphanCollections")
`<T> VertexCursor<T>`	`graphGetVertexCursor(String graphName, Class<T> clazz, Object vertexExample, GraphVerticesOptions graphVerticesOptions, AqlQueryOptions aqlQueryOptions)` Deprecated. use AQL instead
`<T> EdgeEntity<T>`	`graphReplaceEdge(String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle, T value)` Replaces an edge with the given key by the content in the body.
`<T> EdgeEntity<T>`	`graphReplaceEdge(String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle, T value, Boolean waitForSync, String ifMatchRevision, String 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> VertexEntity<T>`	`graphReplaceVertex(String graphName, String collectionName, String key, T vertex)` Replaces a vertex with the given key by the content in the body.
`<T> VertexEntity<T>`	`graphReplaceVertex(String graphName, String collectionName, String key, T vertex, Boolean waitForSync, String ifMatchRevision, String ifNoneMatchRevision)` Replaces a vertex with the given key by the content in the body.
`<T> EdgeEntity<T>`	`graphUpdateEdge(String graphName, String edgeCollectionName, String key, String fromHandle, String toHandle, T 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, String fromHandle, String toHandle, T value, Boolean waitForSync, Boolean keepNull, String ifMatchRevision, String ifNoneMatchRevision)` Updates an edge with the given key by adding the content in the body.
`<T> VertexEntity<T>`	`graphUpdateVertex(String graphName, String collectionName, String key, T vertex, Boolean keepNull)` Updates a vertex with the given key by adding the content in the body.
`<T> VertexEntity<T>`	`graphUpdateVertex(String graphName, String collectionName, String key, T vertex, Boolean keepNull, Boolean waitForSync, String ifMatchRevision, String ifNoneMatchRevision)` Updates a vertex with the given key by adding the content in the body.
`ImportResultEntity`	`importDocuments(String collection, Collection<?> values)` Creates documents in a collection.
`ImportResultEntity`	`importDocuments(String collection, Collection<?> values, ImportOptionsJson importOptionsJson)` Creates documents in a collection.
`ImportResultEntity`	`importDocumentsByHeaderValues(String collection, Collection<? extends Collection<?>> headerValues)` Creates documents in a collection.
`ImportResultEntity`	`importDocumentsByHeaderValues(String collection, Collection<? extends Collection<?>> headerValues, ImportOptions importOptions)` Creates documents in a collection.
`ImportResultEntity`	`importDocumentsByHeaderValuesRaw(String collection, String headerValues, ImportOptions importOptions)` Creates documents in a collection.
`ImportResultEntity`	`importDocumentsRaw(String collection, String values, ImportOptionsRaw importOptionsRaw)` Creates documents in a collection.
`DefaultEntity`	`killQuery(String id)` Kills an AQL query
`DefaultEntity`	`killQuery(String database, String id)` Kills an AQL query
`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(String name, String newName)` Returns the collection and changes it's name.
`DocumentEntity<?>`	`replaceDocument(String collectionName, String documentKey, Object value, String rev, Boolean waitForSync)` This method replaces the content of the document defined by documentKey.
`<T> DocumentEntity<T>`	`replaceDocument(String collectionName, String documentKey, T value)` This method replaces the content of the document defined by documentKey.
`<T> DocumentEntity<T>`	`replaceDocument(String documentHandle, T value)` This method replaces the content of the document defined by documentHandle.
`<T> DocumentEntity<T>`	`replaceDocument(String documentHandle, T value, String rev, Boolean waitForSync)` This method replaces the content of the document defined by documentHandle.
`DocumentEntity<String>`	`replaceDocumentRaw(String documentHandle, String rawJsonString, String rev, Boolean waitForSync)` This method replaces the content of the document defined by documentHandle.
`DefaultEntity`	`replaceUser(String username, String passwd, Boolean active, Map<String,Object> extra)` Replaces the data of a database user.
`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.
`QueryCachePropertiesEntity`	`setQueryCacheProperties(QueryCachePropertiesEntity properties)` Changes the configuration for the AQL query cache (since ArangoDB 2.7)
`QueryTrackingPropertiesEntity`	`setQueryTrackingProperties(QueryTrackingPropertiesEntity properties)` Changes the configuration for the AQL query tracking
`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(String name)` Returns the collection and deletes all documents.
`CollectionEntity`	`unloadCollection(String name)` Returns the collection and deletes it from memory.
`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, String rev, Boolean waitForSync, Boolean keepNull)` This method updates a document defined by documentKey.
`<T> DocumentEntity<T>`	`updateDocument(String documentHandle, T value)` This method updates a document defined by documentHandle.
`<T> DocumentEntity<T>`	`updateDocument(String documentHandle, T value, Boolean keepNull)` This method updates a document defined by documentKey.
`<T> DocumentEntity<T>`	`updateDocument(String documentHandle, T value, String rev, Boolean waitForSync, Boolean keepNull)` This method updates a document defined by documentHandle.
`DocumentEntity<String>`	`updateDocumentRaw(String documentHandle, String rawJsonString, String rev, Boolean waitForSync, Boolean keepNull)` This method updates a document defined by documentHandle.
`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 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:
  
  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:
  
  configure - A configuration object.
  
  database - the name of 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:

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 identifier of the last asynchronous executed job.

Returns:

String the identifier

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 identifiers of asynchronous executed jobs.

Returns:

List the list of all job identifiers

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 identifiers of asynchronous executed jobs, filtered by job state.

Parameters:

jobState - the job state as a filter.

count - a limit for the result set.

Returns:

List list of all job identifiers

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 identifiers of asynchronous executed jobs, filtered by job state.

Parameters:

jobState - the job state as a filter.

Returns:

List list of all job identifiers

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:

jobId - the identifier 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:

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:

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:

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(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(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

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(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.; withRevisions - includes the revision into the checksum calculation; withData - includes the collections data into the checksum calculation
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(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(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(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(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(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(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(String name)
                                  throws ArangoException
```
Deletes a collection by name.

Parameters:

name - the name of the collection.

Returns:

CollectionEntity - the collectionEntity.

Throws:

ArangoException

createDocument
```
public <T> DocumentEntity<T> createDocument(String collectionName,
                                            T 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 <T> DocumentEntity<T> createDocument(String collectionName,
                                            String documentKey,
                                            T 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 <T> DocumentEntity<T> createDocument(String collectionName,
                                            T value,
                                            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

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,
                                            T value,
                                            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

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

Returns:

DocumentEntity

Throws:

ArangoException

See Also:

CollectionKeyOption.allowUserKeys

replaceDocument

public <T> DocumentEntity<T> replaceDocument(String collectionName,
                                             String documentKey,
                                             T 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,
                                             T 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(String collectionName,
                                         String documentKey,
                                         Object value,
                                         String rev,
                                         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 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.

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

Returns:

a DocumentEntity object

Throws:

ArangoException

replaceDocument
```
public <T> DocumentEntity<T> replaceDocument(String documentHandle,
                                             T value,
                                             String rev,
                                             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 an error is thrown.

Parameters:

documentHandle - The document's handle.

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

rev - the desired revision.

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

Returns:

a DocumentEntity object

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,
                                            T 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(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,
                                            T 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(String collectionName,
                                        String documentKey,
                                        Object value,
                                        String rev,
                                        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 an error is thrown.

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

updateDocument
```
public <T> DocumentEntity<T> updateDocument(String documentHandle,
                                            T value,
                                            String rev,
                                            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 an error is thrown.

Parameters:

documentHandle - The document handle.

value - An object containing the documents attributes

rev - The desired revision

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(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

exists
```
public boolean exists(String collectionName,
                      String documentKey)
               throws ArangoException
```
The exists method determines whether a document exists given its identifier. Instead of returning the found document or an error, this method will return either true or false. It can thus be used for easy existence checks.

Parameters:

collectionName - The collection name.

documentKey - The document key

Returns:

true, if the document exists

Throws:

ArangoException

exists
```
public boolean exists(String documentHandle)
               throws ArangoException
```
The exists method determines whether a document exists given its identifier. Instead of returning the found document or an error, this method will return either true or false. It can thus be used for easy existence checks.

Parameters:

documentHandle - The document handle

Returns:

true, if the document exists

Throws:

ArangoException

checkDocument
```
public String 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:

the document revision number

Throws:

ArangoException

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

Parameters:

documentHandle - The document handle

Returns:

the document revision number

Throws:

ArangoException

getDocument

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

Returns a document entity.

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:: a DocumentEntity object
Throws:: ArangoException

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

Parameters:

documentHandle - The document handle

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

Returns:

a DocumentEntity object

Throws:

ArangoException

getDocument
```
public <T> DocumentEntity<T> getDocument(String documentHandle,
                                         Class<T> clazz,
                                         String ifNoneMatchRevision,
                                         String 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.

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:

a DocumentEntity object

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:: a DocumentEntity object
Throws:: ArangoException

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

Parameters:

documentHandle - The document handle.

Returns:

a DocumentEntity object

Throws:

ArangoException

deleteDocument
```
public DocumentEntity<?> deleteDocument(String collectionName,
                                        String documentKey,
                                        String rev)
                                 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 an error is thrown.

Parameters:

collectionName - The collection name.

documentKey - The document key.

rev - The desired revision

Returns:

a DocumentEntity object

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:

a CursorEntity object

Throws:

ArangoException

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

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:

a CursorEntity object

Throws:

ArangoException

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

Parameters:

cursorId - The id of a cursor.

Returns:

a DefaultEntity object

Throws:

ArangoException

executeCursorEntityQuery

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

This method executes an AQL query and returns a CursorEntity.

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 (The batch size has to be greater than 0); fullCount - if set to true, then all results before the final LIMIT will be counted
Returns:: a CursorEntity object
Throws:: ArangoException

getDefaultAqlQueryOptions
```
public AqlQueryOptions getDefaultAqlQueryOptions()
```
Creates a default AqlQueryOptions object

Returns:

default AqlQueryOptions object

executeDocumentQuery

public <T> DocumentCursor<T> executeDocumentQuery(String query,
                                                  Map<String,Object> bindVars,
                                                  AqlQueryOptions aqlQueryOptions,
                                                  Class<T> clazz)
                                           throws ArangoException

This method executes an AQL query and returns a DocumentCursor

Parameters:: query - an AQL query as string; bindVars - a map containing all bind variables,; aqlQueryOptions - AQL query options (null for default values); clazz - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: DocumentCursor
Throws:: ArangoException

executeAqlQuery

public <T> CursorResult<T> executeAqlQuery(String query,
                                           Map<String,Object> bindVars,
                                           AqlQueryOptions aqlQueryOptions,
                                           Class<T> clazz)
                                    throws ArangoException

This method executes an AQL query and returns a CursorResult

Parameters:: query - an AQL query as string; bindVars - a map containing all bind variables,; aqlQueryOptions - AQL query options; clazz - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: CursorResult
Throws:: ArangoException

executeAqlQueryJSON

public String executeAqlQueryJSON(String query,
                                  Map<String,Object> bindVars,
                                  AqlQueryOptions aqlQueryOptions)
                           throws ArangoException

Executes an AQL query and returns the raw JSON response

Parameters:: query - an AQL query as string; bindVars - a map containing all bind variables,; aqlQueryOptions - AQL query options
Returns:: A JSON string with the results from server
Throws:: ArangoException

executeAqlQueryWithDocumentCursorResult

public <T,S extends DocumentEntity<T>> DocumentCursorResult<T,S> executeAqlQueryWithDocumentCursorResult(String query,
                                                                                                         Map<String,Object> bindVars,
                                                                                                         AqlQueryOptions aqlQueryOptions,
                                                                                                         Class<S> classDocumentEntity,
                                                                                                         Class<T> clazz)
                                                                                                  throws ArangoException

This method executes an AQL query and returns a DocumentCursorResult

Parameters:: query - an AQL query as string; bindVars - a map containing all bind variables,; aqlQueryOptions - AQL query options; classDocumentEntity - the class the expected class is wrapped in (the class has to extend DocumentEntity); clazz - the expected class, the result from the server request is deserialized to an instance of this class.
Returns:: DocumentCursorResult
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

createIndex

public IndexEntity createIndex(String collectionName,
                               IndexType type,
                               boolean unique,
                               boolean sparse,
                               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; sparse - if set to true the index will be sparse; 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

createHashIndex
```
public IndexEntity createHashIndex(String collectionName,
                                   boolean unique,
                                   boolean sparse,
                                   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

sparse - if set to true the index will be sparse

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

createSkipListIndex

public IndexEntity createSkipListIndex(String collectionName,
                                       boolean unique,
                                       boolean sparse,
                                       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; sparse - if set to true the index will be sparse; fields - the fields (document attributes) the index is created on
Returns:: IndexEntity
Throws:: ArangoException

createPersistentIndex
```
public IndexEntity createPersistentIndex(String collectionName,
                                         boolean unique,
                                         boolean sparse,
                                         String... fields)
                                  throws ArangoException
```
It is possible to define a persistent index on one or more attributes (or paths) of documents. The index is then used in queries to locate documents within a given range. If the index is declared unique, then no two documents are allowed to have the same set of attribute values.

Parameters:

collectionName - The collection name.

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

sparse - if set to true the index will be sparse

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(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(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:

a AdminLogEntity object

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

executeSimpleByExampleDocuments

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

This will find all documents matching a given example.

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:: DocumentCursor
Throws:: ArangoException

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

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:

DocumentCursor

Throws:

ArangoException

executeSimpleFirstExample

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

Returns the first document matching the example

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:: a ScalarExampleEntity object
Throws:: ArangoException

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

Parameters:

collectionName - The collection name.

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

Returns:

a ScalarExampleEntity object

Throws:

ArangoException

executeSimpleRangeWithDocuments

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

This will find all documents within a given range.

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:: DocumentCursor
Throws:: ArangoException

executeSimpleFulltextWithDocuments

public <T> DocumentCursor<T> executeSimpleFulltextWithDocuments(String collectionName,
                                                                String attribute,
                                                                String query,
                                                                int skip,
                                                                int limit,
                                                                String index,
                                                                Class<T> 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.

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:: DocumentCursor
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

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 password 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 password 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 password 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

grantDatabaseAccess

public DefaultEntity grantDatabaseAccess(String username,
                                         String database)
                                  throws ArangoException

Grants the User access to the given database.

Parameters:: username - the username as string; database -
Returns:: a DefaultEntity object
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