com.arangodb

Interface ArangoDB

All Superinterfaces:

ArangoSerializationAccessor

public interface ArangoDB
extends ArangoSerializationAccessor

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

Will be instantiated through ArangoDB.Builder

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

Author:

Mark Vollmary

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
ArangoDB	_setCursorInitializer(ArangoCursorInitializer cursorInitializer) Attention: Please do not use!
Boolean	createDatabase(String name) Creates a new database with the given name.
UserEntity	createUser(String user, String passwd) Create a new user.
UserEntity	createUser(String user, String passwd, UserCreateOptions options) Create a new user.
ArangoDatabase	db() Returns a ArangoDatabase instance for the _system database.
ArangoDatabase	db(String name) Returns a ArangoDatabase instance for the given database name.
void	deleteUser(String user) Removes an existing user, identified by user.
Response	execute(Request request) Generic Execute.
Response	execute(Request request, com.arangodb.internal.net.HostHandle hostHandle) Generic Execute.
Collection<String>	getAccessibleDatabases() Retrieves a list of all databases the current user can access
Collection<String>	getAccessibleDatabasesFor(String user) List available database to the specified user
Collection<String>	getDatabases() Retrieves a list of all existing databases
LogLevelEntity	getLogLevel() Returns the server's current loglevel settings.
LogEntity	getLogs(LogOptions options) Returns fatal, error, warning or info log messages from the server's global log.
ServerRole	getRole() Returns the server role.
UserEntity	getUser(String user) Fetches data about the specified user.
Collection<UserEntity>	getUsers() Fetches data about all users.
ArangoDBVersion	getVersion() Returns the server name and version number.
void	grantDefaultCollectionAccess(String user, Permissions permissions) Sets the default access level for collections for the user user.
void	grantDefaultDatabaseAccess(String user, Permissions permissions) Sets the default access level for databases for the user user.
UserEntity	replaceUser(String user, UserUpdateOptions options) Replaces the data of an existing user.
LogLevelEntity	setLogLevel(LogLevelEntity entity) Modifies and returns the server's current loglevel settings.
void	shutdown() Releases all connections to the server and clear the connection pool.
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

Releases all connections to the server and clear the connection pool.

Throws:

ArangoDBException

db

ArangoDatabase db()

Returns a ArangoDatabase instance for the _system database.

Returns:

database handler

db

ArangoDatabase db(String name)

Returns a ArangoDatabase instance for the given database name.

Parameters:

name - Name of the database

Returns:

database handler

createDatabase

Boolean createDatabase(String name)
                throws ArangoDBException

Creates a new database with the given name.

Parameters:

name - Name of the database to create

Returns:

true if the database was created successfully.

Throws:

ArangoDBException

See Also:

API Documentation

getDatabases

Collection<String> getDatabases()
                         throws ArangoDBException

Retrieves a list of all existing databases

Returns:

a list of all existing databases

Throws:

ArangoDBException

See Also:

API Documentation

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

getAccessibleDatabasesFor

Collection<String> getAccessibleDatabasesFor(String user)
                                      throws ArangoDBException

List available database to the specified user

Parameters:

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

Returns:

Throws:

ArangoDBException

See Also:

API Documentation

getVersion

ArangoDBVersion getVersion()
                    throws ArangoDBException

Returns the server name and version number.

Returns:

the server version, number

Throws:

ArangoDBException

See Also:

API Documentation

getRole

ServerRole getRole()
            throws ArangoDBException

Returns the server role.

Returns:

the server role

Throws:

ArangoDBException

createUser

UserEntity createUser(String user,
                      String passwd)
               throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

createUser

UserEntity createUser(String user,
                      String passwd,
                      UserCreateOptions options)
               throws ArangoDBException

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 options, can be null

Returns:

information about the user

Throws:

ArangoDBException

See Also:

API Documentation

deleteUser

void deleteUser(String user)
         throws ArangoDBException

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

Parameters:

user - The name of the user

Throws:

ArangoDBException

See Also:

API Documentation

getUser

UserEntity getUser(String user)
            throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

getUsers

Collection<UserEntity> getUsers()
                         throws ArangoDBException

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

Returns:

informations about all users

Throws:

ArangoDBException

See Also:

API Documentation

updateUser

UserEntity updateUser(String user,
                      UserUpdateOptions options)
               throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

replaceUser

UserEntity replaceUser(String user,
                       UserUpdateOptions options)
                throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

grantDefaultDatabaseAccess

void grantDefaultDatabaseAccess(String user,
                                Permissions permissions)
                         throws ArangoDBException

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

Throws:

ArangoDBException

Since:

ArangoDB 3.2.0

grantDefaultCollectionAccess

void grantDefaultCollectionAccess(String user,
                                  Permissions permissions)
                           throws ArangoDBException

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

Throws:

ArangoDBException

Since:

ArangoDB 3.2.0

execute

Response execute(Request request)
          throws ArangoDBException

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

Parameters:

request - VelocyStream request

Returns:

VelocyStream response

Throws:

ArangoDBException

execute

Response execute(Request request,
                 com.arangodb.internal.net.HostHandle hostHandle)
          throws ArangoDBException

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

Parameters:

request - VelocyStream request

hostHandle - Used to stick to a specific host when using LoadBalancingStrategy.ROUND_ROBIN

Returns:

VelocyStream response

Throws:

ArangoDBException

getLogs

LogEntity getLogs(LogOptions options)
           throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

getLogLevel

LogLevelEntity getLogLevel()
                    throws ArangoDBException

Returns the server's current loglevel settings.

Returns:

the server's current loglevel settings

Throws:

ArangoDBException

Since:

ArangoDB 3.1.0

setLogLevel

LogLevelEntity setLogLevel(LogLevelEntity entity)
                    throws ArangoDBException

Modifies and returns the server's current loglevel settings.

Parameters:

entity - loglevel settings

Returns:

the server's current loglevel settings

Throws:

ArangoDBException

Since:

ArangoDB 3.1.0

_setCursorInitializer

ArangoDB _setCursorInitializer(ArangoCursorInitializer cursorInitializer)

Attention: Please do not use!

Parameters:

cursorInitializer -

Returns:

ArangoDB