com.arangodb.springframework.core

Interface ArangoOperations

All Known Implementing Classes:

ArangoTemplate

public interface ArangoOperations

Interface that specifies a basic set of ArangoDB operations.

Author:

Mark Vollmary

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ArangoOperations.UpsertStrategy

Method Summary

Modifier and Type	Method and Description
CollectionOperations	collection(Class<?> entityClass) Returns the operations interface for a collection.
CollectionOperations	collection(String name) Returns the operations interface for a collection.
CollectionOperations	collection(String name, com.arangodb.model.CollectionCreateOptions options) Returns the operations interface for a collection.
com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity>	delete(Iterable<Object> values, Class<?> entityClass) Deletes multiple documents from a collection.
com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity>	delete(Iterable<Object> values, Class<?> entityClass, com.arangodb.model.DocumentDeleteOptions options) Deletes multiple documents from a collection.
com.arangodb.entity.DocumentEntity	delete(Object id, Class<?> entityClass) Deletes the document with the given id from a collection.
com.arangodb.entity.DocumentEntity	delete(Object id, Class<?> entityClass, com.arangodb.model.DocumentDeleteOptions options) Deletes the document with the given id from a collection.
com.arangodb.ArangoDB	driver() Give direct access to the underlying driver
void	dropDatabase() Drop an existing database
boolean	exists(Object id, Class<?> entityClass) Checks whether the document exists by reading a single document head
<T> Iterable<T>	find(Iterable<? extends Object> ids, Class<T> entityClass) Retrieves multiple documents with the given ids from a collection.
<T> Optional<T>	find(Object id, Class<T> entityClass) Retrieves the document with the given id from a collection.
<T> Optional<T>	find(Object id, Class<T> entityClass, com.arangodb.model.DocumentReadOptions options) Retrieves the document with the given id from a collection.
<T> Iterable<T>	findAll(Class<T> entityClass) Retrieves all documents from a collection.
ArangoConverter	getConverter()
Iterable<com.arangodb.entity.UserEntity>	getUsers() Fetches data about all users.
com.arangodb.entity.ArangoDBVersion	getVersion() Returns the server name and version number.
<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity>	insert(Iterable<T> values, Class<T> entityClass) Creates new documents from the given documents, unless there is already a document with the _key given.
<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity>	insert(Iterable<T> values, Class<T> entityClass, com.arangodb.model.DocumentCreateOptions options) Creates new documents from the given documents, unless there is already a document with the _key given.
com.arangodb.entity.DocumentEntity	insert(String collectionName, Object value) Creates a new document from the given document, unless there is already a document with the _key given.
com.arangodb.entity.DocumentEntity	insert(String collectionName, Object value, com.arangodb.model.DocumentCreateOptions options) Creates a new document from the given document, unless there is already a document with the _key given.
<T> com.arangodb.entity.DocumentEntity	insert(T value) Creates a new document from the given document, unless there is already a document with the _key given.
<T> com.arangodb.entity.DocumentEntity	insert(T value, com.arangodb.model.DocumentCreateOptions options) Creates a new document from the given document, unless there is already a document with the _key given.
<T> com.arangodb.ArangoCursor<T>	query(String query, com.arangodb.model.AqlQueryOptions options, Class<T> entityClass) Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.
<T> com.arangodb.ArangoCursor<T>	query(String query, Class<T> entityClass) Performs a database query using the given query, then returns a new ArangoCursor instance for the result list.
<T> com.arangodb.ArangoCursor<T>	query(String query, Map<String,Object> bindVars, com.arangodb.model.AqlQueryOptions options, Class<T> entityClass) Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.
<T> com.arangodb.ArangoCursor<T>	query(String query, Map<String,Object> bindVars, Class<T> entityClass) Performs a database query using the given query and bindVars, then returns a new ArangoCursor instance for the result list.
<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity>	replace(Iterable<T> values, Class<T> entityClass) Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are specified by the _key attributes in the documents in values.
<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity>	replace(Iterable<T> values, Class<T> entityClass, com.arangodb.model.DocumentReplaceOptions options) Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are specified by the _key attributes in the documents in values.
<T> com.arangodb.entity.DocumentEntity	replace(Object id, T value) Replaces the document with id with the one in the body, provided there is such a document and no precondition is violated
<T> com.arangodb.entity.DocumentEntity	replace(Object id, T value, com.arangodb.model.DocumentReplaceOptions options) Replaces the document with id with the one in the body, provided there is such a document and no precondition is violated
<T> void	repsert(Iterable<T> value, Class<T> entityClass) Creates new documents from the given documents, unless there already exists.
<T> void	repsert(T value) Creates a new document from the given document, unless there is already a document with the id given.
<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity>	update(Iterable<T> values, Class<T> entityClass) Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.
<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity>	update(Iterable<T> values, Class<T> entityClass, com.arangodb.model.DocumentUpdateOptions options) Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.
<T> com.arangodb.entity.DocumentEntity	update(Object id, T value) Partially updates the document identified by document id or key.
<T> com.arangodb.entity.DocumentEntity	update(Object id, T value, com.arangodb.model.DocumentUpdateOptions options) Partially updates the document identified by document id or key.
<T> void	upsert(Iterable<T> value, ArangoOperations.UpsertStrategy strategy) Deprecated. use #repsert(Iterable) instead
<T> void	upsert(T value, ArangoOperations.UpsertStrategy strategy) Deprecated. use repsert(Object) instead
UserOperations	user(String username) Return the operations interface for a user.

Method Detail

driver

com.arangodb.ArangoDB driver()

Give direct access to the underlying driver

Returns:

main access object of the driver

getVersion

com.arangodb.entity.ArangoDBVersion getVersion()
                                        throws org.springframework.dao.DataAccessException

Returns the server name and version number.

Returns:

the server version, number

Throws:

org.springframework.dao.DataAccessException

query

<T> com.arangodb.ArangoCursor<T> query(String query,
                                       Map<String,Object> bindVars,
                                       com.arangodb.model.AqlQueryOptions options,
                                       Class<T> entityClass)
                                throws org.springframework.dao.DataAccessException

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

Parameters:

query - An AQL query string

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

entityClass - The entity type of the result

Returns:

cursor of the results

Throws:

org.springframework.dao.DataAccessException

query

<T> com.arangodb.ArangoCursor<T> query(String query,
                                       Map<String,Object> bindVars,
                                       Class<T> entityClass)
                                throws org.springframework.dao.DataAccessException

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

Parameters:

query - An AQL query string

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

entityClass - The entity type of the result

Returns:

cursor of the results

Throws:

org.springframework.dao.DataAccessException

query

<T> com.arangodb.ArangoCursor<T> query(String query,
                                       com.arangodb.model.AqlQueryOptions options,
                                       Class<T> entityClass)
                                throws org.springframework.dao.DataAccessException

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

Parameters:

query - An AQL query string

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

entityClass - The entity type of the result

Returns:

cursor of the results

Throws:

org.springframework.dao.DataAccessException

query

<T> com.arangodb.ArangoCursor<T> query(String query,
                                       Class<T> entityClass)
                                throws org.springframework.dao.DataAccessException

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

Parameters:

query - An AQL query string

entityClass - The entity type of the result

Returns:

cursor of the results

Throws:

org.springframework.dao.DataAccessException

delete

com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity> delete(Iterable<Object> values,
                                                                                             Class<?> entityClass,
                                                                                             com.arangodb.model.DocumentDeleteOptions options)
                                                                                      throws org.springframework.dao.DataAccessException

Deletes multiple documents from a collection.

Parameters:

values - The keys of the documents or the documents themselves

entityClass - The entity class which represents the collection

options - Additional options, can be null

Returns:

information about the documents

Throws:

org.springframework.dao.DataAccessException

delete

com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity> delete(Iterable<Object> values,
                                                                                             Class<?> entityClass)
                                                                                      throws org.springframework.dao.DataAccessException

Deletes multiple documents from a collection.

Parameters:

values - The keys of the documents or the documents themselves

entityClass - The entity class which represents the collection

Returns:

information about the documents

Throws:

org.springframework.dao.DataAccessException

delete

com.arangodb.entity.DocumentEntity delete(Object id,
                                          Class<?> entityClass,
                                          com.arangodb.model.DocumentDeleteOptions options)
                                   throws org.springframework.dao.DataAccessException

Deletes the document with the given id from a collection.

Parameters:

id - The id or key of the document

entityClass - The entity class which represents the collection

options - Additional options, can be null

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

delete

com.arangodb.entity.DocumentEntity delete(Object id,
                                          Class<?> entityClass)
                                   throws org.springframework.dao.DataAccessException

Deletes the document with the given id from a collection.

Parameters:

id - The id or key of the document

entityClass - The entity class which represents the collection

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

update

<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity> update(Iterable<T> values,
                                                                                                 Class<T> entityClass,
                                                                                                 com.arangodb.model.DocumentUpdateOptions options)
                                                                                          throws org.springframework.dao.DataAccessException

Partially updates documents, the documents to update are specified by the _key attributes in the objects on values. Vales must contain a list of document updates with the attributes to patch (the patch documents). All attributes from the patch documents will be added to the existing documents if they do not yet exist, and overwritten in the existing documents if they do exist there.

Type Parameters:

T -

Parameters:

values - A list of documents

entityClass - The entity class which represents the collection

options - Additional options, can be null

Returns:

information about the documents

Throws:

org.springframework.dao.DataAccessException

update

<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity> update(Iterable<T> values,
                                                                                                 Class<T> entityClass)
                                                                                          throws org.springframework.dao.DataAccessException

Partially updates documents, the documents to update are specified by the _key attributes in the objects on values. Vales must contain a list of document updates with the attributes to patch (the patch documents). All attributes from the patch documents will be added to the existing documents if they do not yet exist, and overwritten in the existing documents if they do exist there.

Type Parameters:

T -

Parameters:

values - A list of documents

entityClass - The entity class which represents the collection

Returns:

information about the documents

Throws:

org.springframework.dao.DataAccessException

update

<T> com.arangodb.entity.DocumentEntity update(Object id,
                                              T value,
                                              com.arangodb.model.DocumentUpdateOptions options)
                                       throws org.springframework.dao.DataAccessException

Partially updates the document identified by document id or key. The value must contain a document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.

Parameters:

id - The id or key of the document

value - A representation of a single document

options - Additional options, can be null

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

update

<T> com.arangodb.entity.DocumentEntity update(Object id,
                                              T value)
                                       throws org.springframework.dao.DataAccessException

Partially updates the document identified by document id or key. The value must contain a document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.

Parameters:

id - The id or key of the document

value - A representation of a single document

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

replace

<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity> replace(Iterable<T> values,
                                                                                                  Class<T> entityClass,
                                                                                                  com.arangodb.model.DocumentReplaceOptions options)
                                                                                           throws org.springframework.dao.DataAccessException

Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are specified by the _key attributes in the documents in values.

Type Parameters:

T -

Parameters:

values - A List of documents

entityClass - The entity class which represents the collection

options - Additional options, can be null

Returns:

information about the documents

Throws:

org.springframework.dao.DataAccessException

replace

<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity> replace(Iterable<T> values,
                                                                                                  Class<T> entityClass)
                                                                                           throws org.springframework.dao.DataAccessException

Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are specified by the _key attributes in the documents in values.

Type Parameters:

T -

Parameters:

values - A List of documents

entityClass - The entity class which represents the collection

options - Additional options, can be null

Returns:

information about the documents

Throws:

org.springframework.dao.DataAccessException

replace

<T> com.arangodb.entity.DocumentEntity replace(Object id,
                                               T value,
                                               com.arangodb.model.DocumentReplaceOptions options)
                                        throws org.springframework.dao.DataAccessException

Replaces the document with id with the one in the body, provided there is such a document and no precondition is violated

Parameters:

id - The id or key of the document

value - A representation of a single document

options - Additional options, can be null

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

replace

<T> com.arangodb.entity.DocumentEntity replace(Object id,
                                               T value)
                                        throws org.springframework.dao.DataAccessException

Replaces the document with id with the one in the body, provided there is such a document and no precondition is violated

Parameters:

id - The id or key of the document

value - A representation of a single document

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

find

<T> Optional<T> find(Object id,
                     Class<T> entityClass,
                     com.arangodb.model.DocumentReadOptions options)
              throws org.springframework.dao.DataAccessException

Retrieves the document with the given id from a collection.

Parameters:

id - The id or key of the document

entityClass - The entity class which represents the collection

options - Additional options, can be null

Returns:

the document identified by the id

Throws:

org.springframework.dao.DataAccessException

find

<T> Optional<T> find(Object id,
                     Class<T> entityClass)
              throws org.springframework.dao.DataAccessException

Retrieves the document with the given id from a collection.

Parameters:

id - The id or key of the document

entityClass - The entity class which represents the collection

Returns:

the document identified by the id

Throws:

org.springframework.dao.DataAccessException

findAll

<T> Iterable<T> findAll(Class<T> entityClass)
                 throws org.springframework.dao.DataAccessException

Retrieves all documents from a collection.

Parameters:

entityClass - The entity class which represents the collection

Returns:

the documents

Throws:

org.springframework.dao.DataAccessException

find

<T> Iterable<T> find(Iterable<? extends Object> ids,
                     Class<T> entityClass)
              throws org.springframework.dao.DataAccessException

Retrieves multiple documents with the given ids from a collection.

Parameters:

ids - The ids or keys of the documents

entityClass - The entity class which represents the collection

Returns:

the documents

Throws:

org.springframework.dao.DataAccessException

insert

<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity> insert(Iterable<T> values,
                                                                                                 Class<T> entityClass,
                                                                                                 com.arangodb.model.DocumentCreateOptions options)
                                                                                          throws org.springframework.dao.DataAccessException

Creates new documents from the given documents, unless there is already a document with the _key given. If no _key is given, a new unique _key is generated automatically.

Type Parameters:

T -

Parameters:

values - A List of documents

entityClass - The entity class which represents the collection

options - Additional options, can be null

Returns:

information about the documents

Throws:

org.springframework.dao.DataAccessException

insert

<T> com.arangodb.entity.MultiDocumentEntity<? extends com.arangodb.entity.DocumentEntity> insert(Iterable<T> values,
                                                                                                 Class<T> entityClass)
                                                                                          throws org.springframework.dao.DataAccessException

Creates new documents from the given documents, unless there is already a document with the _key given. If no _key is given, a new unique _key is generated automatically.

Type Parameters:

T -

Parameters:

values - A List of documents

entityClass - The entity class which represents the collection

Returns:

information about the documents

Throws:

org.springframework.dao.DataAccessException

insert

<T> com.arangodb.entity.DocumentEntity insert(T value,
                                              com.arangodb.model.DocumentCreateOptions options)
                                       throws org.springframework.dao.DataAccessException

Creates a new document from the given document, unless there is already a document with the _key given. If no _key is given, a new unique _key is generated automatically.

Parameters:

value - A representation of a single document

options - Additional options, can be null

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

insert

<T> com.arangodb.entity.DocumentEntity insert(T value)
                                       throws org.springframework.dao.DataAccessException

Creates a new document from the given document, unless there is already a document with the _key given. If no _key is given, a new unique _key is generated automatically.

Parameters:

value - A representation of a single document

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

insert

com.arangodb.entity.DocumentEntity insert(String collectionName,
                                          Object value,
                                          com.arangodb.model.DocumentCreateOptions options)
                                   throws org.springframework.dao.DataAccessException

Creates a new document from the given document, unless there is already a document with the _key given. If no _key is given, a new unique _key is generated automatically.

Parameters:

collectionName - Name of the collection in which the new document should be inserted

value - A representation of a single document

options - Additional options, can be null

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

insert

com.arangodb.entity.DocumentEntity insert(String collectionName,
                                          Object value)
                                   throws org.springframework.dao.DataAccessException

Creates a new document from the given document, unless there is already a document with the _key given. If no _key is given, a new unique _key is generated automatically.

Parameters:

collectionName - Name of the collection in which the new document should be inserted

value - A representation of a single document

Returns:

information about the document

Throws:

org.springframework.dao.DataAccessException

upsert

@Deprecated
<T> void upsert(T value,
                            ArangoOperations.UpsertStrategy strategy)
                     throws org.springframework.dao.DataAccessException

Deprecated. use repsert(Object) instead

Creates a new document from the given document, unless there is already a document with the id given. In that case it updates or replaces the document, depending on the chosen strategy.

Parameters:

value - A representation of a single document

strategy - The strategy to use when not inserting the document

Throws:

org.springframework.dao.DataAccessException

upsert

@Deprecated
<T> void upsert(Iterable<T> value,
                            ArangoOperations.UpsertStrategy strategy)
                     throws org.springframework.dao.DataAccessException

Deprecated. use #repsert(Iterable) instead

Creates new documents from the given documents, unless there already exists. In that case it updates or replaces the documents, depending on the chosen strategy.

Parameters:

value - A List of documents

strategy - The strategy to use when not inserting the document

Throws:

org.springframework.dao.DataAccessException

repsert

<T> void repsert(T value)
          throws org.springframework.dao.DataAccessException

Creates a new document from the given document, unless there is already a document with the id given. In that case it replaces the document.

Parameters:

value - A representation of a single document

Throws:

org.springframework.dao.DataAccessException

Since:

ArangoDB 3.4

repsert

<T> void repsert(Iterable<T> value,
                 Class<T> entityClass)
          throws org.springframework.dao.DataAccessException

Creates new documents from the given documents, unless there already exists. In that case it replaces the documents.

Parameters:

value - A List of documents

entityClass - The entity class which represents the collection

Throws:

org.springframework.dao.DataAccessException

Since:

ArangoDB 3.4

exists

boolean exists(Object id,
               Class<?> entityClass)
        throws org.springframework.dao.DataAccessException

Checks whether the document exists by reading a single document head

Parameters:

id - The id or key of the document

entityClass - The entity type representing the collection

Returns:

true if the document exists, false if not

Throws:

org.springframework.dao.DataAccessException

dropDatabase

void dropDatabase()
           throws org.springframework.dao.DataAccessException

Drop an existing database

Throws:

org.springframework.dao.DataAccessException

collection

CollectionOperations collection(Class<?> entityClass)
                         throws org.springframework.dao.DataAccessException

Returns the operations interface for a collection. If the collection does not exists, it is created automatically.

Parameters:

entityClass - The entity type representing the collection

Returns:

CollectionOperations

Throws:

org.springframework.dao.DataAccessException

collection

CollectionOperations collection(String name)
                         throws org.springframework.dao.DataAccessException

Returns the operations interface for a collection. If the collection does not exists, it is created automatically.

Parameters:

name - The name of the collection

Returns:

CollectionOperations

Throws:

org.springframework.dao.DataAccessException

collection

CollectionOperations collection(String name,
                                com.arangodb.model.CollectionCreateOptions options)
                         throws org.springframework.dao.DataAccessException

Returns the operations interface for a collection. If the collection does not exists, it is created automatically.

Parameters:

name - The name of the collection

options - Additional options for collection creation, can be null

Returns:

CollectionOperations

Throws:

org.springframework.dao.DataAccessException

user

UserOperations user(String username)

Return the operations interface for a user. The user is not created automatically if it does not exists.

Parameters:

username - The name of the user

Returns:

UserOperations

getUsers

Iterable<com.arangodb.entity.UserEntity> getUsers()
                                           throws org.springframework.dao.DataAccessException

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:

org.springframework.dao.DataAccessException

getConverter

ArangoConverter getConverter()