Package com.arangodb.internal

Class ArangoDatabaseImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable

com.arangodb.internal.InternalArangoDatabase

com.arangodb.internal.ArangoDatabaseImpl

All Implemented Interfaces:

ArangoDatabase, ArangoSerdeAccessor

public class ArangoDatabaseImpl
extends InternalArangoDatabase
implements ArangoDatabase

Author:

Mark Vollmary, Michele Rastelli

Field Summary

Fields inherited from class com.arangodb.internal.InternalArangoDatabase

PATH_API_DATABASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ArangoDatabaseImpl(ArangoDBImpl arangoDB, String name)

Method Summary

Modifier and Type	Method	Description
StreamTransactionEntity	abortStreamTransaction(String id)	Aborts a Stream Transaction.
ArangoDB	arango()	Return the main entry point for the ArangoDB driver
ArangoSearch	arangoSearch(String name)	Returns a ArangoSearch instance for the given view name.
StreamTransactionEntity	beginStreamTransaction(StreamTransactionOptions options)	Begins a Stream Transaction.
void	clearQueryCache()	Clears the AQL query cache
void	clearSlowQueries()	Clears the list of slow AQL queries
ArangoCollection	collection(String name)	Returns a ArangoCollection instance for the given collection name.
StreamTransactionEntity	commitStreamTransaction(String id)	Commits a Stream Transaction.
Boolean	create()	Creates the database
void	createAqlFunction(String name, String code, AqlFunctionCreateOptions options)	Create a new AQL user function
ViewEntity	createArangoSearch(String name, ArangoSearchCreateOptions options)	Creates a ArangoSearch view with the given options, then returns view information from the server.
CollectionEntity	createCollection(String name)	Creates a collection for the given collection's name, then returns collection information from the server.
CollectionEntity	createCollection(String name, CollectionCreateOptions options)	Creates a collection with the given options for this collection's name, then returns collection information from the server.
GraphEntity	createGraph(String name, Iterable<EdgeDefinition> edgeDefinitions)	Create a new graph in the graph module.
GraphEntity	createGraph(String name, Iterable<EdgeDefinition> edgeDefinitions, GraphCreateOptions options)	Create a new graph in the graph module.
ViewEntity	createSearchAlias(String name, SearchAliasCreateOptions options)	Creates a SearchAlias view with the given options, then returns view information from the server.
SearchAnalyzer	createSearchAnalyzer(SearchAnalyzer analyzer)	Creates an Analyzer
ViewEntity	createView(String name, ViewType type)	Creates a view of the given type, then returns view information from the server.
<T> ArangoCursor<T>	cursor(String cursorId, Class<T> type)	Return an cursor from the given cursor-ID if still existing
<T> ArangoCursor<T>	cursor(String cursorId, Class<T> type, AqlQueryOptions options)	Return an cursor from the given cursor-ID if still existing
<T> ArangoCursor<T>	cursor(String cursorId, Class<T> type, String nextBatchId)	Return an cursor from the given cursor-ID if still existing
<T> ArangoCursor<T>	cursor(String cursorId, Class<T> type, String nextBatchId, AqlQueryOptions options)	Return an cursor from the given cursor-ID if still existing
Integer	deleteAqlFunction(String name, AqlFunctionDeleteOptions options)	Deletes the AQL user function with the given name from the database.
String	deleteIndex(String id)	Deletes an index
void	deleteSearchAnalyzer(String name)	Deletes an Analyzer
void	deleteSearchAnalyzer(String name, AnalyzerDeleteOptions options)	Deletes an Analyzer
Boolean	drop()	Deletes the database from the server.
boolean	exists()	Checks whether the database exists
AqlQueryExplainEntity	explainAqlQuery(String query, Map<String,Object> bindVars, AqlQueryExplainOptions options)	Explain an AQL query and return information about it
AqlQueryExplainEntity	explainAqlQuery(String query, Map<String,Object> bindVars, ExplainAqlQueryOptions options)	Explain an AQL query and return information about it
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()	Fetches all collections from the database and returns an list of collection descriptions.
Collection<CollectionEntity>	getCollections(CollectionsReadOptions options)	Fetches all collections from the database and returns an list of collection descriptions.
Collection<QueryEntity>	getCurrentlyRunningQueries()	Returns a list of currently running AQL queries
ArangoDBEngine	getEngine()	Returns the name of the used storage engine.
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
SearchAnalyzer	getSearchAnalyzer(String name)	Gets information about an Analyzer
Collection<SearchAnalyzer>	getSearchAnalyzers()	Retrieves all analyzers definitions.
Collection<QueryEntity>	getSlowQueries()	Returns a list of slow running AQL queries
StreamTransactionEntity	getStreamTransaction(String id)	Gets information about a Stream Transaction.
Collection<TransactionEntity>	getStreamTransactions()	Gets all the currently running Stream Transactions.
ArangoDBVersion	getVersion()	Returns the server name and version number.
Collection<ViewEntity>	getViews()	Fetches all views from the database and returns a list of view descriptions.
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 ArangoGraph instance for the given graph name.
void	killQuery(String id)	Kills a running query.
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, Class<T> type)	Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.
<T> ArangoCursor<T>	query(String query, Class<T> type, AqlQueryOptions options)	Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.
<T> ArangoCursor<T>	query(String query, Class<T> type, Map<String,Object> bindVars)	Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.
<T> ArangoCursor<T>	query(String query, Class<T> type, Map<String,Object> bindVars, AqlQueryOptions options)	Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.
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.
SearchAlias	searchAlias(String name)	Returns a SearchAlias instance for the given view name.
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)	Performs a server-side transaction and returns its return value.
ArangoView	view(String name)	Returns a ArangoView instance for the given view name.

Methods inherited from class com.arangodb.internal.InternalArangoDatabase

abortStreamTransactionRequest, beginStreamTransactionRequest, clearQueryCacheRequest, clearSlowQueriesRequest, commitStreamTransactionRequest, createAnalyzerRequest, createAqlFunctionRequest, createArangoSearchRequest, createCollectionRequest, createDropResponseDeserializer, createGraphRequest, createGraphResponseDeserializer, createSearchAliasRequest, createViewRequest, cursorEntityDeserializer, deleteAnalyzerRequest, deleteAqlFunctionRequest, deleteAqlFunctionResponseDeserializer, dropRequest, explainQueryRequest, explainQueryRequest, getAccessibleDatabasesRequest, getAnalyzerRequest, getAnalyzersRequest, getAqlFunctionsRequest, getAqlFunctionsResponseDeserializer, getCollectionsRequest, getCollectionsResponseDeserializer, getCurrentlyRunningQueriesRequest, getDatabaseResponseDeserializer, getEngineRequest, getGraphsRequest, getGraphsResponseDeserializer, getInfoRequest, getInfoResponseDeserializer, getPermissionsRequest, getPermissionsResponseDeserialzer, getQueryCachePropertiesRequest, getQueryTrackingPropertiesRequest, getSearchAnalyzersResponseDeserializer, getSlowQueriesRequest, getStreamTransactionRequest, getStreamTransactionsRequest, getVersionRequest, getViewsRequest, getViewsResponseDeserializer, grantAccessRequest, killQueryRequest, name, parseQueryRequest, queryCloseRequest, queryNextRequest, queryRequest, reloadRoutingRequest, resetAccessRequest, setQueryCachePropertiesRequest, setQueryTrackingPropertiesRequest, streamTransactionResponseDeserializer, transactionRequest, transactionResponseDeserializer, transactionsResponseDeserializer, updateUserDefaultCollectionAccessRequest

Methods inherited from class com.arangodb.internal.ArangoExecuteable

createPath, executorAsync, executorSync, getSerde, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.arangodb.ArangoDatabase

name

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Constructor Details

ArangoDatabaseImpl

protected ArangoDatabaseImpl(ArangoDBImpl arangoDB,
 String name)

Method Details

arango

public ArangoDB arango()

Description copied from interface: ArangoDatabase

Return the main entry point for the ArangoDB driver

Specified by:

arango in interface ArangoDatabase

Returns:

main entry point

getVersion

public ArangoDBVersion getVersion()

Description copied from interface: ArangoDatabase

Returns the server name and version number.

Specified by:

getVersion in interface ArangoDatabase

Returns:

the server version, number

See Also:

• API Documentation

getEngine

public ArangoDBEngine getEngine()

Description copied from interface: ArangoDatabase

Returns the name of the used storage engine.

Specified by:

getEngine in interface ArangoDatabase

Returns:

the storage engine name

See Also:

• API Documentation

exists

public boolean exists()

Description copied from interface: ArangoDatabase

Checks whether the database exists

Specified by:

exists in interface ArangoDatabase

Returns:

true if the database exists, otherwise false

See Also:

• API Documentation

getAccessibleDatabases

public Collection<String> getAccessibleDatabases()

Description copied from interface: ArangoDatabase

Retrieves a list of all databases the current user can access

Specified by:

getAccessibleDatabases in interface ArangoDatabase

Returns:

a list of all databases the current user can access

See Also:

• API Documentation

collection

public ArangoCollection collection(String name)

Description copied from interface: ArangoDatabase

Returns a ArangoCollection instance for the given collection name.

Specified by:

collection in interface ArangoDatabase

Parameters:

name - Name of the collection

Returns:

collection handler

createCollection

public CollectionEntity createCollection(String name)

Description copied from interface: ArangoDatabase

Creates a collection for the given collection's name, then returns collection information from the server.

Specified by:

createCollection in interface ArangoDatabase

Parameters:

name - The name of the collection

Returns:

information about the collection

See Also:

• API Documentation

createCollection

public CollectionEntity createCollection(String name,
 CollectionCreateOptions options)

Description copied from interface: ArangoDatabase

Creates a collection with the given options for this collection's name, then returns collection information from the server.

Specified by:

createCollection in interface ArangoDatabase

Parameters:

name - The name of the collection

options - Additional options, can be null

Returns:

information about the collection

See Also:

• API Documentation

getCollections

public Collection<CollectionEntity> getCollections()

Description copied from interface: ArangoDatabase

Fetches all collections from the database and returns an list of collection descriptions.

Specified by:

getCollections in interface ArangoDatabase

Returns:

list of information about all collections

See Also:

• API Documentation

getCollections

public Collection<CollectionEntity> getCollections(CollectionsReadOptions options)

Description copied from interface: ArangoDatabase

Fetches all collections from the database and returns an list of collection descriptions.

Specified by:

getCollections in interface ArangoDatabase

Parameters:

options - Additional options, can be null

Returns:

list of information about all collections

See Also:

• API Documentation

getIndex

public IndexEntity getIndex(String id)

Description copied from interface: ArangoDatabase

Returns an index

Specified by:

getIndex in interface ArangoDatabase

Parameters:

id - The index-handle

Returns:

information about the index

See Also:

• API Documentation

deleteIndex

public String deleteIndex(String id)

Description copied from interface: ArangoDatabase

Deletes an index

Specified by:

deleteIndex in interface ArangoDatabase

Parameters:

id - The index-handle

Returns:

the id of the index

See Also:

• API Documentation

create

public Boolean create()

Description copied from interface: ArangoDatabase

Creates the database

Specified by:

create in interface ArangoDatabase

Returns:

true if the database was created successfully.

See Also:

• API Documentation

drop

public Boolean drop()

Description copied from interface: ArangoDatabase

Deletes the database from the server.

Specified by:

drop in interface ArangoDatabase

Returns:

true if the database was dropped successfully

See Also:

• API Documentation

grantAccess

public void grantAccess(String user,
 Permissions permissions)

Description copied from interface: ArangoDatabase

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

Specified by:

grantAccess in interface ArangoDatabase

Parameters:

user - The name of the user

permissions - The permissions the user grant

See Also:

• API Documentation

grantAccess

public void grantAccess(String user)

Description copied from interface: ArangoDatabase

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

Specified by:

grantAccess in interface ArangoDatabase

Parameters:

user - The name of the user

See Also:

• API Documentation

revokeAccess

public void revokeAccess(String user)

Description copied from interface: ArangoDatabase

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

Specified by:

revokeAccess in interface ArangoDatabase

Parameters:

user - The name of the user

See Also:

• API Documentation

resetAccess

public void resetAccess(String user)

Description copied from interface: ArangoDatabase

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

Specified by:

resetAccess in interface ArangoDatabase

Parameters:

user - The name of the user

See Also:

• API Documentation

grantDefaultCollectionAccess

public void grantDefaultCollectionAccess(String user,
 Permissions permissions)

Description copied from interface: ArangoDatabase

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.

Specified by:

grantDefaultCollectionAccess in interface ArangoDatabase

Parameters:

user - The name of the user

permissions - The permissions the user grant

See Also:

• API Documentation

getPermissions

public Permissions getPermissions(String user)

Description copied from interface: ArangoDatabase

Get specific database access level

Specified by:

getPermissions in interface ArangoDatabase

Parameters:

user - The name of the user

Returns:

permissions of the user

See Also:

• API Documentation

query

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

Description copied from interface: ArangoDatabase

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

Specified by:

query in interface ArangoDatabase

Parameters:

query - An AQL query string

type - The type of the result (POJO or RawData)

bindVars - key/value pairs defining the variables to bind the query to

options - Additional options that will be passed to the query API, can be null

Returns:

cursor of the results

See Also:

• API Documentation

query

public <T> ArangoCursor<T> query(String query,
 Class<T> type,
 Map<String,Object> bindVars)

Description copied from interface: ArangoDatabase

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

Specified by:

query in interface ArangoDatabase

Parameters:

query - An AQL query string

type - The type of the result (POJO or RawData)

bindVars - key/value pairs defining the variables to bind the query to

Returns:

cursor of the results

See Also:

• API Documentation

query

public <T> ArangoCursor<T> query(String query,
 Class<T> type,
 AqlQueryOptions options)

Description copied from interface: ArangoDatabase

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

Specified by:

query in interface ArangoDatabase

Parameters:

query - An AQL query string

type - The type of the result (POJO or RawData)

options - Additional options that will be passed to the query API, can be null

Returns:

cursor of the results

See Also:

• API Documentation

query

public <T> ArangoCursor<T> query(String query,
 Class<T> type)

Description copied from interface: ArangoDatabase

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

Specified by:

query in interface ArangoDatabase

Parameters:

query - An AQL query string

type - The type of the result (POJO or RawData)

Returns:

cursor of the results

See Also:

• API Documentation

cursor

public <T> ArangoCursor<T> cursor(String cursorId,
 Class<T> type)

Description copied from interface: ArangoDatabase

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

Specified by:

cursor in interface ArangoDatabase

Parameters:

cursorId - The ID of the cursor

type - The type of the result (POJO or RawData)

Returns:

cursor of the results

See Also:

• API Documentation

cursor

public <T> ArangoCursor<T> cursor(String cursorId,
 Class<T> type,
 AqlQueryOptions options)

Description copied from interface: ArangoDatabase

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

Specified by:

cursor in interface ArangoDatabase

Parameters:

cursorId - The ID of the cursor

type - The type of the result (POJO or RawData)

options - options

Returns:

cursor of the results

See Also:

• API Documentation

cursor

public <T> ArangoCursor<T> cursor(String cursorId,
 Class<T> type,
 String nextBatchId)

Description copied from interface: ArangoDatabase

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

Specified by:

cursor in interface ArangoDatabase

Parameters:

cursorId - The ID of the cursor

type - The type of the result (POJO or RawData)

nextBatchId - The ID of the next cursor batch (set only if cursor allows retries, see AqlQueryOptions.allowRetry(Boolean)

Returns:

cursor of the results

See Also:

• API Documentation

cursor

public <T> ArangoCursor<T> cursor(String cursorId,
 Class<T> type,
 String nextBatchId,
 AqlQueryOptions options)

Description copied from interface: ArangoDatabase

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

Specified by:

cursor in interface ArangoDatabase

Parameters:

cursorId - The ID of the cursor

type - The type of the result (POJO or RawData)

nextBatchId - The ID of the next cursor batch (set only if cursor allows retries, see AqlQueryOptions.allowRetry(Boolean)

options - options

Returns:

cursor of the results

See Also:

• API Documentation

explainQuery

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

Description copied from interface: ArangoDatabase

Explain an AQL query and return information about it

Specified by:

explainQuery in interface ArangoDatabase

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

explainAqlQuery

public AqlQueryExplainEntity explainAqlQuery(String query,
 Map<String,Object> bindVars,
 AqlQueryExplainOptions options)

Description copied from interface: ArangoDatabase

Explain an AQL query and return information about it

Specified by:

explainAqlQuery in interface ArangoDatabase

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

explainAqlQuery

public AqlQueryExplainEntity explainAqlQuery(String query,
 Map<String,Object> bindVars,
 ExplainAqlQueryOptions options)

Description copied from interface: ArangoDatabase

Explain an AQL query and return information about it

Specified by:

explainAqlQuery in interface ArangoDatabase

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

public AqlParseEntity parseQuery(String query)

Description copied from interface: ArangoDatabase

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

Specified by:

parseQuery in interface ArangoDatabase

Parameters:

query - the query which you want parse

Returns:

imformation about the query

See Also:

• API Documentation

clearQueryCache

public void clearQueryCache()

Description copied from interface: ArangoDatabase

Clears the AQL query cache

Specified by:

clearQueryCache in interface ArangoDatabase

See Also:

• API Documentation

getQueryCacheProperties

public QueryCachePropertiesEntity getQueryCacheProperties()

Description copied from interface: ArangoDatabase

Returns the global configuration for the AQL query cache

Specified by:

getQueryCacheProperties in interface ArangoDatabase

Returns:

configuration for the AQL query cache

See Also:

• API Documentation

setQueryCacheProperties

public QueryCachePropertiesEntity setQueryCacheProperties(QueryCachePropertiesEntity properties)

Description copied from interface: ArangoDatabase

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

Specified by:

setQueryCacheProperties in interface ArangoDatabase

Parameters:

properties - properties to be set

Returns:

current set of properties

See Also:

• API Documentation

getQueryTrackingProperties

public QueryTrackingPropertiesEntity getQueryTrackingProperties()

Description copied from interface: ArangoDatabase

Returns the configuration for the AQL query tracking

Specified by:

getQueryTrackingProperties in interface ArangoDatabase

Returns:

configuration for the AQL query tracking

See Also:

• API Documentation

setQueryTrackingProperties

public QueryTrackingPropertiesEntity setQueryTrackingProperties(QueryTrackingPropertiesEntity properties)

Description copied from interface: ArangoDatabase

Changes the configuration for the AQL query tracking

Specified by:

setQueryTrackingProperties in interface ArangoDatabase

Parameters:

properties - properties to be set

Returns:

current set of properties

See Also:

• API Documentation

getCurrentlyRunningQueries

public Collection<QueryEntity> getCurrentlyRunningQueries()

Description copied from interface: ArangoDatabase

Returns a list of currently running AQL queries

Specified by:

getCurrentlyRunningQueries in interface ArangoDatabase

Returns:

a list of currently running AQL queries

See Also:

• API Documentation

getSlowQueries

public Collection<QueryEntity> getSlowQueries()

Description copied from interface: ArangoDatabase

Returns a list of slow running AQL queries

Specified by:

getSlowQueries in interface ArangoDatabase

Returns:

a list of slow running AQL queries

See Also:

• API Documentation

clearSlowQueries

public void clearSlowQueries()

Description copied from interface: ArangoDatabase

Clears the list of slow AQL queries

Specified by:

clearSlowQueries in interface ArangoDatabase

See Also:

• API Documentation

killQuery

public void killQuery(String id)

Description copied from interface: ArangoDatabase

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

Specified by:

killQuery in interface ArangoDatabase

Parameters:

id - The id of the query

See Also:

• API Documentation

createAqlFunction

public void createAqlFunction(String name,
 String code,
 AqlFunctionCreateOptions options)

Description copied from interface: ArangoDatabase

Create a new AQL user function

Specified by:

createAqlFunction in interface ArangoDatabase

Parameters:

name - A valid AQL function name, e.g.: `"myfuncs::accounting::calculate_vat"`

code - A String evaluating to a JavaScript function

options - Additional options, can be null

See Also:

• API Documentation

deleteAqlFunction

public Integer deleteAqlFunction(String name,
 AqlFunctionDeleteOptions options)

Description copied from interface: ArangoDatabase

Deletes the AQL user function with the given name from the database.

Specified by:

deleteAqlFunction in interface ArangoDatabase

Parameters:

name - The name of the user function to delete

options - Additional options, can be null

Returns:

number of deleted functions (since ArangoDB 3.4.0)

See Also:

• API Documentation

getAqlFunctions

public Collection<AqlFunctionEntity> getAqlFunctions(AqlFunctionGetOptions options)

Description copied from interface: ArangoDatabase

Gets all reqistered AQL user functions

Specified by:

getAqlFunctions in interface ArangoDatabase

Parameters:

options - Additional options, can be null

Returns:

all reqistered AQL user functions

See Also:

• API Documentation

graph

public ArangoGraph graph(String name)

Description copied from interface: ArangoDatabase

Returns a ArangoGraph instance for the given graph name.

Specified by:

graph in interface ArangoDatabase

Parameters:

name - Name of the graph

Returns:

graph handler

createGraph

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

Description copied from interface: ArangoDatabase

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.

Specified by:

createGraph in interface ArangoDatabase

Parameters:

name - Name of the graph

edgeDefinitions - An array of definitions for the edge

Returns:

information about the graph

See Also:

• API Documentation

createGraph

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

Description copied from interface: ArangoDatabase

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.

Specified by:

createGraph in interface ArangoDatabase

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

public Collection<GraphEntity> getGraphs()

Description copied from interface: ArangoDatabase

Lists all graphs known to the graph module

Specified by:

getGraphs in interface ArangoDatabase

Returns:

graphs stored in this database

See Also:

• API Documentation

transaction

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

Description copied from interface: ArangoDatabase

Performs a server-side transaction and returns its return value.

Specified by:

transaction in interface ArangoDatabase

Parameters:

action - A String evaluating to a JavaScript function to be executed on the server.

type - The type of the result (POJO or RawData)

options - Additional options, can be null

Returns:

the result of the transaction if it succeeded

See Also:

• API Documentation

beginStreamTransaction

public StreamTransactionEntity beginStreamTransaction(StreamTransactionOptions options)

Description copied from interface: ArangoDatabase

Begins a Stream Transaction.

Specified by:

beginStreamTransaction in interface ArangoDatabase

Parameters:

options - Additional options, can be null

Returns:

information about the transaction

See Also:

• API Documentation

abortStreamTransaction

public StreamTransactionEntity abortStreamTransaction(String id)

Description copied from interface: ArangoDatabase

Aborts a Stream Transaction.

Specified by:

abortStreamTransaction in interface ArangoDatabase

Returns:

information about the transaction

See Also:

• API Documentation

getStreamTransaction

public StreamTransactionEntity getStreamTransaction(String id)

Description copied from interface: ArangoDatabase

Gets information about a Stream Transaction.

Specified by:

getStreamTransaction in interface ArangoDatabase

Returns:

information about the transaction

See Also:

• API Documentation

getStreamTransactions

public Collection<TransactionEntity> getStreamTransactions()

Description copied from interface: ArangoDatabase

Gets all the currently running Stream Transactions.

Specified by:

getStreamTransactions in interface ArangoDatabase

Returns:

all the currently running Stream Transactions

See Also:

• API Documentation

commitStreamTransaction

public StreamTransactionEntity commitStreamTransaction(String id)

Description copied from interface: ArangoDatabase

Commits a Stream Transaction.

Specified by:

commitStreamTransaction in interface ArangoDatabase

Returns:

information about the transaction

See Also:

• API Documentation

getInfo

public DatabaseEntity getInfo()

Description copied from interface: ArangoDatabase

Retrieves information about the current database

Specified by:

getInfo in interface ArangoDatabase

Returns:

information about the current database

See Also:

• API Documentation

reloadRouting

public void reloadRouting()

Description copied from interface: ArangoDatabase

Reload the routing table.

Specified by:

reloadRouting in interface ArangoDatabase

See Also:

• API Documentation

getViews

public Collection<ViewEntity> getViews()

Description copied from interface: ArangoDatabase

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

Specified by:

getViews in interface ArangoDatabase

Returns:

list of information about all views

See Also:

• API Documentation

view

public ArangoView view(String name)

Description copied from interface: ArangoDatabase

Returns a ArangoView instance for the given view name.

Specified by:

view in interface ArangoDatabase

Parameters:

name - Name of the view

Returns:

view handler

arangoSearch

public ArangoSearch arangoSearch(String name)

Description copied from interface: ArangoDatabase

Returns a ArangoSearch instance for the given view name.

Specified by:

arangoSearch in interface ArangoDatabase

Parameters:

name - Name of the view

Returns:

ArangoSearch view handler

searchAlias

public SearchAlias searchAlias(String name)

Description copied from interface: ArangoDatabase

Returns a SearchAlias instance for the given view name.

Specified by:

searchAlias in interface ArangoDatabase

Parameters:

name - Name of the view

Returns:

SearchAlias view handler

createView

public ViewEntity createView(String name,
 ViewType type)

Description copied from interface: ArangoDatabase

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

Specified by:

createView in interface ArangoDatabase

Parameters:

name - The name of the view

type - The type of the view

Returns:

information about the view

createArangoSearch

public ViewEntity createArangoSearch(String name,
 ArangoSearchCreateOptions options)

Description copied from interface: ArangoDatabase

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

Specified by:

createArangoSearch in interface ArangoDatabase

Parameters:

name - The name of the view

options - Additional options, can be null

Returns:

information about the view

See Also:

• API Documentation

createSearchAlias

public ViewEntity createSearchAlias(String name,
 SearchAliasCreateOptions options)

Description copied from interface: ArangoDatabase

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

Specified by:

createSearchAlias in interface ArangoDatabase

Parameters:

name - The name of the view

options - Additional options, can be null

Returns:

information about the view

See Also:

• API Documentation

createSearchAnalyzer

public SearchAnalyzer createSearchAnalyzer(SearchAnalyzer analyzer)

Description copied from interface: ArangoDatabase

Creates an Analyzer

Specified by:

createSearchAnalyzer in interface ArangoDatabase

Parameters:

analyzer - SearchAnalyzer

Returns:

the created Analyzer

See Also:

• API Documentation

getSearchAnalyzer

public SearchAnalyzer getSearchAnalyzer(String name)

Description copied from interface: ArangoDatabase

Gets information about an Analyzer

Specified by:

getSearchAnalyzer in interface ArangoDatabase

Parameters:

name - of the Analyzer without database prefix

Returns:

information about an Analyzer

See Also:

• API Documentation

getSearchAnalyzers

public Collection<SearchAnalyzer> getSearchAnalyzers()

Description copied from interface: ArangoDatabase

Retrieves all analyzers definitions.

Specified by:

getSearchAnalyzers in interface ArangoDatabase

Returns:

collection of all analyzers definitions

See Also:

• API Documentation

deleteSearchAnalyzer

public void deleteSearchAnalyzer(String name)

Description copied from interface: ArangoDatabase

Deletes an Analyzer

Specified by:

deleteSearchAnalyzer in interface ArangoDatabase

Parameters:

name - of the Analyzer without database prefix

See Also:

• API Documentation

deleteSearchAnalyzer

public void deleteSearchAnalyzer(String name,
 AnalyzerDeleteOptions options)

Description copied from interface: ArangoDatabase

Deletes an Analyzer

Specified by:

deleteSearchAnalyzer in interface ArangoDatabase

Parameters:

name - of the Analyzer without database prefix

options - AnalyzerDeleteOptions

See Also:

• API Documentation