com.arangodb

Interface ArangoDatabase

public interface ArangoDatabase

Author:

Mark Vollmary

Method Summary

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

Method Detail

arango

ArangoDB 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

ArangoDBVersion getVersion()
                    throws ArangoDBException

Returns the server name and version number.

Returns:

the server version, number

Throws:

ArangoDBException

See Also:

API Documentation

exists

boolean exists()
        throws ArangoDBException

Checks whether the database exists

Returns:

true if the database exists, otherwise false

Throws:

ArangoDBException

getAccessibleDatabases

Collection<String> getAccessibleDatabases()
                                   throws ArangoDBException

Retrieves a list of all databases the current user can access

Returns:

a list of all databases the current user can access

Throws:

ArangoDBException

See Also:

API Documentation

collection

ArangoCollection collection(String name)

Returns a handler of the collection by the given name

Parameters:

name - Name of the collection

Returns:

collection handler

createCollection

CollectionEntity createCollection(String name)
                           throws ArangoDBException

Creates a collection

Parameters:

name - The name of the collection

Returns:

information about the collection

Throws:

ArangoDBException

See Also:

API Documentation

createCollection

CollectionEntity createCollection(String name,
                                  CollectionCreateOptions options)
                           throws ArangoDBException

Creates a collection

Parameters:

name - The name of the collection

options - Additional options, can be null

Returns:

information about the collection

Throws:

ArangoDBException

See Also:

API Documentation

getCollections

Collection<CollectionEntity> getCollections()
                                     throws ArangoDBException

Returns all collections

Returns:

list of information about all collections

Throws:

ArangoDBException

See Also:

API Documentation

getCollections

Collection<CollectionEntity> getCollections(CollectionsReadOptions options)
                                     throws ArangoDBException

Returns all collections

Parameters:

options - Additional options, can be null

Returns:

list of information about all collections

Throws:

ArangoDBException

See Also:

API Documentation

getIndex

IndexEntity getIndex(String id)
              throws ArangoDBException

Returns an index

Parameters:

id - The index-handle

Returns:

information about the index

Throws:

ArangoDBException

See Also:

API Documentation

deleteIndex

String deleteIndex(String id)
            throws ArangoDBException

Deletes an index

Parameters:

id - The index-handle

Returns:

the id of the index

Throws:

ArangoDBException

See Also:

API Documentation

create

Boolean create()
        throws ArangoDBException

Creates the database

Returns:

true if the database was created successfully.

Throws:

ArangoDBException

See Also:

API Documentation

drop

Boolean drop()
      throws ArangoDBException

Drop an existing database

Returns:

true if the database was dropped successfully

Throws:

ArangoDBException

See Also:

API Documentation

grantAccess

void grantAccess(String user,
                 Permissions permissions)
          throws ArangoDBException

Grants or revoke access to the database 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

Throws:

ArangoDBException

See Also:

API Documentation

grantAccess

void grantAccess(String user)
          throws ArangoDBException

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

Parameters:

user - The name of the user

Throws:

ArangoDBException

See Also:

API Documentation

revokeAccess

void revokeAccess(String user)
           throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

resetAccess

void resetAccess(String user)
          throws ArangoDBException

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

Parameters:

user - The name of the user

Throws:

ArangoDBException

Since:

ArangoDB 3.2.0

See Also:

API Documentation

grantDefaultCollectionAccess

void grantDefaultCollectionAccess(String user,
                                  Permissions permissions)
                           throws 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

Permissions getPermissions(String user)
                    throws ArangoDBException

Get specific database access level

Parameters:

user - The name of the user

Returns:

permissions of the user

Throws:

ArangoDBException

Since:

ArangoDB 3.2.0

See Also:

API Documentation

query

<T> ArangoCursor<T> query(String query,
                          Map<String,Object> bindVars,
                          AqlQueryOptions options,
                          Class<T> type)
                   throws ArangoDBException

Create a cursor and return the first results

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

cursor

<T> ArangoCursor<T> cursor(String cursorId,
                           Class<T> type)
                    throws 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

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

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

Throws:

ArangoDBException

See Also:

API Documentation

parseQuery

AqlParseEntity parseQuery(String query)
                   throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

clearQueryCache

void clearQueryCache()
              throws ArangoDBException

Clears the AQL query cache

Throws:

ArangoDBException

See Also:

API Documentation

getQueryCacheProperties

QueryCachePropertiesEntity getQueryCacheProperties()
                                            throws ArangoDBException

Returns the global configuration for the AQL query cache

Returns:

configuration for the AQL query cache

Throws:

ArangoDBException

See Also:

API Documentation

setQueryCacheProperties

QueryCachePropertiesEntity setQueryCacheProperties(QueryCachePropertiesEntity properties)
                                            throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

getQueryTrackingProperties

QueryTrackingPropertiesEntity getQueryTrackingProperties()
                                                  throws ArangoDBException

Returns the configuration for the AQL query tracking

Returns:

configuration for the AQL query tracking

Throws:

ArangoDBException

See Also:

API Documentation

setQueryTrackingProperties

QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingPropertiesEntity properties)
                                                  throws ArangoDBException

Changes the configuration for the AQL query tracking

Parameters:

properties - properties to be set

Returns:

current set of properties

Throws:

ArangoDBException

See Also:

API Documentation

getCurrentlyRunningQueries

Collection<QueryEntity> getCurrentlyRunningQueries()
                                            throws ArangoDBException

Returns a list of currently running AQL queries

Returns:

a list of currently running AQL queries

Throws:

ArangoDBException

See Also:

API Documentation

getSlowQueries

Collection<QueryEntity> getSlowQueries()
                                throws ArangoDBException

Returns a list of slow running AQL queries

Returns:

a list of slow running AQL queries

Throws:

ArangoDBException

See Also:

API Documentation

clearSlowQueries

void clearSlowQueries()
               throws ArangoDBException

Clears the list of slow AQL queries

Throws:

ArangoDBException

See Also:

API Documentation

killQuery

void killQuery(String id)
        throws ArangoDBException

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

Parameters:

id - The id of the query

Throws:

ArangoDBException

See Also:

API Documentation

createAqlFunction

void createAqlFunction(String name,
                       String code,
                       AqlFunctionCreateOptions options)
                throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

deleteAqlFunction

Integer deleteAqlFunction(String name,
                          AqlFunctionDeleteOptions options)
                   throws ArangoDBException

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)

Throws:

ArangoDBException

See Also:

API Documentation

getAqlFunctions

Collection<AqlFunctionEntity> getAqlFunctions(AqlFunctionGetOptions options)
                                       throws ArangoDBException

Gets all reqistered AQL user functions

Parameters:

options - Additional options, can be null

Returns:

all reqistered AQL user functions

Throws:

ArangoDBException

See Also:

API Documentation

graph

ArangoGraph graph(String name)

Returns a handler of the graph by the given name

Parameters:

name - Name of the graph

Returns:

graph handler

createGraph

GraphEntity createGraph(String name,
                        Collection<EdgeDefinition> edgeDefinitions)
                 throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

createGraph

GraphEntity createGraph(String name,
                        Collection<EdgeDefinition> edgeDefinitions,
                        GraphCreateOptions options)
                 throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

getGraphs

Collection<GraphEntity> getGraphs()
                           throws ArangoDBException

Lists all graphs known to the graph module

Returns:

graphs stored in this database

Throws:

ArangoDBException

See Also:

API Documentation

transaction

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

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

Throws:

ArangoDBException

See Also:

API Documentation

getInfo

DatabaseEntity getInfo()
                throws ArangoDBException

Retrieves information about the current database

Returns:

information about the current database

Throws:

ArangoDBException

See Also:

API Documentation

executeTraversal

<V,E> TraversalEntity<V,E> executeTraversal(Class<V> vertexClass,
                                            Class<E> edgeClass,
                                            TraversalOptions options)
                                     throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

getDocument

<T> T getDocument(String id,
                  Class<T> type)
           throws 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:

ArangoDBException

See Also:

API Documentation

getDocument

<T> T getDocument(String id,
                  Class<T> type,
                  DocumentReadOptions options)
           throws 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:

ArangoDBException

See Also:

API Documentation

reloadRouting

void reloadRouting()
            throws ArangoDBException

Reload the routing table.

Throws:

ArangoDBException

See Also:

API Documentation

route

ArangoRoute route(String... path)

Returns a new ArangoRoute 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:

ArangoRoute