com.arangodb

Interface ArangoDatabaseAsync

All Superinterfaces:

com.arangodb.ArangoSerializationAccessor

public interface ArangoDatabaseAsync
extends com.arangodb.ArangoSerializationAccessor

Interface for operations on ArangoDB database level.

Author:

Mark Vollmary

See Also:

Databases API Documentation, Query API Documentation

Method Summary

Modifier and Type	Method and Description
ArangoDBAsync	arango() Return the main entry point for the ArangoDB driver
ArangoSearchAsync	arangoSearch(String name) Returns a ArangoSearchAsync instance for the given ArangoSearch view name.
CompletableFuture<Void>	clearQueryCache() Clears the AQL query cache
CompletableFuture<Void>	clearSlowQueries() Clears the list of slow AQL queries
ArangoCollectionAsync	collection(String name) Returns a handler of the collection by the given name
CompletableFuture<Boolean>	create() Creates the database
CompletableFuture<Void>	createAqlFunction(String name, String code, com.arangodb.model.AqlFunctionCreateOptions options) Create a new AQL user function
CompletableFuture<com.arangodb.entity.ViewEntity>	createArangoSearch(String name, com.arangodb.model.arangosearch.ArangoSearchCreateOptions options) Creates a ArangoSearch view with the given options, then returns view information from the server.
CompletableFuture<com.arangodb.entity.CollectionEntity>	createCollection(String name) Creates a collection
CompletableFuture<com.arangodb.entity.CollectionEntity>	createCollection(String name, com.arangodb.model.CollectionCreateOptions options) Creates a collection
CompletableFuture<com.arangodb.entity.GraphEntity>	createGraph(String name, Collection<com.arangodb.entity.EdgeDefinition> edgeDefinitions) Create a new graph in the graph module.
CompletableFuture<com.arangodb.entity.GraphEntity>	createGraph(String name, Collection<com.arangodb.entity.EdgeDefinition> edgeDefinitions, com.arangodb.model.GraphCreateOptions options) Create a new graph in the graph module.
CompletableFuture<com.arangodb.entity.ViewEntity>	createView(String name, com.arangodb.entity.ViewType type) Creates a view of the given type, then returns view information from the server.
<T> CompletableFuture<ArangoCursorAsync<T>>	cursor(String cursorId, Class<T> type) Return an cursor from the given cursor-ID if still existing
CompletableFuture<Integer>	deleteAqlFunction(String name, com.arangodb.model.AqlFunctionDeleteOptions options) Remove an existing AQL user function
CompletableFuture<String>	deleteIndex(String id) Deletes an index
CompletableFuture<Boolean>	drop() Drop an existing database
<V,E> CompletableFuture<com.arangodb.entity.TraversalEntity<V,E>>	executeTraversal(Class<V> vertexClass, Class<E> edgeClass, com.arangodb.model.TraversalOptions options) Execute a server-side traversal
CompletableFuture<Boolean>	exists() Checks whether the database exists
CompletableFuture<com.arangodb.entity.AqlExecutionExplainEntity>	explainQuery(String query, Map<String,Object> bindVars, com.arangodb.model.AqlQueryExplainOptions options) Explain an AQL query and return information about it
CompletableFuture<Collection<String>>	getAccessibleDatabases() Retrieves a list of all databases the current user can access
CompletableFuture<Collection<com.arangodb.entity.AqlFunctionEntity>>	getAqlFunctions(com.arangodb.model.AqlFunctionGetOptions options) Gets all reqistered AQL user functions
CompletableFuture<Collection<com.arangodb.entity.CollectionEntity>>	getCollections() Returns all collections
CompletableFuture<Collection<com.arangodb.entity.CollectionEntity>>	getCollections(com.arangodb.model.CollectionsReadOptions options) Returns all collections
CompletableFuture<Collection<com.arangodb.entity.QueryEntity>>	getCurrentlyRunningQueries() Returns a list of currently running AQL queries
<T> CompletableFuture<T>	getDocument(String id, Class<T> type) Reads a single document
<T> CompletableFuture<T>	getDocument(String id, Class<T> type, com.arangodb.model.DocumentReadOptions options) Reads a single document
CompletableFuture<Collection<com.arangodb.entity.GraphEntity>>	getGraphs() Lists all graphs known to the graph module
CompletableFuture<com.arangodb.entity.IndexEntity>	getIndex(String id) Returns an index
CompletableFuture<com.arangodb.entity.DatabaseEntity>	getInfo() Retrieves information about the current database
CompletableFuture<com.arangodb.entity.Permissions>	getPermissions(String user) Get specific database access level
CompletableFuture<com.arangodb.entity.QueryCachePropertiesEntity>	getQueryCacheProperties() Returns the global configuration for the AQL query cache
CompletableFuture<com.arangodb.entity.QueryTrackingPropertiesEntity>	getQueryTrackingProperties() Returns the configuration for the AQL query tracking
CompletableFuture<Collection<com.arangodb.entity.QueryEntity>>	getSlowQueries() Returns a list of slow running AQL queries
CompletableFuture<com.arangodb.entity.ArangoDBVersion>	getVersion() Returns the server name and version number.
CompletableFuture<Collection<com.arangodb.entity.ViewEntity>>	getViews() Fetches all views from the database and returns an list of view descriptions.
CompletableFuture<Void>	grantAccess(String user) Grants access to the database dbname for user user.
CompletableFuture<Void>	grantAccess(String user, com.arangodb.entity.Permissions permissions) Grants access to the database dbname for user user.
CompletableFuture<Void>	grantDefaultCollectionAccess(String user, com.arangodb.entity.Permissions permissions) Sets the default access level for collections within this database for the user user.
ArangoGraphAsync	graph(String name) Returns a handler of the graph by the given name
CompletableFuture<Void>	killQuery(String id) Kills a running query.
String	name() Returns the name of the database
CompletableFuture<com.arangodb.entity.AqlParseEntity>	parseQuery(String query) Parse an AQL query and return information about it This method is for query validation only.
<T> CompletableFuture<ArangoCursorAsync<T>>	query(String query, com.arangodb.model.AqlQueryOptions options, Class<T> type) Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.
<T> CompletableFuture<ArangoCursorAsync<T>>	query(String query, Class<T> type) Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.
<T> CompletableFuture<ArangoCursorAsync<T>>	query(String query, Map<String,Object> bindVars, com.arangodb.model.AqlQueryOptions options, Class<T> type) Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.
<T> CompletableFuture<ArangoCursorAsync<T>>	query(String query, Map<String,Object> bindVars, Class<T> type) Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.
CompletableFuture<Void>	reloadRouting() Reload the routing table.
CompletableFuture<Void>	resetAccess(String user) Clear the database access level, revert back to the default access level.
CompletableFuture<Void>	revokeAccess(String user) Revokes access to the database dbname for user user.
ArangoRouteAsync	route(String... path) Returns a new ArangoRouteAsync instance for the given path (relative to the database) that can be used to perform arbitrary requests.
CompletableFuture<com.arangodb.entity.QueryCachePropertiesEntity>	setQueryCacheProperties(com.arangodb.entity.QueryCachePropertiesEntity properties) Changes the configuration for the AQL query cache.
CompletableFuture<com.arangodb.entity.QueryTrackingPropertiesEntity>	setQueryTrackingProperties(com.arangodb.entity.QueryTrackingPropertiesEntity properties) Changes the configuration for the AQL query tracking
<T> CompletableFuture<T>	transaction(String action, Class<T> type, com.arangodb.model.TransactionOptions options) Execute a server-side transaction
ArangoViewAsync	view(String name) Returns a ArangoViewAsync instance for the given view name.

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

arango

ArangoDBAsync arango()

Return the main entry point for the ArangoDB driver

Returns:

main entry point

name

String name()

Returns the name of the database

Returns:

database name

getVersion

CompletableFuture<com.arangodb.entity.ArangoDBVersion> getVersion()

Returns the server name and version number.

Returns:

the server version, number

See Also:

API Documentation

exists

CompletableFuture<Boolean> exists()

Checks whether the database exists

Returns:

true if the database exists, otherwise false

getAccessibleDatabases

CompletableFuture<Collection<String>> getAccessibleDatabases()

Retrieves a list of all databases the current user can access

Returns:

a list of all databases the current user can access

See Also:

API Documentation

collection

ArangoCollectionAsync collection(String name)

Returns a handler of the collection by the given name

Parameters:

name - Name of the collection

Returns:

collection handler

createCollection

CompletableFuture<com.arangodb.entity.CollectionEntity> createCollection(String name)

Creates a collection

Parameters:

name - The name of the collection

options - Additional options, can be null

Returns:

information about the collection

See Also:

API Documentation

createCollection

CompletableFuture<com.arangodb.entity.CollectionEntity> createCollection(String name,
                                                                         com.arangodb.model.CollectionCreateOptions options)

Creates a collection

Parameters:

name - The name of the collection

options - Additional options, can be null

Returns:

information about the collection

See Also:

API Documentation

getCollections

CompletableFuture<Collection<com.arangodb.entity.CollectionEntity>> getCollections()

Returns all collections

Returns:

list of information about all collections

See Also:

API Documentation

getCollections

CompletableFuture<Collection<com.arangodb.entity.CollectionEntity>> getCollections(com.arangodb.model.CollectionsReadOptions options)

Returns all collections

Parameters:

options - Additional options, can be null

Returns:

list of information about all collections

See Also:

API Documentation

getIndex

CompletableFuture<com.arangodb.entity.IndexEntity> getIndex(String id)

Returns an index

Parameters:

id - The index-handle

Returns:

information about the index

See Also:

API Documentation

deleteIndex

CompletableFuture<String> deleteIndex(String id)

Deletes an index

Parameters:

id - The index handle

Returns:

the id of the index

See Also:

API Documentation

create

CompletableFuture<Boolean> create()

Creates the database

Returns:

true if the database was created successfully.

See Also:

API Documentation

drop

CompletableFuture<Boolean> drop()

Drop an existing database

Returns:

true if the database was dropped successfully

See Also:

API Documentation

grantAccess

CompletableFuture<Void> grantAccess(String user,
                                    com.arangodb.entity.Permissions permissions)

Grants access to the database dbname for user user. You need permission to the _system database in order to execute this call.

Parameters:

user - The name of the user

permissions - The permissions the user grant

Returns:

void

See Also:

API Documentation

grantAccess

CompletableFuture<Void> grantAccess(String user)

Grants access to the database dbname for user user. You need permission to the _system database in order to execute this call.

Parameters:

user - The name of the user

Returns:

void

See Also:

API Documentation

revokeAccess

CompletableFuture<Void> revokeAccess(String user)

Revokes access to the database dbname for user user. You need permission to the _system database in order to execute this call.

Parameters:

user - The name of the user

Returns:

void

See Also:

API Documentation

resetAccess

CompletableFuture<Void> resetAccess(String user)

Clear the database access level, revert back to the default access level.

Parameters:

user - The name of the user

Returns:

void

Since:

ArangoDB 3.2.0

See Also:

API Documentation

grantDefaultCollectionAccess

CompletableFuture<Void> grantDefaultCollectionAccess(String user,
                                                     com.arangodb.entity.Permissions permissions)
                                              throws com.arangodb.ArangoDBException

Sets the default access level for collections within this database for the user user. You need permission to the _system database in order to execute this call.

Parameters:

user - The name of the user

permissions - The permissions the user grant

Throws:

ArangoDBException

Since:

ArangoDB 3.2.0

getPermissions

CompletableFuture<com.arangodb.entity.Permissions> getPermissions(String user)
                                                           throws com.arangodb.ArangoDBException

Get specific database access level

Parameters:

user - The name of the user

Returns:

permissions of the user

Throws:

com.arangodb.ArangoDBException

Since:

ArangoDB 3.2.0

See Also:

API Documentation

query

<T> CompletableFuture<ArangoCursorAsync<T>> query(String query,
                                                  Map<String,Object> bindVars,
                                                  com.arangodb.model.AqlQueryOptions options,
                                                  Class<T> type)
                                           throws com.arangodb.ArangoDBException

Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.

Parameters:

query - contains the query string to be executed

bindVars - key/value pairs representing the bind parameters

options - Additional options, can be null

type - The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map)

Returns:

cursor of the results

Throws:

ArangoDBException

See Also:

API Documentation

query

<T> CompletableFuture<ArangoCursorAsync<T>> query(String query,
                                                  com.arangodb.model.AqlQueryOptions options,
                                                  Class<T> type)
                                           throws com.arangodb.ArangoDBException

Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.

Parameters:

query - contains the query string to be executed

options - Additional options, can be null

type - The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map)

Returns:

cursor of the results

Throws:

ArangoDBException

See Also:

API Documentation

query

<T> CompletableFuture<ArangoCursorAsync<T>> query(String query,
                                                  Map<String,Object> bindVars,
                                                  Class<T> type)
                                           throws com.arangodb.ArangoDBException

Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.

Parameters:

query - contains the query string to be executed

bindVars - key/value pairs representing the bind parameters

type - The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map)

Returns:

cursor of the results

Throws:

ArangoDBException

See Also:

API Documentation

query

<T> CompletableFuture<ArangoCursorAsync<T>> query(String query,
                                                  Class<T> type)
                                           throws com.arangodb.ArangoDBException

Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.

Parameters:

query - contains the query string to be executed

type - The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map)

Returns:

cursor of the results

Throws:

ArangoDBException

See Also:

API Documentation

cursor

<T> CompletableFuture<ArangoCursorAsync<T>> cursor(String cursorId,
                                                   Class<T> type)
                                            throws com.arangodb.ArangoDBException

Return an cursor from the given cursor-ID if still existing

Parameters:

cursorId - The ID of the cursor

type - The type of the result (POJO class, VPackSlice, String for Json, or Collection/List/Map)

Returns:

cursor of the results

Throws:

ArangoDBException

See Also:

API Documentation

explainQuery

CompletableFuture<com.arangodb.entity.AqlExecutionExplainEntity> explainQuery(String query,
                                                                              Map<String,Object> bindVars,
                                                                              com.arangodb.model.AqlQueryExplainOptions options)

Explain an AQL query and return information about it

Parameters:

query - the query which you want explained

bindVars - key/value pairs representing the bind parameters

options - Additional options, can be null

Returns:

information about the query

See Also:

API Documentation

parseQuery

CompletableFuture<com.arangodb.entity.AqlParseEntity> parseQuery(String query)

Parse an AQL query and return information about it This method is for query validation only. To actually query the database, see query(String, Map, AqlQueryOptions, Class)

Parameters:

query - the query which you want parse

Returns:

imformation about the query

See Also:

API Documentation

clearQueryCache

CompletableFuture<Void> clearQueryCache()

Clears the AQL query cache

Returns:

void

See Also:

API Documentation

getQueryCacheProperties

CompletableFuture<com.arangodb.entity.QueryCachePropertiesEntity> getQueryCacheProperties()

Returns the global configuration for the AQL query cache

Returns:

configuration for the AQL query cache

See Also:

API Documentation

setQueryCacheProperties

CompletableFuture<com.arangodb.entity.QueryCachePropertiesEntity> setQueryCacheProperties(com.arangodb.entity.QueryCachePropertiesEntity properties)

Changes the configuration for the AQL query cache. Note: changing the properties may invalidate all results in the cache.

Parameters:

properties - properties to be set

Returns:

current set of properties

See Also:

API Documentation

getQueryTrackingProperties

CompletableFuture<com.arangodb.entity.QueryTrackingPropertiesEntity> getQueryTrackingProperties()

Returns the configuration for the AQL query tracking

Returns:

configuration for the AQL query tracking

See Also:

API Documentation

setQueryTrackingProperties

CompletableFuture<com.arangodb.entity.QueryTrackingPropertiesEntity> setQueryTrackingProperties(com.arangodb.entity.QueryTrackingPropertiesEntity properties)

Changes the configuration for the AQL query tracking

Parameters:

properties - properties to be set

Returns:

current set of properties

See Also:

API Documentation

getCurrentlyRunningQueries

CompletableFuture<Collection<com.arangodb.entity.QueryEntity>> getCurrentlyRunningQueries()

Returns a list of currently running AQL queries

Returns:

a list of currently running AQL queries

See Also:

API Documentation

getSlowQueries

CompletableFuture<Collection<com.arangodb.entity.QueryEntity>> getSlowQueries()

Returns a list of slow running AQL queries

Returns:

a list of slow running AQL queries

See Also:

API Documentation

clearSlowQueries

CompletableFuture<Void> clearSlowQueries()

Clears the list of slow AQL queries

Returns:

void

See Also:

API Documentation

killQuery

CompletableFuture<Void> killQuery(String id)

Kills a running query. The query will be terminated at the next cancelation point.

Parameters:

id - The id of the query

Returns:

void

See Also:

API Documentation

createAqlFunction

CompletableFuture<Void> createAqlFunction(String name,
                                          String code,
                                          com.arangodb.model.AqlFunctionCreateOptions options)

Create a new AQL user function

Parameters:

name - the fully qualified name of the user functions

code - a string representation of the function body

options - Additional options, can be null

Returns:

void

See Also:

API Documentation

deleteAqlFunction

CompletableFuture<Integer> deleteAqlFunction(String name,
                                             com.arangodb.model.AqlFunctionDeleteOptions options)

Remove an existing AQL user function

Parameters:

name - the name of the AQL user function

options - Additional options, can be null

Returns:

number of deleted functions (since ArangoDB 3.4.0)

See Also:

API Documentation

getAqlFunctions

CompletableFuture<Collection<com.arangodb.entity.AqlFunctionEntity>> getAqlFunctions(com.arangodb.model.AqlFunctionGetOptions options)

Gets all reqistered AQL user functions

Parameters:

options - Additional options, can be null

Returns:

all reqistered AQL user functions

See Also:

API Documentation

graph

ArangoGraphAsync graph(String name)

Returns a handler of the graph by the given name

Parameters:

name - Name of the graph

Returns:

graph handler

createGraph

CompletableFuture<com.arangodb.entity.GraphEntity> createGraph(String name,
                                                               Collection<com.arangodb.entity.EdgeDefinition> edgeDefinitions)

Create a new graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges.

Parameters:

name - Name of the graph

edgeDefinitions - An array of definitions for the edge

Returns:

information about the graph

See Also:

API Documentation

createGraph

CompletableFuture<com.arangodb.entity.GraphEntity> createGraph(String name,
                                                               Collection<com.arangodb.entity.EdgeDefinition> edgeDefinitions,
                                                               com.arangodb.model.GraphCreateOptions options)

Create a new graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges.

Parameters:

name - Name of the graph

edgeDefinitions - An array of definitions for the edge

options - Additional options, can be null

Returns:

information about the graph

See Also:

API Documentation

getGraphs

CompletableFuture<Collection<com.arangodb.entity.GraphEntity>> getGraphs()

Lists all graphs known to the graph module

Returns:

graphs stored in this database

See Also:

API Documentation

transaction

<T> CompletableFuture<T> transaction(String action,
                                     Class<T> type,
                                     com.arangodb.model.TransactionOptions options)

Execute a server-side transaction

Parameters:

action - the actual transaction operations to be executed, in the form of stringified JavaScript code

type - The type of the result (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

the result of the transaction if it succeeded

See Also:

API Documentation

getInfo

CompletableFuture<com.arangodb.entity.DatabaseEntity> getInfo()

Retrieves information about the current database

Returns:

information about the current database

See Also:

API Documentation

executeTraversal

<V,E> CompletableFuture<com.arangodb.entity.TraversalEntity<V,E>> executeTraversal(Class<V> vertexClass,
                                                                                   Class<E> edgeClass,
                                                                                   com.arangodb.model.TraversalOptions options)

Execute a server-side traversal

Parameters:

vertexClass - The type of the vertex documents (POJO class, VPackSlice or String for Json)

edgeClass - The type of the edge documents (POJO class, VPackSlice or String for Json)

options - Additional options

Returns:

Result of the executed traversal

See Also:

API Documentation

getDocument

<T> CompletableFuture<T> getDocument(String id,
                                     Class<T> type)
                              throws com.arangodb.ArangoDBException

Reads a single document

Parameters:

id - The id of the document

type - The type of the document (POJO class, VPackSlice or String for Json)

Returns:

the document identified by the id

Throws:

com.arangodb.ArangoDBException

See Also:

API Documentation

getDocument

<T> CompletableFuture<T> getDocument(String id,
                                     Class<T> type,
                                     com.arangodb.model.DocumentReadOptions options)
                              throws com.arangodb.ArangoDBException

Reads a single document

Parameters:

id - The id of the document

type - The type of the document (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

the document identified by the id

Throws:

com.arangodb.ArangoDBException

See Also:

API Documentation

reloadRouting

CompletableFuture<Void> reloadRouting()

Reload the routing table.

Returns:

void

See Also:

API Documentation

route

ArangoRouteAsync route(String... path)

Returns a new ArangoRouteAsync instance for the given path (relative to the database) that can be used to perform arbitrary requests.

Parameters:

path - The database-relative URL of the route

Returns:

ArangoRouteAsync

getViews

CompletableFuture<Collection<com.arangodb.entity.ViewEntity>> getViews()
                                                                throws com.arangodb.ArangoDBException

Fetches all views from the database and returns an list of view descriptions.

Returns:

list of information about all views

Throws:

ArangoDBException

Since:

ArangoDB 3.4.0

See Also:

API Documentation

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 ArangoSearch view name.

Parameters:

name - Name of the view

Returns:

ArangoSearch view handler

Since:

ArangoDB 3.4.0

createView

CompletableFuture<com.arangodb.entity.ViewEntity> createView(String name,
                                                             com.arangodb.entity.ViewType type)
                                                      throws com.arangodb.ArangoDBException

Creates a view of the given type, then returns view information from the server.

Parameters:

name - The name of the view

type - The type of the view

Returns:

information about the view

Throws:

ArangoDBException

Since:

ArangoDB 3.4.0

createArangoSearch

CompletableFuture<com.arangodb.entity.ViewEntity> createArangoSearch(String name,
                                                                     com.arangodb.model.arangosearch.ArangoSearchCreateOptions options)
                                                              throws com.arangodb.ArangoDBException

Creates a ArangoSearch view with the given options, then returns view information from the server.

Parameters:

name - The name of the view

options - Additional options, can be null

Returns:

information about the view

Throws:

ArangoDBException

Since:

ArangoDB 3.4.0

See Also:

API Documentation