com.arangodb.async

Interface ArangoDBAsync

All Superinterfaces:

ArangoSerializationAccessor

All Known Implementing Classes:

ArangoDBAsyncImpl

public interface ArangoDBAsync
extends ArangoSerializationAccessor

Central access point for applications to communicate with an ArangoDB server.

Will be instantiated through ArangoDBAsync.Builder

 ArangoDBAsync arango = new ArangoDBAsync.Builder().build();
 ArangoDBAsync arango = new ArangoDBAsync.Builder().host("127.0.0.1", 8529).build();
 

Author:

Mark Vollmary

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ArangoDBAsync.Builder Builder class to build an instance of ArangoDBAsync.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Boolean>	createDatabase(DBCreateOptions options) Creates a new database
CompletableFuture<Boolean>	createDatabase(String name) Creates a new database
CompletableFuture<UserEntity>	createUser(String user, String passwd) Create a new user.
CompletableFuture<UserEntity>	createUser(String user, String passwd, UserCreateOptions options) Create a new user.
ArangoDatabaseAsync	db() Returns a handler of the system database
ArangoDatabaseAsync	db(String name) Returns a handler of the database by the given name
CompletableFuture<Void>	deleteUser(String user) Removes an existing user, identified by user.
CompletableFuture<Response>	execute(Request request) Generic Execute.
CompletableFuture<Collection<String>>	getAccessibleDatabases() Retrieves a list of all databases the current user can access
CompletableFuture<Collection<String>>	getAccessibleDatabasesFor(String user) List available database to the specified user
CompletableFuture<Collection<String>>	getDatabases() Retrieves a list of all existing databases
CompletableFuture<LogEntriesEntity>	getLogEntries(LogOptions options) Returns the server logs
CompletableFuture<LogLevelEntity>	getLogLevel() Returns the server's current loglevel settings.
CompletableFuture<LogEntity>	getLogs(LogOptions options) Deprecated. use getLogEntries(LogOptions) instead
CompletableFuture<ServerRole>	getRole() Returns the server role.
CompletableFuture<UserEntity>	getUser(String user) Fetches data about the specified user.
CompletableFuture<Collection<UserEntity>>	getUsers() Fetches data about all users.
CompletableFuture<ArangoDBVersion>	getVersion() Returns the server name and version number.
CompletableFuture<Void>	grantDefaultCollectionAccess(String user, Permissions permissions) Sets the default access level for collections for the user user.
CompletableFuture<Void>	grantDefaultDatabaseAccess(String user, Permissions permissions) Sets the default access level for databases for the user user.
CompletableFuture<UserEntity>	replaceUser(String user, UserUpdateOptions options) Replaces the data of an existing user.
CompletableFuture<LogLevelEntity>	setLogLevel(LogLevelEntity entity) Modifies and returns the server's current loglevel settings.
void	shutdown()
CompletableFuture<UserEntity>	updateUser(String user, UserUpdateOptions options) Partially updates the data of an existing user.

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

shutdown

void shutdown()
       throws ArangoDBException

Throws:

ArangoDBException

db

ArangoDatabaseAsync db()

Returns a handler of the system database

Returns:

database handler

db

ArangoDatabaseAsync db(String name)

Returns a handler of the database by the given name

Parameters:

name - Name of the database

Returns:

database handler

createDatabase

CompletableFuture<Boolean> createDatabase(String name)

Creates a new database

Parameters:

name - Has to contain a valid database name

Returns:

true if the database was created successfully.

See Also:

API Documentation

createDatabase

CompletableFuture<Boolean> createDatabase(DBCreateOptions options)

Creates a new database

Parameters:

options - Creation options

Returns:

true if the database was created successfully.

Since:

ArangoDB 3.6.0

See Also:

API Documentation

getDatabases

CompletableFuture<Collection<String>> getDatabases()

Retrieves a list of all existing databases

Returns:

a list of all existing databases

See Also:

API Documentation

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

getAccessibleDatabasesFor

CompletableFuture<Collection<String>> getAccessibleDatabasesFor(String user)

List available database to the specified user

Parameters:

user - The name of the user for which you want to query the databases

Returns:

See Also:

API Documentation

getVersion

CompletableFuture<ArangoDBVersion> getVersion()

Returns the server name and version number.

Returns:

the server version, number

See Also:

API Documentation

getRole

CompletableFuture<ServerRole> getRole()

Returns the server role.

Returns:

the server role

createUser

CompletableFuture<UserEntity> createUser(String user,
                                         String passwd)

Create a new user. This user will not have access to any database. You need permission to the _system database in order to execute this call.

Parameters:

user - The name of the user

passwd - The user password

Returns:

information about the user

See Also:

API Documentation

createUser

CompletableFuture<UserEntity> createUser(String user,
                                         String passwd,
                                         UserCreateOptions options)

Create a new user. This user will not have access to any database. You need permission to the _system database in order to execute this call.

Parameters:

user - The name of the user

passwd - The user password

options - Additional properties of the user, can be null

Returns:

information about the user

See Also:

API Documentation

deleteUser

CompletableFuture<Void> deleteUser(String user)

Removes an existing user, identified by user. You need access to the _system database.

Parameters:

user - The name of the user

Returns:

void

See Also:

API Documentation

getUser

CompletableFuture<UserEntity> getUser(String user)

Fetches data about the specified user. You can fetch information about yourself or you need permission to the _system database in order to execute this call.

Parameters:

user - The name of the user

Returns:

information about the user

See Also:

API Documentation

getUsers

CompletableFuture<Collection<UserEntity>> getUsers()

Fetches data about all users. You can only execute this call if you have access to the _system database.

Returns:

informations about all users

See Also:

API Documentation

updateUser

CompletableFuture<UserEntity> updateUser(String user,
                                         UserUpdateOptions options)

Partially updates the data of an existing user. The name of an existing user must be specified in user. You can only change the password of your self. You need access to the _system database to change the active flag.

Parameters:

user - The name of the user

options - Properties of the user to be changed

Returns:

information about the user

See Also:

API Documentation

replaceUser

CompletableFuture<UserEntity> replaceUser(String user,
                                          UserUpdateOptions options)

Replaces the data of an existing user. The name of an existing user must be specified in user. You can only change the password of your self. You need access to the _system database to change the active flag.

Parameters:

user - The name of the user

options - Additional properties of the user, can be null

Returns:

information about the user

See Also:

API Documentation

grantDefaultDatabaseAccess

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

Sets the default access level for databases 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

Returns:

void

Since:

ArangoDB 3.2.0

grantDefaultCollectionAccess

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

Sets the default access level for collections 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

Returns:

void

Since:

ArangoDB 3.2.0

execute

CompletableFuture<Response> execute(Request request)

Generic Execute. Use this method to execute custom FOXX services.

Parameters:

request - VelocyStream request

Returns:

VelocyStream response

getLogs

CompletableFuture<LogEntity> getLogs(LogOptions options)

Deprecated. use getLogEntries(LogOptions) instead

Returns fatal, error, warning or info log messages from the server's global log.

Parameters:

options - Additional options, can be null

Returns:

the log messages

See Also:

API Documentation

getLogEntries

CompletableFuture<LogEntriesEntity> getLogEntries(LogOptions options)

Returns the server logs

Parameters:

options - Additional options, can be null

Returns:

the log messages

Since:

ArangoDB 3.8

See Also:

API Documentation

getLogLevel

CompletableFuture<LogLevelEntity> getLogLevel()

Returns the server's current loglevel settings.

Returns:

the server's current loglevel settings

setLogLevel

CompletableFuture<LogLevelEntity> setLogLevel(LogLevelEntity entity)

Modifies and returns the server's current loglevel settings.

Parameters:

entity - loglevel settings

Returns:

the server's current loglevel settings