com.arangodb

Interface ArangoCollectionAsync

All Superinterfaces:

com.arangodb.ArangoSerializationAccessor

public interface ArangoCollectionAsync
extends com.arangodb.ArangoSerializationAccessor

Interface for operations on ArangoDB collection level.

Author:

Mark Vollmary

See Also:

Collection API Documentation, Documents API Documentation

Method Summary

Modifier and Type	Method and Description
CompletableFuture<com.arangodb.entity.CollectionPropertiesEntity>	changeProperties(com.arangodb.model.CollectionPropertiesOptions options) Changes the properties of a collection
CompletableFuture<com.arangodb.entity.CollectionPropertiesEntity>	count() Counts the documents in a collection
CompletableFuture<com.arangodb.entity.CollectionEntity>	create() Creates the collection
CompletableFuture<com.arangodb.entity.CollectionEntity>	create(com.arangodb.model.CollectionCreateOptions options) Creates the collection
ArangoDatabaseAsync	db() The the handler of the database the collection is within
CompletableFuture<com.arangodb.entity.DocumentDeleteEntity<Void>>	deleteDocument(String key) Removes a document
<T> CompletableFuture<com.arangodb.entity.DocumentDeleteEntity<T>>	deleteDocument(String key, Class<T> type, com.arangodb.model.DocumentDeleteOptions options) Removes a document
CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentDeleteEntity<Void>>>	deleteDocuments(Collection<?> values) Removes multiple document
<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentDeleteEntity<T>>>	deleteDocuments(Collection<?> values, Class<T> type, com.arangodb.model.DocumentDeleteOptions options) Removes multiple document
CompletableFuture<String>	deleteIndex(String id) Deletes an index
CompletableFuture<Boolean>	documentExists(String key) Checks if the document exists by reading a single document head
CompletableFuture<Boolean>	documentExists(String key, com.arangodb.model.DocumentExistsOptions options) Checks if the document exists by reading a single document head
CompletableFuture<Void>	drop() Drops the collection
CompletableFuture<Void>	drop(boolean isSystem) Drops the collection
CompletableFuture<com.arangodb.entity.IndexEntity>	ensureFulltextIndex(Iterable<String> fields, com.arangodb.model.FulltextIndexOptions options) Creates a fulltext index for the collection, if it does not already exist.
CompletableFuture<com.arangodb.entity.IndexEntity>	ensureGeoIndex(Iterable<String> fields, com.arangodb.model.GeoIndexOptions options) Creates a geo-spatial index for the collection, if it does not already exist.
CompletableFuture<com.arangodb.entity.IndexEntity>	ensureHashIndex(Iterable<String> fields, com.arangodb.model.HashIndexOptions options) Creates a hash index for the collection, if it does not already exist.
CompletableFuture<com.arangodb.entity.IndexEntity>	ensurePersistentIndex(Iterable<String> fields, com.arangodb.model.PersistentIndexOptions options) Creates a persistent index for the collection, if it does not already exist.
CompletableFuture<com.arangodb.entity.IndexEntity>	ensureSkiplistIndex(Iterable<String> fields, com.arangodb.model.SkiplistIndexOptions options) Creates a skip-list index for the collection, if it does not already exist.
CompletableFuture<Boolean>	exists() Checks whether the collection exists
<T> CompletableFuture<T>	getDocument(String key, Class<T> type) Reads a single document
<T> CompletableFuture<T>	getDocument(String key, Class<T> type, com.arangodb.model.DocumentReadOptions options) Reads a single document
<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<T>>	getDocuments(Collection<String> keys, Class<T> type) Reads multiple documents
<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<T>>	getDocuments(Collection<String> keys, Class<T> type, com.arangodb.model.DocumentReadOptions options) Reads multiple documents
CompletableFuture<com.arangodb.entity.IndexEntity>	getIndex(String id) Returns an index
CompletableFuture<Collection<com.arangodb.entity.IndexEntity>>	getIndexes() Returns all indexes of the collection
CompletableFuture<com.arangodb.entity.CollectionEntity>	getInfo() Returns information about the collection
CompletableFuture<com.arangodb.entity.Permissions>	getPermissions(String user) Get the collection access level
CompletableFuture<com.arangodb.entity.CollectionPropertiesEntity>	getProperties() Reads the properties of the specified collection
CompletableFuture<com.arangodb.entity.CollectionRevisionEntity>	getRevision() Retrieve the collections revision
CompletableFuture<Void>	grantAccess(String user, com.arangodb.entity.Permissions permissions) Grants or revoke access to the collection for user user.
CompletableFuture<com.arangodb.entity.DocumentImportEntity>	importDocuments(Collection<?> values) Imports documents
CompletableFuture<com.arangodb.entity.DocumentImportEntity>	importDocuments(Collection<?> values, com.arangodb.model.DocumentImportOptions options) Imports documents
CompletableFuture<com.arangodb.entity.DocumentImportEntity>	importDocuments(String values) Imports documents
CompletableFuture<com.arangodb.entity.DocumentImportEntity>	importDocuments(String values, com.arangodb.model.DocumentImportOptions options) Imports documents
<T> CompletableFuture<com.arangodb.entity.DocumentCreateEntity<T>>	insertDocument(T value) Creates a new document from the given document, unless there is already a document with the _key given.
<T> CompletableFuture<com.arangodb.entity.DocumentCreateEntity<T>>	insertDocument(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> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentCreateEntity<T>>>	insertDocuments(Collection<T> values) Creates new documents from the given documents, unless there is already a document with the _key given.
<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentCreateEntity<T>>>	insertDocuments(Collection<T> values, com.arangodb.model.DocumentCreateOptions options) Creates new documents from the given documents, unless there is already a document with the _key given.
CompletableFuture<com.arangodb.entity.CollectionEntity>	load() Loads a collection into memory.
String	name() The name of the collection
CompletableFuture<com.arangodb.entity.CollectionEntity>	rename(String newName) Renames a collection
<T> CompletableFuture<com.arangodb.entity.DocumentUpdateEntity<T>>	replaceDocument(String key, T value) Replaces the document with key with the one in the body, provided there is such a document and no precondition is violated
<T> CompletableFuture<com.arangodb.entity.DocumentUpdateEntity<T>>	replaceDocument(String key, T value, com.arangodb.model.DocumentReplaceOptions options) Replaces the document with key with the one in the body, provided there is such a document and no precondition is violated
<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentUpdateEntity<T>>>	replaceDocuments(Collection<T> values) 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> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentUpdateEntity<T>>>	replaceDocuments(Collection<T> values, 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.
CompletableFuture<Void>	resetAccess(String user) Clear the collection access level, revert back to the default access level.
CompletableFuture<Void>	revokeAccess(String user) Revokes access to the collection for user user.
CompletableFuture<com.arangodb.entity.CollectionEntity>	truncate() Removes all documents from the collection, but leaves the indexes intact
CompletableFuture<com.arangodb.entity.CollectionEntity>	unload() Removes a collection from memory.
<T> CompletableFuture<com.arangodb.entity.DocumentUpdateEntity<T>>	updateDocument(String key, T value) Partially updates the document identified by document-key.
<T> CompletableFuture<com.arangodb.entity.DocumentUpdateEntity<T>>	updateDocument(String key, T value, com.arangodb.model.DocumentUpdateOptions options) Partially updates the document identified by document-key.
<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentUpdateEntity<T>>>	updateDocuments(Collection<T> values) Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.
<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentUpdateEntity<T>>>	updateDocuments(Collection<T> values, com.arangodb.model.DocumentUpdateOptions options) Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

db

ArangoDatabaseAsync db()

The the handler of the database the collection is within

Returns:

database handler

name

String name()

The name of the collection

Returns:

collection name

insertDocument

<T> CompletableFuture<com.arangodb.entity.DocumentCreateEntity<T>> insertDocument(T value)

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 (POJO, VPackSlice or String for Json)

Returns:

information about the document

See Also:

API Documentation

insertDocument

<T> CompletableFuture<com.arangodb.entity.DocumentCreateEntity<T>> insertDocument(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. If no _key is given, a new unique _key is generated automatically.

Parameters:

value - A representation of a single document (POJO, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the document

See Also:

API Documentation

insertDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentCreateEntity<T>>> insertDocuments(Collection<T> values)

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.

Parameters:

values - A List of documents (POJO, VPackSlice or String for Json)

Returns:

information about the documents

See Also:

API Documentation

insertDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentCreateEntity<T>>> insertDocuments(Collection<T> values,
                                                                                                                            com.arangodb.model.DocumentCreateOptions options)

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.

Parameters:

values - A List of documents (POJO, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the documents

See Also:

API Documentation

importDocuments

CompletableFuture<com.arangodb.entity.DocumentImportEntity> importDocuments(Collection<?> values)

Imports documents

Parameters:

values - a list of Objects that will be stored as documents

Returns:

information about the import

Throws:

ArangoDBException

importDocuments

CompletableFuture<com.arangodb.entity.DocumentImportEntity> importDocuments(Collection<?> values,
                                                                            com.arangodb.model.DocumentImportOptions options)

Imports documents

Parameters:

values - a list of Objects that will be stored as documents

options - Additional options, can be null

Returns:

information about the import

Throws:

ArangoDBException

importDocuments

CompletableFuture<com.arangodb.entity.DocumentImportEntity> importDocuments(String values)

Imports documents

Parameters:

values - JSON-encoded array of objects that will be stored as documents

Returns:

information about the import

Throws:

ArangoDBException

importDocuments

CompletableFuture<com.arangodb.entity.DocumentImportEntity> importDocuments(String values,
                                                                            com.arangodb.model.DocumentImportOptions options)

Imports documents

Parameters:

values - JSON-encoded array of objects that will be stored as documents

options - Additional options, can be null

Returns:

information about the import

Throws:

ArangoDBException

getDocument

<T> CompletableFuture<T> getDocument(String key,
                                     Class<T> type)
                              throws com.arangodb.ArangoDBException

Reads a single document

Parameters:

key - The key of the document

type - The type of the document (POJO class, VPackSlice or String for Json)

Returns:

the document identified by the key

Throws:

com.arangodb.ArangoDBException

See Also:

API Documentation

getDocument

<T> CompletableFuture<T> getDocument(String key,
                                     Class<T> type,
                                     com.arangodb.model.DocumentReadOptions options)
                              throws com.arangodb.ArangoDBException

Reads a single document

Parameters:

key - The key 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 key

Throws:

com.arangodb.ArangoDBException

See Also:

API Documentation

getDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<T>> getDocuments(Collection<String> keys,
                                                                               Class<T> type)

Reads multiple documents

Parameters:

keys - The keys of the documents

type - The type of the documents (POJO class, VPackSlice or String for Json)

Returns:

the documents and possible errors

getDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<T>> getDocuments(Collection<String> keys,
                                                                               Class<T> type,
                                                                               com.arangodb.model.DocumentReadOptions options)

Reads multiple documents

Parameters:

keys - The keys of the documents

type - The type of the documents (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

the documents and possible errors

replaceDocument

<T> CompletableFuture<com.arangodb.entity.DocumentUpdateEntity<T>> replaceDocument(String key,
                                                                                   T value)

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

Parameters:

key - The key of the document

value - A representation of a single document (POJO, VPackSlice or String for Json)

Returns:

information about the document

See Also:

API Documentation

replaceDocument

<T> CompletableFuture<com.arangodb.entity.DocumentUpdateEntity<T>> replaceDocument(String key,
                                                                                   T value,
                                                                                   com.arangodb.model.DocumentReplaceOptions options)

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

Parameters:

key - The key of the document

value - A representation of a single document (POJO, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the document

See Also:

API Documentation

replaceDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentUpdateEntity<T>>> replaceDocuments(Collection<T> values)

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.

Parameters:

values - A List of documents (POJO, VPackSlice or String for Json)

Returns:

information about the documents

See Also:

API Documentation

replaceDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentUpdateEntity<T>>> replaceDocuments(Collection<T> values,
                                                                                                                             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.

Parameters:

values - A List of documents (POJO, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the documents

See Also:

API Documentation

updateDocument

<T> CompletableFuture<com.arangodb.entity.DocumentUpdateEntity<T>> updateDocument(String key,
                                                                                  T value)

Partially updates the document identified by document-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:

key - The key of the document

value - A representation of a single document (POJO, VPackSlice or String for Json)

Returns:

information about the document

See Also:

API Documentation

updateDocument

<T> CompletableFuture<com.arangodb.entity.DocumentUpdateEntity<T>> updateDocument(String key,
                                                                                  T value,
                                                                                  com.arangodb.model.DocumentUpdateOptions options)

Partially updates the document identified by document-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:

key - The key of the document

value - A representation of a single document (POJO, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the document

See Also:

API Documentation

updateDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentUpdateEntity<T>>> updateDocuments(Collection<T> values)

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.

Parameters:

values - A list of documents (POJO, VPackSlice or String for Json)

Returns:

information about the documents

See Also:

API Documentation

updateDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentUpdateEntity<T>>> updateDocuments(Collection<T> values,
                                                                                                                            com.arangodb.model.DocumentUpdateOptions options)

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.

Parameters:

values - A list of documents (POJO, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the documents

See Also:

API Documentation

deleteDocument

CompletableFuture<com.arangodb.entity.DocumentDeleteEntity<Void>> deleteDocument(String key)

Removes a document

Parameters:

key - The key of the document

type - The type of the document (POJO class, VPackSlice or String for Json). Only necessary if options.returnOld is set to true, otherwise can be null.

Returns:

information about the document

See Also:

API Documentation

deleteDocument

<T> CompletableFuture<com.arangodb.entity.DocumentDeleteEntity<T>> deleteDocument(String key,
                                                                                  Class<T> type,
                                                                                  com.arangodb.model.DocumentDeleteOptions options)

Removes a document

Parameters:

key - The key of the document

type - The type of the document (POJO class, VPackSlice or String for Json). Only necessary if options.returnOld is set to true, otherwise can be null.

options - Additional options, can be null

Returns:

information about the document

See Also:

API Documentation

deleteDocuments

CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentDeleteEntity<Void>>> deleteDocuments(Collection<?> values)

Removes multiple document

Parameters:

values - The keys of the documents or the documents themselves

type - The type of the documents (POJO class, VPackSlice or String for Json). Only necessary if options.returnOld is set to true, otherwise can be null.

Returns:

information about the documents

See Also:

API Documentation

deleteDocuments

<T> CompletableFuture<com.arangodb.entity.MultiDocumentEntity<com.arangodb.entity.DocumentDeleteEntity<T>>> deleteDocuments(Collection<?> values,
                                                                                                                            Class<T> type,
                                                                                                                            com.arangodb.model.DocumentDeleteOptions options)

Removes multiple document

Parameters:

values - The keys of the documents or the documents themselves

type - The type of the documents (POJO class, VPackSlice or String for Json). Only necessary if options.returnOld is set to true, otherwise can be null.

options - Additional options, can be null

Returns:

information about the documents

See Also:

API Documentation

documentExists

CompletableFuture<Boolean> documentExists(String key)

Checks if the document exists by reading a single document head

Parameters:

key - The key of the document

Returns:

true if the document was found, otherwise false

See Also:

API Documentation

documentExists

CompletableFuture<Boolean> documentExists(String key,
                                          com.arangodb.model.DocumentExistsOptions options)

Checks if the document exists by reading a single document head

Parameters:

key - The key of the document

options - Additional options, can be null

Returns:

true if the document was found, otherwise false

See Also:

API Documentation

getIndex

CompletableFuture<com.arangodb.entity.IndexEntity> getIndex(String id)

Returns an index

Parameters:

id - The index-handle

Returns:

information about the index

See Also:

API Documentation

deleteIndex

CompletableFuture<String> deleteIndex(String id)

Deletes an index

Parameters:

id - The index-handle

Returns:

the id of the index

See Also:

API Documentation

ensureHashIndex

CompletableFuture<com.arangodb.entity.IndexEntity> ensureHashIndex(Iterable<String> fields,
                                                                   com.arangodb.model.HashIndexOptions options)

Creates a hash index for the collection, if it does not already exist.

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

API Documentation

ensureSkiplistIndex

CompletableFuture<com.arangodb.entity.IndexEntity> ensureSkiplistIndex(Iterable<String> fields,
                                                                       com.arangodb.model.SkiplistIndexOptions options)

Creates a skip-list index for the collection, if it does not already exist.

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

API Documentation

ensurePersistentIndex

CompletableFuture<com.arangodb.entity.IndexEntity> ensurePersistentIndex(Iterable<String> fields,
                                                                         com.arangodb.model.PersistentIndexOptions options)

Creates a persistent index for the collection, if it does not already exist.

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

API Documentation

ensureGeoIndex

CompletableFuture<com.arangodb.entity.IndexEntity> ensureGeoIndex(Iterable<String> fields,
                                                                  com.arangodb.model.GeoIndexOptions options)

Creates a geo-spatial index for the collection, if it does not already exist.

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

API Documentation

ensureFulltextIndex

CompletableFuture<com.arangodb.entity.IndexEntity> ensureFulltextIndex(Iterable<String> fields,
                                                                       com.arangodb.model.FulltextIndexOptions options)

Creates a fulltext index for the collection, if it does not already exist.

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

API Documentation

getIndexes

CompletableFuture<Collection<com.arangodb.entity.IndexEntity>> getIndexes()

Returns all indexes of the collection

Returns:

information about the indexes

See Also:

API Documentation

exists

CompletableFuture<Boolean> exists()

Checks whether the collection exists

Returns:

true if the collection exists, otherwise false

truncate

CompletableFuture<com.arangodb.entity.CollectionEntity> truncate()

Removes all documents from the collection, but leaves the indexes intact

Returns:

information about the collection

See Also:

API Documentation

count

CompletableFuture<com.arangodb.entity.CollectionPropertiesEntity> count()

Counts the documents in a collection

Returns:

information about the collection, including the number of documents

See Also:

API Documentation

create

CompletableFuture<com.arangodb.entity.CollectionEntity> create()

Creates the collection

Parameters:

options - Additional options, can be null

Returns:

information about the collection

See Also:

API Documentation

create

CompletableFuture<com.arangodb.entity.CollectionEntity> create(com.arangodb.model.CollectionCreateOptions options)

Creates the collection

Parameters:

options - Additional options, can be null

Returns:

information about the collection

See Also:

API Documentation

drop

CompletableFuture<Void> drop()

Drops the collection

Returns:

void

See Also:

API Documentation

drop

CompletableFuture<Void> drop(boolean isSystem)

Drops the collection

Parameters:

isSystem - Whether or not the collection to drop is a system collection. This parameter must be set to true in order to drop a system collection.

Returns:

void

See Also:

API Documentation

load

CompletableFuture<com.arangodb.entity.CollectionEntity> load()

Loads a collection into memory.

Returns:

information about the collection

See Also:

API Documentation

unload

CompletableFuture<com.arangodb.entity.CollectionEntity> unload()

Removes a collection from memory. This call does not delete any documents. You can use the collection afterwards; in which case it will be loaded into memory, again.

Returns:

information about the collection

See Also:

API Documentation

getInfo

CompletableFuture<com.arangodb.entity.CollectionEntity> getInfo()

Returns information about the collection

Returns:

information about the collection

See Also:

API Documentation

getProperties

CompletableFuture<com.arangodb.entity.CollectionPropertiesEntity> getProperties()

Reads the properties of the specified collection

Returns:

properties of the collection

See Also:

API Documentation

changeProperties

CompletableFuture<com.arangodb.entity.CollectionPropertiesEntity> changeProperties(com.arangodb.model.CollectionPropertiesOptions options)

Changes the properties of a collection

Parameters:

options - Additional options, can be null

Returns:

properties of the collection

See Also:

API Documentation

rename

CompletableFuture<com.arangodb.entity.CollectionEntity> rename(String newName)

Renames a collection

Parameters:

newName - The new name

Returns:

information about the collection

See Also:

API Documentation

getRevision

CompletableFuture<com.arangodb.entity.CollectionRevisionEntity> getRevision()

Retrieve the collections revision

Returns:

information about the collection, including the collections revision

See Also:

API Documentation

grantAccess

CompletableFuture<Void> grantAccess(String user,
                                    com.arangodb.entity.Permissions permissions)

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

Returns:

void

See Also:

API Documentation

revokeAccess

CompletableFuture<Void> revokeAccess(String user)

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

Parameters:

user - The name of the user

Returns:

void

See Also:

API Documentation

resetAccess

CompletableFuture<Void> resetAccess(String user)

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

Parameters:

user - The name of the user

Returns:

void

Since:

ArangoDB 3.2.0

See Also:

API Documentation

getPermissions

CompletableFuture<com.arangodb.entity.Permissions> getPermissions(String user)
                                                           throws com.arangodb.ArangoDBException

Get the collection access level

Parameters:

user - The name of the user

Returns:

permissions of the user

Throws:

com.arangodb.ArangoDBException

Since:

ArangoDB 3.2.0

See Also:

API Documentation