ArangoCollectionAsync (arangodb-java-driver 6.6.3 API)

All Superinterfaces:

ArangoSerializationAccessor

All Known Implementing Classes:

ArangoCollectionAsyncImpl
```
public interface ArangoCollectionAsync
extends ArangoSerializationAccessor
```
Interface for operations on ArangoDB collection level.

Author:

Mark Vollmary

See Also:

Collection API Documentation, Documents API Documentation

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<CollectionPropertiesEntity>`	`changeProperties(CollectionPropertiesOptions options)` Changes the properties of a collection
`CompletableFuture<CollectionPropertiesEntity>`	`count()` Counts the documents in a collection
`CompletableFuture<CollectionPropertiesEntity>`	`count(CollectionCountOptions options)` Counts the documents in a collection
`CompletableFuture<CollectionEntity>`	`create()` Creates the collection
`CompletableFuture<CollectionEntity>`	`create(CollectionCreateOptions options)` Creates the collection
`ArangoDatabaseAsync`	`db()` The the handler of the database the collection is within
`CompletableFuture<DocumentDeleteEntity<Void>>`	`deleteDocument(String key)` Removes a document
`<T> CompletableFuture<DocumentDeleteEntity<T>>`	`deleteDocument(String key, Class<T> type, DocumentDeleteOptions options)` Removes a document
`CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<Void>>>`	`deleteDocuments(Collection<?> values)` Removes multiple document
`<T> CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<T>>>`	`deleteDocuments(Collection<?> values, Class<T> type, 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, 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<IndexEntity>`	`ensureFulltextIndex(Iterable<String> fields, FulltextIndexOptions options)` Creates a fulltext index for the collection, if it does not already exist.
`CompletableFuture<IndexEntity>`	`ensureGeoIndex(Iterable<String> fields, GeoIndexOptions options)` Creates a geo-spatial index for the collection, if it does not already exist.
`CompletableFuture<IndexEntity>`	`ensureHashIndex(Iterable<String> fields, HashIndexOptions options)` Creates a hash index for the collection, if it does not already exist.
`CompletableFuture<IndexEntity>`	`ensurePersistentIndex(Iterable<String> fields, PersistentIndexOptions options)` Creates a persistent index for the collection, if it does not already exist.
`CompletableFuture<IndexEntity>`	`ensureSkiplistIndex(Iterable<String> fields, SkiplistIndexOptions options)` Creates a skip-list index for the collection, if it does not already exist.
`CompletableFuture<IndexEntity>`	`ensureTtlIndex(Iterable<String> fields, TtlIndexOptions options)` Creates a ttl 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, DocumentReadOptions options)` Reads a single document
`<T> CompletableFuture<MultiDocumentEntity<T>>`	`getDocuments(Collection<String> keys, Class<T> type)` Reads multiple documents
`<T> CompletableFuture<MultiDocumentEntity<T>>`	`getDocuments(Collection<String> keys, Class<T> type, DocumentReadOptions options)` Reads multiple documents
`CompletableFuture<IndexEntity>`	`getIndex(String id)` Returns an index
`CompletableFuture<Collection<IndexEntity>>`	`getIndexes()` Returns all indexes of the collection
`CompletableFuture<CollectionEntity>`	`getInfo()` Returns information about the collection
`CompletableFuture<Permissions>`	`getPermissions(String user)` Get the collection access level
`CompletableFuture<CollectionPropertiesEntity>`	`getProperties()` Reads the properties of the specified collection
`CompletableFuture<ShardEntity>`	`getResponsibleShard(Object value)` Returns the responsible shard for the document.
`CompletableFuture<CollectionRevisionEntity>`	`getRevision()` Retrieve the collections revision
`CompletableFuture<Void>`	`grantAccess(String user, Permissions permissions)` Grants or revoke access to the collection for user user.
`CompletableFuture<DocumentImportEntity>`	`importDocuments(Collection<?> values)` Imports documents
`CompletableFuture<DocumentImportEntity>`	`importDocuments(Collection<?> values, DocumentImportOptions options)` Imports documents
`CompletableFuture<DocumentImportEntity>`	`importDocuments(String values)` Imports documents
`CompletableFuture<DocumentImportEntity>`	`importDocuments(String values, DocumentImportOptions options)` Imports documents
`<T> CompletableFuture<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<DocumentCreateEntity<T>>`	`insertDocument(T value, DocumentCreateOptions options)` Creates a new document from the given document, unless there is already a document with the _key given.
`<T> CompletableFuture<MultiDocumentEntity<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<MultiDocumentEntity<DocumentCreateEntity<T>>>`	`insertDocuments(Collection<T> values, DocumentCreateOptions options)` Creates new documents from the given documents, unless there is already a document with the _key given.
`CompletableFuture<CollectionEntity>`	`load()` Loads a collection into memory.
`String`	`name()` The name of the collection
`CompletableFuture<CollectionEntity>`	`rename(String newName)` Renames a collection
`<T> CompletableFuture<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<DocumentUpdateEntity<T>>`	`replaceDocument(String key, T value, 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<MultiDocumentEntity<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<MultiDocumentEntity<DocumentUpdateEntity<T>>>`	`replaceDocuments(Collection<T> values, 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<CollectionEntity>`	`truncate()` Removes all documents from the collection, but leaves the indexes intact
`CompletableFuture<CollectionEntity>`	`truncate(CollectionTruncateOptions options)` Removes all documents from the collection, but leaves the indexes intact
`CompletableFuture<CollectionEntity>`	`unload()` Removes a collection from memory.
`<T> CompletableFuture<DocumentUpdateEntity<T>>`	`updateDocument(String key, T value)` Partially updates the document identified by document-key.
`<T> CompletableFuture<DocumentUpdateEntity<T>>`	`updateDocument(String key, T value, DocumentUpdateOptions options)` Partially updates the document identified by document-key.
`<T> CompletableFuture<MultiDocumentEntity<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<MultiDocumentEntity<DocumentUpdateEntity<T>>>`	`updateDocuments(Collection<T> values, 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<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<DocumentCreateEntity<T>> insertDocument(T value,
                                                              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<MultiDocumentEntity<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<MultiDocumentEntity<DocumentCreateEntity<T>>> insertDocuments(Collection<T> values,
                                                                                    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<DocumentImportEntity> importDocuments(Collection<?> values)
```
    Imports documents
    
    Parameters:
    
    values - a list of Objects that will be stored as documents
    
    Returns:
    
    information about the import
  - importDocuments
```
CompletableFuture<DocumentImportEntity> importDocuments(Collection<?> values,
                                                        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
  - importDocuments
```
CompletableFuture<DocumentImportEntity> importDocuments(String values)
```
    Imports documents
    
    Parameters:
    
    values - JSON-encoded array of objects that will be stored as documents
    
    Returns:
    
    information about the import
  - importDocuments
```
CompletableFuture<DocumentImportEntity> importDocuments(String values,
                                                        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
  - getDocument
```
<T> CompletableFuture<T> getDocument(String key,
                                     Class<T> type)
                              throws 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:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - getDocument
```
<T> CompletableFuture<T> getDocument(String key,
                                     Class<T> type,
                                     DocumentReadOptions options)
                              throws 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:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - getDocuments
```
<T> CompletableFuture<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<MultiDocumentEntity<T>> getDocuments(Collection<String> keys,
                                                           Class<T> type,
                                                           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<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<DocumentUpdateEntity<T>> replaceDocument(String key,
                                                               T value,
                                                               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<MultiDocumentEntity<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<MultiDocumentEntity<DocumentUpdateEntity<T>>> replaceDocuments(Collection<T> values,
                                                                                     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<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<DocumentUpdateEntity<T>> updateDocument(String key,
                                                              T value,
                                                              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<MultiDocumentEntity<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<MultiDocumentEntity<DocumentUpdateEntity<T>>> updateDocuments(Collection<T> values,
                                                                                    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<DocumentDeleteEntity<Void>> deleteDocument(String key)
```
    Removes a document
    
    Parameters:
    
    key - The key of the document
    
    Returns:
    
    information about the document
    
    See Also:
    
    API Documentation
  - deleteDocument
```
<T> CompletableFuture<DocumentDeleteEntity<T>> deleteDocument(String key,
                                                              Class<T> type,
                                                              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<MultiDocumentEntity<DocumentDeleteEntity<Void>>> deleteDocuments(Collection<?> values)
```
    Removes multiple document
    
    Parameters:
    
    values - The keys of the documents or the documents themselves
    
    Returns:
    
    information about the documents
    
    See Also:
    
    API Documentation
  - deleteDocuments
```
<T> CompletableFuture<MultiDocumentEntity<DocumentDeleteEntity<T>>> deleteDocuments(Collection<?> values,
                                                                                    Class<T> type,
                                                                                    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,
                                          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<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<IndexEntity> ensureHashIndex(Iterable<String> fields,
                                               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<IndexEntity> ensureSkiplistIndex(Iterable<String> fields,
                                                   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<IndexEntity> ensurePersistentIndex(Iterable<String> fields,
                                                     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<IndexEntity> ensureGeoIndex(Iterable<String> fields,
                                              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<IndexEntity> ensureFulltextIndex(Iterable<String> fields,
                                                   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
  - ensureTtlIndex
```
CompletableFuture<IndexEntity> ensureTtlIndex(Iterable<String> fields,
                                              TtlIndexOptions options)
```
    Creates a ttl 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<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<CollectionEntity> truncate()
```
    Removes all documents from the collection, but leaves the indexes intact
    
    Returns:
    
    information about the collection
    
    See Also:
    
    API Documentation
  - truncate
```
CompletableFuture<CollectionEntity> truncate(CollectionTruncateOptions options)
```
    Removes all documents from the collection, but leaves the indexes intact
    
    Returns:
    
    information about the collection
    
    See Also:
    
    API Documentation
  - count
```
CompletableFuture<CollectionPropertiesEntity> count()
```
    Counts the documents in a collection
    
    Returns:
    
    information about the collection, including the number of documents
    
    See Also:
    
    API Documentation
  - count
```
CompletableFuture<CollectionPropertiesEntity> count(CollectionCountOptions options)
```
    Counts the documents in a collection
    
    Returns:
    
    information about the collection, including the number of documents
    
    See Also:
    
    API Documentation
  - create
```
CompletableFuture<CollectionEntity> create()
```
    Creates the collection
    
    Returns:
    
    information about the collection
    
    See Also:
    
    API Documentation
  - create
```
CompletableFuture<CollectionEntity> create(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<CollectionEntity> load()
```
    Loads a collection into memory.
    
    Returns:
    
    information about the collection
    
    See Also:
    
    API Documentation
  - unload
```
CompletableFuture<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<CollectionEntity> getInfo()
```
    Returns information about the collection
    
    Returns:
    
    information about the collection
    
    See Also:
    
    API Documentation
  - getProperties
```
CompletableFuture<CollectionPropertiesEntity> getProperties()
```
    Reads the properties of the specified collection
    
    Returns:
    
    properties of the collection
    
    See Also:
    
    API Documentation
  - changeProperties
```
CompletableFuture<CollectionPropertiesEntity> changeProperties(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<CollectionEntity> rename(String newName)
```
    Renames a collection
    
    Parameters:
    
    newName - The new name
    
    Returns:
    
    information about the collection
    
    See Also:
    
    API Documentation
  - getResponsibleShard
```
CompletableFuture<ShardEntity> getResponsibleShard(Object value)
```
    Returns the responsible shard for the document. Please note that this API is only meaningful and available on a cluster coordinator.
    
    Parameters:
    
    value - A projection of the document containing at least the shard key (_key or a custom attribute) for which the responsible shard should be determined
    
    Returns:
    
    information about the responsible shard
    
    Since:
    
    ArangoDB 3.5.0
    
    See Also:
    
    API Documentation
  - getRevision
```
CompletableFuture<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,
                                    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<Permissions> getPermissions(String user)
```
    Get the collection access level
    
    Parameters:
    
    user - The name of the user
    
    Returns:
    
    permissions of the user
    
    Since:
    
    ArangoDB 3.2.0
    
    See Also:
    
    API Documentation

Interface ArangoCollectionAsync

Method Summary

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

Method Detail

db

name

insertDocument

insertDocument

insertDocuments

insertDocuments

importDocuments

importDocuments

importDocuments

importDocuments

getDocument

getDocument

getDocuments

getDocuments

replaceDocument

replaceDocument

replaceDocuments

replaceDocuments

updateDocument

updateDocument

updateDocuments

updateDocuments

deleteDocument

deleteDocument

deleteDocuments

deleteDocuments

documentExists

documentExists

getIndex

deleteIndex

ensureHashIndex

ensureSkiplistIndex

ensurePersistentIndex

ensureGeoIndex

ensureFulltextIndex

ensureTtlIndex

getIndexes

exists

truncate

truncate

count

count

create

create

drop

drop

load

unload

getInfo

getProperties

changeProperties

rename

getResponsibleShard

getRevision

grantAccess

revokeAccess

resetAccess

getPermissions