All Superinterfaces:: ArangoSerdeAccessor

@ThreadSafe
public interface ArangoDatabaseAsync
extends ArangoSerdeAccessor

Asynchronous version of ArangoDatabase

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CompletableFuture<StreamTransactionEntity>`	`abortStreamTransaction(String id)`	Asynchronous version of `ArangoDatabase.abortStreamTransaction(String)`
`ArangoDBAsync`	`arango()`
`ArangoSearchAsync`	`arangoSearch(String name)`	Returns a `ArangoSearchAsync` instance for the given view name.
`CompletableFuture<StreamTransactionEntity>`	`beginStreamTransaction(StreamTransactionOptions options)`	Asynchronous version of `ArangoDatabase.beginStreamTransaction(StreamTransactionOptions)`
`CompletableFuture<Void>`	`clearQueryCache()`	Asynchronous version of `ArangoDatabase.clearQueryCache()`
`CompletableFuture<Void>`	`clearSlowQueries()`	Asynchronous version of `ArangoDatabase.clearSlowQueries()`
`ArangoCollectionAsync`	`collection(String name)`	Returns a `ArangoCollectionAsync` instance for the given collection name.
`CompletableFuture<StreamTransactionEntity>`	`commitStreamTransaction(String id)`	Asynchronous version of `ArangoDatabase.commitStreamTransaction(String)`
`CompletableFuture<Boolean>`	`create()`	Asynchronous version of `ArangoDatabase.create()`
`CompletableFuture<Void>`	`createAqlFunction(String name, String code, AqlFunctionCreateOptions options)`	Asynchronous version of `ArangoDatabase.createAqlFunction(String, String, AqlFunctionCreateOptions)`
`CompletableFuture<ViewEntity>`	`createArangoSearch(String name, ArangoSearchCreateOptions options)`	Asynchronous version of `ArangoDatabase.createArangoSearch(String, ArangoSearchCreateOptions)`
`CompletableFuture<CollectionEntity>`	`createCollection(String name)`	Asynchronous version of `ArangoDatabase.createCollection(String)`
`CompletableFuture<CollectionEntity>`	`createCollection(String name, CollectionCreateOptions options)`	Asynchronous version of `ArangoDatabase.createCollection(String, CollectionCreateOptions)`
`CompletableFuture<GraphEntity>`	`createGraph(String name, Iterable<EdgeDefinition> edgeDefinitions)`	Asynchronous version of `ArangoDatabase.createGraph(String, Iterable)`
`CompletableFuture<GraphEntity>`	`createGraph(String name, Iterable<EdgeDefinition> edgeDefinitions, GraphCreateOptions options)`	Asynchronous version of `ArangoDatabase.createGraph(String, Iterable, GraphCreateOptions)`
`CompletableFuture<ViewEntity>`	`createSearchAlias(String name, SearchAliasCreateOptions options)`	Asynchronous version of `ArangoDatabase.createSearchAlias(String, SearchAliasCreateOptions)`
`CompletableFuture<SearchAnalyzer>`	`createSearchAnalyzer(SearchAnalyzer analyzer)`	Asynchronous version of `ArangoDatabase.createSearchAnalyzer(SearchAnalyzer)`
`CompletableFuture<ViewEntity>`	`createView(String name, ViewType type)`	Asynchronous version of `ArangoDatabase.createView(String, ViewType)`
`<T> CompletableFuture<ArangoCursorAsync<T>>`	`cursor(String cursorId, Class<T> type)`
`<T> CompletableFuture<ArangoCursorAsync<T>>`	`cursor(String cursorId, Class<T> type, String nextBatchId)`
`CompletableFuture<Integer>`	`deleteAqlFunction(String name, AqlFunctionDeleteOptions options)`	Asynchronous version of `ArangoDatabase.deleteAqlFunction(String, AqlFunctionDeleteOptions)`
`CompletableFuture<String>`	`deleteIndex(String id)`	Asynchronous version of `ArangoDatabase.deleteIndex(String)`
`CompletableFuture<Void>`	`deleteSearchAnalyzer(String name)`	Asynchronous version of `ArangoDatabase.deleteSearchAnalyzer(String)`
`CompletableFuture<Void>`	`deleteSearchAnalyzer(String name, AnalyzerDeleteOptions options)`	Asynchronous version of `ArangoDatabase.deleteSearchAnalyzer(String, AnalyzerDeleteOptions)`
`CompletableFuture<Boolean>`	`drop()`	Asynchronous version of `ArangoDatabase.drop()`
`CompletableFuture<Boolean>`	`exists()`	Asynchronous version of `ArangoDatabase.exists()`
`CompletableFuture<AqlExecutionExplainEntity>`	`explainQuery(String query, Map<String,Object> bindVars, AqlQueryExplainOptions options)`	Asynchronous version of `ArangoDatabase.explainQuery(String, Map, AqlQueryExplainOptions)`
`CompletableFuture<Collection<String>>`	`getAccessibleDatabases()`	Asynchronous version of `ArangoDatabase.getAccessibleDatabases()`
`CompletableFuture<Collection<AqlFunctionEntity>>`	`getAqlFunctions(AqlFunctionGetOptions options)`	Asynchronous version of `ArangoDatabase.getAqlFunctions(AqlFunctionGetOptions)`
`CompletableFuture<Collection<CollectionEntity>>`	`getCollections()`	Asynchronous version of `ArangoDatabase.getCollections()`
`CompletableFuture<Collection<CollectionEntity>>`	`getCollections(CollectionsReadOptions options)`	Asynchronous version of `ArangoDatabase.getCollections(CollectionsReadOptions)`
`CompletableFuture<Collection<QueryEntity>>`	`getCurrentlyRunningQueries()`	Asynchronous version of `ArangoDatabase.getCurrentlyRunningQueries()`
`CompletableFuture<ArangoDBEngine>`	`getEngine()`	Asynchronous version of `ArangoDatabase.getEngine()`
`CompletableFuture<Collection<GraphEntity>>`	`getGraphs()`	Asynchronous version of `ArangoDatabase.getGraphs()`
`CompletableFuture<IndexEntity>`	`getIndex(String id)`	Asynchronous version of `ArangoDatabase.getIndex(String)`
`CompletableFuture<DatabaseEntity>`	`getInfo()`	Asynchronous version of `ArangoDatabase.getInfo()`
`CompletableFuture<Permissions>`	`getPermissions(String user)`	Asynchronous version of `ArangoDatabase.getPermissions(String)`
`CompletableFuture<QueryCachePropertiesEntity>`	`getQueryCacheProperties()`	Asynchronous version of `ArangoDatabase.getQueryCacheProperties()`
`CompletableFuture<QueryTrackingPropertiesEntity>`	`getQueryTrackingProperties()`	Asynchronous version of `ArangoDatabase.getQueryTrackingProperties()`
`CompletableFuture<SearchAnalyzer>`	`getSearchAnalyzer(String name)`	Asynchronous version of `ArangoDatabase.getSearchAnalyzer(String)`
`CompletableFuture<Collection<SearchAnalyzer>>`	`getSearchAnalyzers()`	Asynchronous version of `ArangoDatabase.getSearchAnalyzers()`
`CompletableFuture<Collection<QueryEntity>>`	`getSlowQueries()`	Asynchronous version of `ArangoDatabase.getSlowQueries()`
`CompletableFuture<StreamTransactionEntity>`	`getStreamTransaction(String id)`	Asynchronous version of `ArangoDatabase.getStreamTransaction(String)`
`CompletableFuture<Collection<TransactionEntity>>`	`getStreamTransactions()`	Asynchronous version of `ArangoDatabase.getStreamTransactions()`
`CompletableFuture<ArangoDBVersion>`	`getVersion()`	Asynchronous version of `ArangoDatabase.getVersion()`
`CompletableFuture<Collection<ViewEntity>>`	`getViews()`	Asynchronous version of `ArangoDatabase.getViews()`
`CompletableFuture<Void>`	`grantAccess(String user)`	Asynchronous version of `ArangoDatabase.grantAccess(String)`
`CompletableFuture<Void>`	`grantAccess(String user, Permissions permissions)`	Asynchronous version of `ArangoDatabase.grantAccess(String, Permissions)`
`CompletableFuture<Void>`	`grantDefaultCollectionAccess(String user, Permissions permissions)`	Asynchronous version of `ArangoDatabase.grantDefaultCollectionAccess(String, Permissions)`
`ArangoGraphAsync`	`graph(String name)`	Returns a `ArangoGraphAsync` instance for the given graph name.
`CompletableFuture<Void>`	`killQuery(String id)`	Asynchronous version of `ArangoDatabase.killQuery(String)`
`String`	`name()`
`CompletableFuture<AqlParseEntity>`	`parseQuery(String query)`	Asynchronous version of `ArangoDatabase.parseQuery(String)`
`<T> CompletableFuture<ArangoCursorAsync<T>>`	`query(String query, Class<T> type)`
`<T> CompletableFuture<ArangoCursorAsync<T>>`	`query(String query, Class<T> type, AqlQueryOptions options)`
`<T> CompletableFuture<ArangoCursorAsync<T>>`	`query(String query, Class<T> type, Map<String,Object> bindVars)`
`<T> CompletableFuture<ArangoCursorAsync<T>>`	`query(String query, Class<T> type, Map<String,Object> bindVars, AqlQueryOptions options)`
`CompletableFuture<Void>`	`reloadRouting()`	Asynchronous version of `ArangoDatabase.reloadRouting()`
`CompletableFuture<Void>`	`resetAccess(String user)`	Asynchronous version of `ArangoDatabase.resetAccess(String)`
`CompletableFuture<Void>`	`revokeAccess(String user)`	Asynchronous version of `ArangoDatabase.revokeAccess(String)`
`SearchAliasAsync`	`searchAlias(String name)`	Returns a `SearchAliasAsync` instance for the given view name.
`CompletableFuture<QueryCachePropertiesEntity>`	`setQueryCacheProperties(QueryCachePropertiesEntity properties)`	Asynchronous version of `ArangoDatabase.setQueryCacheProperties(QueryCachePropertiesEntity)`
`CompletableFuture<QueryTrackingPropertiesEntity>`	`setQueryTrackingProperties(QueryTrackingPropertiesEntity properties)`	Asynchronous version of `ArangoDatabase.setQueryTrackingProperties(QueryTrackingPropertiesEntity)`
`<T> CompletableFuture<T>`	`transaction(String action, Class<T> type, TransactionOptions options)`	Asynchronous version of `ArangoDatabase.transaction(String, Class, TransactionOptions)`
`ArangoViewAsync`	`view(String name)`	Returns a `ArangoViewAsync` instance for the given view name.

Methods inherited from interface com.arangodb.ArangoSerdeAccessor
getSerde

Method Detail

arango
```
ArangoDBAsync arango()
```
Returns:

main entry point for async API

name
```
String name()
```
Returns:

database name

getVersion
```
CompletableFuture<ArangoDBVersion> getVersion()
```
Asynchronous version of ArangoDatabase.getVersion()

getEngine
```
CompletableFuture<ArangoDBEngine> getEngine()
```
Asynchronous version of ArangoDatabase.getEngine()

exists
```
CompletableFuture<Boolean> exists()
```
Asynchronous version of ArangoDatabase.exists()

getAccessibleDatabases
```
CompletableFuture<Collection<String>> getAccessibleDatabases()
```
Asynchronous version of ArangoDatabase.getAccessibleDatabases()

collection
```
ArangoCollectionAsync collection(String name)
```
Returns a ArangoCollectionAsync instance for the given collection name.

Parameters:

name - Name of the collection

Returns:

collection handler

createCollection
```
CompletableFuture<CollectionEntity> createCollection(String name)
```
Asynchronous version of ArangoDatabase.createCollection(String)

createCollection

CompletableFuture<CollectionEntity> createCollection(String name,
                                                     CollectionCreateOptions options)

Asynchronous version of ArangoDatabase.createCollection(String, CollectionCreateOptions)

getCollections
```
CompletableFuture<Collection<CollectionEntity>> getCollections()
```
Asynchronous version of ArangoDatabase.getCollections()

getCollections

CompletableFuture<Collection<CollectionEntity>> getCollections(CollectionsReadOptions options)

Asynchronous version of ArangoDatabase.getCollections(CollectionsReadOptions)

getIndex
```
CompletableFuture<IndexEntity> getIndex(String id)
```
Asynchronous version of ArangoDatabase.getIndex(String)

deleteIndex
```
CompletableFuture<String> deleteIndex(String id)
```
Asynchronous version of ArangoDatabase.deleteIndex(String)

create
```
CompletableFuture<Boolean> create()
```
Asynchronous version of ArangoDatabase.create()

drop
```
CompletableFuture<Boolean> drop()
```
Asynchronous version of ArangoDatabase.drop()

grantAccess

CompletableFuture<Void> grantAccess(String user,
                                    Permissions permissions)

Asynchronous version of ArangoDatabase.grantAccess(String, Permissions)

grantAccess
```
CompletableFuture<Void> grantAccess(String user)
```
Asynchronous version of ArangoDatabase.grantAccess(String)

revokeAccess
```
CompletableFuture<Void> revokeAccess(String user)
```
Asynchronous version of ArangoDatabase.revokeAccess(String)

resetAccess
```
CompletableFuture<Void> resetAccess(String user)
```
Asynchronous version of ArangoDatabase.resetAccess(String)

grantDefaultCollectionAccess

CompletableFuture<Void> grantDefaultCollectionAccess(String user,
                                                     Permissions permissions)

Asynchronous version of ArangoDatabase.grantDefaultCollectionAccess(String, Permissions)

getPermissions
```
CompletableFuture<Permissions> getPermissions(String user)
```
Asynchronous version of ArangoDatabase.getPermissions(String)

query

<T> CompletableFuture<ArangoCursorAsync<T>> query(String query,
                                                  Class<T> type,
                                                  Map<String,Object> bindVars,
                                                  AqlQueryOptions options)

query

<T> CompletableFuture<ArangoCursorAsync<T>> query(String query,
                                                  Class<T> type,
                                                  AqlQueryOptions options)

query

<T> CompletableFuture<ArangoCursorAsync<T>> query(String query,
                                                  Class<T> type,
                                                  Map<String,Object> bindVars)

query

<T> CompletableFuture<ArangoCursorAsync<T>> query(String query,
                                                  Class<T> type)

cursor

<T> CompletableFuture<ArangoCursorAsync<T>> cursor(String cursorId,
                                                   Class<T> type)

cursor

<T> CompletableFuture<ArangoCursorAsync<T>> cursor(String cursorId,
                                                   Class<T> type,
                                                   String nextBatchId)

explainQuery

CompletableFuture<AqlExecutionExplainEntity> explainQuery(String query,
                                                          Map<String,Object> bindVars,
                                                          AqlQueryExplainOptions options)

Asynchronous version of ArangoDatabase.explainQuery(String, Map, AqlQueryExplainOptions)

parseQuery
```
CompletableFuture<AqlParseEntity> parseQuery(String query)
```
Asynchronous version of ArangoDatabase.parseQuery(String)

clearQueryCache
```
CompletableFuture<Void> clearQueryCache()
```
Asynchronous version of ArangoDatabase.clearQueryCache()

getQueryCacheProperties
```
CompletableFuture<QueryCachePropertiesEntity> getQueryCacheProperties()
```
Asynchronous version of ArangoDatabase.getQueryCacheProperties()

setQueryCacheProperties

CompletableFuture<QueryCachePropertiesEntity> setQueryCacheProperties(QueryCachePropertiesEntity properties)

Asynchronous version of ArangoDatabase.setQueryCacheProperties(QueryCachePropertiesEntity)

getQueryTrackingProperties
```
CompletableFuture<QueryTrackingPropertiesEntity> getQueryTrackingProperties()
```
Asynchronous version of ArangoDatabase.getQueryTrackingProperties()

setQueryTrackingProperties

CompletableFuture<QueryTrackingPropertiesEntity> setQueryTrackingProperties(QueryTrackingPropertiesEntity properties)

Asynchronous version of ArangoDatabase.setQueryTrackingProperties(QueryTrackingPropertiesEntity)

getCurrentlyRunningQueries
```
CompletableFuture<Collection<QueryEntity>> getCurrentlyRunningQueries()
```
Asynchronous version of ArangoDatabase.getCurrentlyRunningQueries()

getSlowQueries
```
CompletableFuture<Collection<QueryEntity>> getSlowQueries()
```
Asynchronous version of ArangoDatabase.getSlowQueries()

clearSlowQueries
```
CompletableFuture<Void> clearSlowQueries()
```
Asynchronous version of ArangoDatabase.clearSlowQueries()

killQuery
```
CompletableFuture<Void> killQuery(String id)
```
Asynchronous version of ArangoDatabase.killQuery(String)

createAqlFunction

CompletableFuture<Void> createAqlFunction(String name,
                                          String code,
                                          AqlFunctionCreateOptions options)

Asynchronous version of ArangoDatabase.createAqlFunction(String, String, AqlFunctionCreateOptions)

deleteAqlFunction

CompletableFuture<Integer> deleteAqlFunction(String name,
                                             AqlFunctionDeleteOptions options)

Asynchronous version of ArangoDatabase.deleteAqlFunction(String, AqlFunctionDeleteOptions)

getAqlFunctions

CompletableFuture<Collection<AqlFunctionEntity>> getAqlFunctions(AqlFunctionGetOptions options)

Asynchronous version of ArangoDatabase.getAqlFunctions(AqlFunctionGetOptions)

graph
```
ArangoGraphAsync graph(String name)
```
Returns a ArangoGraphAsync instance for the given graph name.

Parameters:

name - Name of the graph

Returns:

graph handler

createGraph

CompletableFuture<GraphEntity> createGraph(String name,
                                           Iterable<EdgeDefinition> edgeDefinitions)

Asynchronous version of ArangoDatabase.createGraph(String, Iterable)

createGraph

CompletableFuture<GraphEntity> createGraph(String name,
                                           Iterable<EdgeDefinition> edgeDefinitions,
                                           GraphCreateOptions options)

Asynchronous version of ArangoDatabase.createGraph(String, Iterable, GraphCreateOptions)

getGraphs
```
CompletableFuture<Collection<GraphEntity>> getGraphs()
```
Asynchronous version of ArangoDatabase.getGraphs()

transaction

<T> CompletableFuture<T> transaction(String action,
                                     Class<T> type,
                                     TransactionOptions options)

Asynchronous version of ArangoDatabase.transaction(String, Class, TransactionOptions)

beginStreamTransaction
```
CompletableFuture<StreamTransactionEntity> beginStreamTransaction(StreamTransactionOptions options)
```
Asynchronous version of ArangoDatabase.beginStreamTransaction(StreamTransactionOptions)

abortStreamTransaction
```
CompletableFuture<StreamTransactionEntity> abortStreamTransaction(String id)
```
Asynchronous version of ArangoDatabase.abortStreamTransaction(String)

getStreamTransaction
```
CompletableFuture<StreamTransactionEntity> getStreamTransaction(String id)
```
Asynchronous version of ArangoDatabase.getStreamTransaction(String)

getStreamTransactions
```
CompletableFuture<Collection<TransactionEntity>> getStreamTransactions()
```
Asynchronous version of ArangoDatabase.getStreamTransactions()

commitStreamTransaction
```
CompletableFuture<StreamTransactionEntity> commitStreamTransaction(String id)
```
Asynchronous version of ArangoDatabase.commitStreamTransaction(String)

getInfo
```
CompletableFuture<DatabaseEntity> getInfo()
```
Asynchronous version of ArangoDatabase.getInfo()

reloadRouting
```
CompletableFuture<Void> reloadRouting()
```
Asynchronous version of ArangoDatabase.reloadRouting()

getViews
```
CompletableFuture<Collection<ViewEntity>> getViews()
```
Asynchronous version of ArangoDatabase.getViews()

view
```
ArangoViewAsync view(String name)
```
Returns a ArangoViewAsync instance for the given view name.

Parameters:

name - Name of the view

Returns:

view handler

Since:

ArangoDB 3.4.0

arangoSearch
```
ArangoSearchAsync arangoSearch(String name)
```
Returns a ArangoSearchAsync instance for the given view name.

Parameters:

name - Name of the view

Returns:

ArangoSearch view handler

Since:

ArangoDB 3.4.0

searchAlias
```
SearchAliasAsync searchAlias(String name)
```
Returns a SearchAliasAsync instance for the given view name.

Parameters:

name - Name of the view

Returns:

SearchAlias view handler

Since:

ArangoDB 3.10

createView

CompletableFuture<ViewEntity> createView(String name,
                                         ViewType type)

Asynchronous version of ArangoDatabase.createView(String, ViewType)

createArangoSearch

CompletableFuture<ViewEntity> createArangoSearch(String name,
                                                 ArangoSearchCreateOptions options)

Asynchronous version of ArangoDatabase.createArangoSearch(String, ArangoSearchCreateOptions)

createSearchAlias

CompletableFuture<ViewEntity> createSearchAlias(String name,
                                                SearchAliasCreateOptions options)

Asynchronous version of ArangoDatabase.createSearchAlias(String, SearchAliasCreateOptions)

createSearchAnalyzer
```
CompletableFuture<SearchAnalyzer> createSearchAnalyzer(SearchAnalyzer analyzer)
```
Asynchronous version of ArangoDatabase.createSearchAnalyzer(SearchAnalyzer)

getSearchAnalyzer
```
CompletableFuture<SearchAnalyzer> getSearchAnalyzer(String name)
```
Asynchronous version of ArangoDatabase.getSearchAnalyzer(String)

getSearchAnalyzers
```
CompletableFuture<Collection<SearchAnalyzer>> getSearchAnalyzers()
```
Asynchronous version of ArangoDatabase.getSearchAnalyzers()

deleteSearchAnalyzer
```
CompletableFuture<Void> deleteSearchAnalyzer(String name)
```
Asynchronous version of ArangoDatabase.deleteSearchAnalyzer(String)

deleteSearchAnalyzer

CompletableFuture<Void> deleteSearchAnalyzer(String name,
                                             AnalyzerDeleteOptions options)

Asynchronous version of ArangoDatabase.deleteSearchAnalyzer(String, AnalyzerDeleteOptions)

Interface ArangoDatabaseAsync

Method Summary

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

Method Detail

arango

name

getVersion

getEngine

exists

getAccessibleDatabases

collection

createCollection

createCollection

getCollections

getCollections

getIndex

deleteIndex

create

drop

grantAccess

grantAccess

revokeAccess

resetAccess

grantDefaultCollectionAccess

getPermissions

query

query

query

query

cursor

cursor

explainQuery

parseQuery

clearQueryCache

getQueryCacheProperties

setQueryCacheProperties

getQueryTrackingProperties

setQueryTrackingProperties

getCurrentlyRunningQueries

getSlowQueries

clearSlowQueries

killQuery

createAqlFunction

deleteAqlFunction

getAqlFunctions

graph

createGraph

createGraph

getGraphs

transaction

beginStreamTransaction

abortStreamTransaction

getStreamTransaction

getStreamTransactions

commitStreamTransaction

getInfo

reloadRouting

getViews

view

arangoSearch

searchAlias

createView

createArangoSearch

createSearchAlias

createSearchAnalyzer

getSearchAnalyzer

getSearchAnalyzers

deleteSearchAnalyzer

deleteSearchAnalyzer