ArangoCollection (arangodb-java-driver 6.20.0 API)

All Superinterfaces:

ArangoSerializationAccessor
```
@ThreadSafe
public interface ArangoCollection
extends ArangoSerializationAccessor
```
Interface for operations on ArangoDB collection level.

Author:

Mark Vollmary, Heiko Kernbach, Michele Rastelli

See Also:

Collection API Documentation, Documents API Documentation

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`CollectionPropertiesEntity`	`changeProperties(CollectionPropertiesOptions options)` Changes the properties of the collection
`CollectionPropertiesEntity`	`count()` Counts the documents in a collection
`CollectionPropertiesEntity`	`count(CollectionCountOptions options)` Counts the documents in a collection
`CollectionEntity`	`create()` Creates a collection for this collection's name, then returns collection information from the server.
`CollectionEntity`	`create(CollectionCreateOptions options)` Creates a collection with the given `options` for this collection's name, then returns collection information from the server.
`ArangoDatabase`	`db()` The the handler of the database the collection is within
`DocumentDeleteEntity<Void>`	`deleteDocument(String key)` Deletes the document with the given `key` from the collection.
`<T> DocumentDeleteEntity<T>`	`deleteDocument(String key, Class<T> type, DocumentDeleteOptions options)` Deletes the document with the given `key` from the collection.
`MultiDocumentEntity<DocumentDeleteEntity<Void>>`	`deleteDocuments(Collection<?> values)` Deletes multiple documents from the collection.
`<T> MultiDocumentEntity<DocumentDeleteEntity<T>>`	`deleteDocuments(Collection<?> values, Class<T> type, DocumentDeleteOptions options)` Deletes multiple documents from the collection.
`String`	`deleteIndex(String id)` Deletes the index with the given `id` from the collection.
`Boolean`	`documentExists(String key)` Checks if the document exists by reading a single document head
`Boolean`	`documentExists(String key, DocumentExistsOptions options)` Checks if the document exists by reading a single document head
`void`	`drop()` Deletes the collection from the database.
`void`	`drop(boolean isSystem)` Deletes the collection from the database.
`IndexEntity`	`ensureFulltextIndex(Iterable<String> fields, FulltextIndexOptions options)` Deprecated. since ArangoDB 3.10, use ArangoSearch or Inverted indexes instead.
`IndexEntity`	`ensureGeoIndex(Iterable<String> fields, GeoIndexOptions options)` Creates a geo-spatial index for the collection, if it does not already exist.
`IndexEntity`	`ensureHashIndex(Iterable<String> fields, HashIndexOptions options)` Deprecated. use `ensurePersistentIndex(Iterable, PersistentIndexOptions)` instead. Since ArangoDB 3.7 a hash index is an alias for a persistent index.
`InvertedIndexEntity`	`ensureInvertedIndex(InvertedIndexOptions options)` Creates an inverted index for the collection, if it does not already exist.
`IndexEntity`	`ensurePersistentIndex(Iterable<String> fields, PersistentIndexOptions options)` Creates a persistent index for the collection, if it does not already exist.
`IndexEntity`	`ensureSkiplistIndex(Iterable<String> fields, SkiplistIndexOptions options)` Deprecated. use `ensurePersistentIndex(Iterable, PersistentIndexOptions)` instead. Since ArangoDB 3.7 a skiplist index is an alias for a persistent index.
`IndexEntity`	`ensureTtlIndex(Iterable<String> fields, TtlIndexOptions options)` Creates a ttl index for the collection, if it does not already exist.
`IndexEntity`	`ensureZKDIndex(Iterable<String> fields, ZKDIndexOptions options)` Creates a ZKD multi-dimensional index for the collection, if it does not already exist.
`boolean`	`exists()` Checks whether the collection exists
`<T> T`	`getDocument(String key, Class<T> type)` Retrieves the document with the given `key` from the collection.
`<T> T`	`getDocument(String key, Class<T> type, DocumentReadOptions options)` Retrieves the document with the given `key` from the collection.
`<T> MultiDocumentEntity<T>`	`getDocuments(Collection<String> keys, Class<T> type)` Retrieves multiple documents with the given `_key` from the collection.
`<T> MultiDocumentEntity<T>`	`getDocuments(Collection<String> keys, Class<T> type, DocumentReadOptions options)` Retrieves multiple documents with the given `_key` from the collection.
`IndexEntity`	`getIndex(String id)` Fetches information about the index with the given `id` and returns it.
`Collection<IndexEntity>`	`getIndexes()` Fetches a list of all indexes on this collection.
`CollectionEntity`	`getInfo()` Returns information about the collection
`InvertedIndexEntity`	`getInvertedIndex(String id)` Fetches information about the inverted index with the given `id` and returns it.
`Collection<InvertedIndexEntity>`	`getInvertedIndexes()` Fetches a list of all inverted indexes on this collection.
`Permissions`	`getPermissions(String user)` Get the collection access level
`CollectionPropertiesEntity`	`getProperties()` Reads the properties of the specified collection
`ShardEntity`	`getResponsibleShard(Object value)` Returns the responsible shard for the document.
`CollectionRevisionEntity`	`getRevision()` Retrieve the collections revision
`void`	`grantAccess(String user, Permissions permissions)` Grants or revoke access to the collection for user user.
`DocumentImportEntity`	`importDocuments(Collection<?> values)` Bulk imports the given values into the collection.
`DocumentImportEntity`	`importDocuments(Collection<?> values, DocumentImportOptions options)` Bulk imports the given values into the collection.
`DocumentImportEntity`	`importDocuments(String values)` Bulk imports the given values into the collection.
`DocumentImportEntity`	`importDocuments(String values, DocumentImportOptions options)` Bulk imports the given values into the collection.
`<T> DocumentCreateEntity<T>`	`insertDocument(T value)` Creates a new document from the given document, unless there is already a document with the _key given.
`<T> 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> 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> 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.
`CollectionEntity`	`load()` Deprecated. MMFiles only
`String`	`name()` The name of the collection
`CollectionEntity`	`rename(String newName)` Renames the collection
`<T> 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> 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> 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> 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.
`void`	`resetAccess(String user)` Clear the collection access level, revert back to the default access level.
`void`	`revokeAccess(String user)` Revokes access to the collection for user user.
`CollectionEntity`	`truncate()` Removes all documents from the collection, but leaves the indexes intact
`CollectionEntity`	`truncate(CollectionTruncateOptions options)` Removes all documents from the collection, but leaves the indexes intact
`CollectionEntity`	`unload()` Deprecated. MMFiles only
`<T> DocumentUpdateEntity<T>`	`updateDocument(String key, T value)` Partially updates the document identified by document-key.
`<T> DocumentUpdateEntity<T>`	`updateDocument(String key, T value, DocumentUpdateOptions options)` Partially updates the document identified by document-key.
`<T,U> DocumentUpdateEntity<U>`	`updateDocument(String key, T value, DocumentUpdateOptions options, Class<U> returnType)` Partially updates the document identified by document-key.
`<T> 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> 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.
`<T,U> MultiDocumentEntity<DocumentUpdateEntity<U>>`	`updateDocuments(Collection<T> values, DocumentUpdateOptions options, Class<U> returnType)` 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
```
ArangoDatabase 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> DocumentCreateEntity<T> insertDocument(T value)
                                    throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - insertDocument
```
<T> DocumentCreateEntity<T> insertDocument(T value,
                                           DocumentCreateOptions options)
                                    throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - insertDocuments
```
<T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Collection<T> values)
                                                          throws ArangoDBException
```
    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.
    Limitations: - the fields having null value are always removed during serialization
    
    Parameters:
    
    values - A List of documents (POJO, VPackSlice or String for JSON)
    
    Returns:
    
    information about the documents
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - insertDocuments
```
<T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Collection<T> values,
                                                                 DocumentCreateOptions options)
                                                          throws ArangoDBException
```
    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.
    Limitations: - the fields having null value are always removed during serialization
    
    Parameters:
    
    values - A List of documents (POJO, VPackSlice or String for JSON)
    
    options - Additional options, can be null
    
    Returns:
    
    information about the documents
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - importDocuments
```
DocumentImportEntity importDocuments(Collection<?> values)
                              throws ArangoDBException
```
    Bulk imports the given values into the collection.
    Limitations: - the fields having null value are always removed during serialization
    
    Parameters:
    
    values - a list of Objects that will be stored as documents
    
    Returns:
    
    information about the import
    
    Throws:
    
    ArangoDBException
  - importDocuments
```
DocumentImportEntity importDocuments(Collection<?> values,
                                     DocumentImportOptions options)
                              throws ArangoDBException
```
    Bulk imports the given values into the collection.
    Limitations: - the fields having null value are always removed during serialization
    
    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
```
DocumentImportEntity importDocuments(String values)
                              throws ArangoDBException
```
    Bulk imports the given values into the collection.
    Limitations: - the fields having null value are always removed during serialization
    
    Parameters:
    
    values - JSON-encoded array of objects that will be stored as documents
    
    Returns:
    
    information about the import
    
    Throws:
    
    ArangoDBException
  - importDocuments
```
DocumentImportEntity importDocuments(String values,
                                     DocumentImportOptions options)
                              throws ArangoDBException
```
    Bulk imports the given values into the collection.
    Limitations: - the fields having null value are always removed during serialization
    
    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> T getDocument(String key,
                  Class<T> type)
           throws ArangoDBException
```
    Retrieves the document with the given key from the collection.
    
    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> T getDocument(String key,
                  Class<T> type,
                  DocumentReadOptions options)
           throws ArangoDBException
```
    Retrieves the document with the given key from the collection.
    
    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> MultiDocumentEntity<T> getDocuments(Collection<String> keys,
                                        Class<T> type)
                                 throws ArangoDBException
```
    Retrieves multiple documents with the given _key from the collection.
    
    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
    
    Throws:
    
    ArangoDBException
  - getDocuments
```
<T> MultiDocumentEntity<T> getDocuments(Collection<String> keys,
                                        Class<T> type,
                                        DocumentReadOptions options)
                                 throws ArangoDBException
```
    Retrieves multiple documents with the given _key from the collection.
    
    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
    
    Throws:
    
    ArangoDBException
  - replaceDocument
```
<T> DocumentUpdateEntity<T> replaceDocument(String key,
                                            T value)
                                     throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - replaceDocument
```
<T> DocumentUpdateEntity<T> replaceDocument(String key,
                                            T value,
                                            DocumentReplaceOptions options)
                                     throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - replaceDocuments
```
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values)
                                                           throws ArangoDBException
```
    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.
    Limitations: - the fields having null value are always removed during serialization
    
    Parameters:
    
    values - A List of documents (POJO, VPackSlice or String for JSON)
    
    Returns:
    
    information about the documents
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - replaceDocuments
```
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values,
                                                                  DocumentReplaceOptions options)
                                                           throws ArangoDBException
```
    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.
    Limitations: - the fields having null value are always removed during serialization
    
    Parameters:
    
    values - A List of documents (POJO, VPackSlice or String for JSON)
    
    options - Additional options, can be null
    
    Returns:
    
    information about the documents
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - updateDocument
```
<T> DocumentUpdateEntity<T> updateDocument(String key,
                                           T value)
                                    throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - updateDocument
```
<T> DocumentUpdateEntity<T> updateDocument(String key,
                                           T value,
                                           DocumentUpdateOptions options)
                                    throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - updateDocument
```
<T,U> DocumentUpdateEntity<U> updateDocument(String key,
                                             T value,
                                             DocumentUpdateOptions options,
                                             Class<U> returnType)
                                      throws ArangoDBException
```
    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
    
    returnType - Type of the returned newDocument and/or oldDocument
    
    Returns:
    
    information about the document
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - updateDocuments
```
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(Collection<T> values)
                                                          throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - updateDocuments
```
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(Collection<T> values,
                                                                 DocumentUpdateOptions options)
                                                          throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - updateDocuments
```
<T,U> MultiDocumentEntity<DocumentUpdateEntity<U>> updateDocuments(Collection<T> values,
                                                                   DocumentUpdateOptions options,
                                                                   Class<U> returnType)
                                                            throws ArangoDBException
```
    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
    
    returnType - Type of the returned newDocument and/or oldDocument
    
    Returns:
    
    information about the documents
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - deleteDocument
```
DocumentDeleteEntity<Void> deleteDocument(String key)
                                   throws ArangoDBException
```
    Deletes the document with the given key from the collection.
    
    Parameters:
    
    key - The key of the document
    
    Returns:
    
    information about the document
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - deleteDocument
```
<T> DocumentDeleteEntity<T> deleteDocument(String key,
                                           Class<T> type,
                                           DocumentDeleteOptions options)
                                    throws ArangoDBException
```
    Deletes the document with the given key from the collection.
    
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - deleteDocuments
```
MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(Collection<?> values)
                                                         throws ArangoDBException
```
    Deletes multiple documents from the collection.
    
    Parameters:
    
    values - The keys of the documents or the documents themselves
    
    Returns:
    
    information about the documents
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - deleteDocuments
```
<T> MultiDocumentEntity<DocumentDeleteEntity<T>> deleteDocuments(Collection<?> values,
                                                                 Class<T> type,
                                                                 DocumentDeleteOptions options)
                                                          throws ArangoDBException
```
    Deletes multiple documents from the collection.
    
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - documentExists
```
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
```
Boolean documentExists(String key,
                       DocumentExistsOptions options)
                throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException - only thrown when DocumentExistsOptions.isCatchException() == false
    
    See Also:
    
    API Documentation
  - getIndex
```
IndexEntity getIndex(String id)
              throws ArangoDBException
```
    Fetches information about the index with the given id and returns it.
    Note: inverted indexes are not returned by this method. Use getInvertedIndex(String) instead.
    
    Parameters:
    
    id - The index-handle
    
    Returns:
    
    information about the index
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - getInvertedIndex
```
InvertedIndexEntity getInvertedIndex(String id)
                              throws ArangoDBException
```
    Fetches information about the inverted index with the given id and returns it.
    
    Parameters:
    
    id - The index-handle
    
    Returns:
    
    information about the index
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.10
    
    See Also:
    
    API Documentation
  - deleteIndex
```
String deleteIndex(String id)
            throws ArangoDBException
```
    Deletes the index with the given id from the collection.
    
    Parameters:
    
    id - The index-handle
    
    Returns:
    
    the id of the index
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - ensureHashIndex
```
@Deprecated
IndexEntity ensureHashIndex(Iterable<String> fields,
                                        HashIndexOptions options)
                                 throws ArangoDBException
```
    Deprecated. use ensurePersistentIndex(Iterable, PersistentIndexOptions) instead. Since ArangoDB 3.7 a hash index is an alias for a persistent index.
    
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - ensureSkiplistIndex
```
@Deprecated
IndexEntity ensureSkiplistIndex(Iterable<String> fields,
                                            SkiplistIndexOptions options)
                                     throws ArangoDBException
```
    Deprecated. use ensurePersistentIndex(Iterable, PersistentIndexOptions) instead. Since ArangoDB 3.7 a skiplist index is an alias for a persistent index.
    
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - ensurePersistentIndex
```
IndexEntity ensurePersistentIndex(Iterable<String> fields,
                                  PersistentIndexOptions options)
                           throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - ensureGeoIndex
```
IndexEntity ensureGeoIndex(Iterable<String> fields,
                           GeoIndexOptions options)
                    throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - ensureFulltextIndex
```
@Deprecated
IndexEntity ensureFulltextIndex(Iterable<String> fields,
                                            FulltextIndexOptions options)
                                     throws ArangoDBException
```
    Deprecated. since ArangoDB 3.10, use ArangoSearch or Inverted indexes instead.
    
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - ensureTtlIndex
```
IndexEntity ensureTtlIndex(Iterable<String> fields,
                           TtlIndexOptions options)
                    throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - ensureZKDIndex
```
IndexEntity ensureZKDIndex(Iterable<String> fields,
                           ZKDIndexOptions options)
                    throws ArangoDBException
```
    Creates a ZKD multi-dimensional index for the collection, if it does not already exist. Note that zkd indexes are an experimental feature in ArangoDB 3.9.
    
    Parameters:
    
    fields - A list of attribute paths
    
    options - Additional options, can be null
    
    Returns:
    
    information about the index
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.9
    
    See Also:
    
    API Documentation
  - ensureInvertedIndex
```
InvertedIndexEntity ensureInvertedIndex(InvertedIndexOptions options)
                                 throws ArangoDBException
```
    Creates an inverted index for the collection, if it does not already exist.
    
    Parameters:
    
    options - index creation options
    
    Returns:
    
    information about the index
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.10
    
    See Also:
    
    API Documentation
  - getIndexes
```
Collection<IndexEntity> getIndexes()
                            throws ArangoDBException
```
    Fetches a list of all indexes on this collection.
    Note: inverted indexes are not returned by this method. Use getInvertedIndexes() instead.
    
    Returns:
    
    information about the indexes
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - getInvertedIndexes
```
Collection<InvertedIndexEntity> getInvertedIndexes()
                                            throws ArangoDBException
```
    Fetches a list of all inverted indexes on this collection.
    
    Returns:
    
    information about the indexes
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.10
    
    See Also:
    
    API Documentation
  - exists
```
boolean exists()
        throws ArangoDBException
```
    Checks whether the collection exists
    
    Returns:
    
    true if the collection exists, otherwise false
    
    Throws:
    
    ArangoDBException
  - truncate
```
CollectionEntity truncate()
                   throws ArangoDBException
```
    Removes all documents from the collection, but leaves the indexes intact
    
    Returns:
    
    information about the collection
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - truncate
```
CollectionEntity truncate(CollectionTruncateOptions options)
                   throws ArangoDBException
```
    Removes all documents from the collection, but leaves the indexes intact
    
    Parameters:
    
    options -
    
    Returns:
    
    information about the collection
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.5.0
    
    See Also:
    
    API Documentation
  - count
```
CollectionPropertiesEntity count()
                          throws ArangoDBException
```
    Counts the documents in a collection
    
    Returns:
    
    information about the collection, including the number of documents
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - count
```
CollectionPropertiesEntity count(CollectionCountOptions options)
                          throws ArangoDBException
```
    Counts the documents in a collection
    
    Parameters:
    
    options -
    
    Returns:
    
    information about the collection, including the number of documents
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.5.0
    
    See Also:
    
    API Documentation
  - create
```
CollectionEntity create()
                 throws ArangoDBException
```
    Creates a collection for this collection's name, then returns collection information from the server.
    
    Returns:
    
    information about the collection
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - create
```
CollectionEntity create(CollectionCreateOptions options)
                 throws ArangoDBException
```
    Creates a collection with the given options for this collection's name, then returns collection information from the server.
    
    Parameters:
    
    options - Additional options, can be null
    
    Returns:
    
    information about the collection
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - drop
```
void drop()
   throws ArangoDBException
```
    Deletes the collection from the database.
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - drop
```
void drop(boolean isSystem)
   throws ArangoDBException
```
    Deletes the collection from the database.
    
    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.
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.1.0
    
    See Also:
    
    API Documentation
  - load
```
@Deprecated
CollectionEntity load()
                           throws ArangoDBException
```
    Deprecated. MMFiles only
    
    Tells the server to load the collection into memory.
    
    Returns:
    
    information about the collection
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - unload
```
@Deprecated
CollectionEntity unload()
                             throws ArangoDBException
```
    Deprecated. MMFiles only
    
    Tells the server to remove the 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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - getInfo
```
CollectionEntity getInfo()
                  throws ArangoDBException
```
    Returns information about the collection
    
    Returns:
    
    information about the collection
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - getProperties
```
CollectionPropertiesEntity getProperties()
                                  throws ArangoDBException
```
    Reads the properties of the specified collection
    
    Returns:
    
    properties of the collection
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - changeProperties
```
CollectionPropertiesEntity changeProperties(CollectionPropertiesOptions options)
                                     throws ArangoDBException
```
    Changes the properties of the collection
    
    Parameters:
    
    options - Additional options, can be null
    
    Returns:
    
    properties of the collection
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - rename
```
CollectionEntity rename(String newName)
                 throws ArangoDBException
```
    Renames the collection
    
    Parameters:
    
    newName - The new name
    
    Returns:
    
    information about the collection
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - getResponsibleShard
```
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
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.5.0
    
    See Also:
    
    API Documentation
  - getRevision
```
CollectionRevisionEntity getRevision()
                              throws ArangoDBException
```
    Retrieve the collections revision
    
    Returns:
    
    information about the collection, including the collections revision
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - grantAccess
```
void grantAccess(String user,
                 Permissions permissions)
          throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - revokeAccess
```
void revokeAccess(String user)
           throws ArangoDBException
```
    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
    
    Throws:
    
    ArangoDBException
    
    See Also:
    
    API Documentation
  - resetAccess
```
void resetAccess(String user)
          throws ArangoDBException
```
    Clear the collection access level, revert back to the default access level.
    
    Parameters:
    
    user - The name of the user
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.2.0
    
    See Also:
    
    API Documentation
  - getPermissions
```
Permissions getPermissions(String user)
                    throws ArangoDBException
```
    Get the collection access level
    
    Parameters:
    
    user - The name of the user
    
    Returns:
    
    permissions of the user
    
    Throws:
    
    ArangoDBException
    
    Since:
    
    ArangoDB 3.2.0
    
    See Also:
    
    API Documentation

Interface ArangoCollection

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

updateDocument

updateDocuments

updateDocuments

updateDocuments

deleteDocument

deleteDocument

deleteDocuments

deleteDocuments

documentExists

documentExists

getIndex

getInvertedIndex

deleteIndex

ensureHashIndex

ensureSkiplistIndex

ensurePersistentIndex

ensureGeoIndex

ensureFulltextIndex

ensureTtlIndex

ensureZKDIndex

ensureInvertedIndex

getIndexes

getInvertedIndexes

exists

truncate

truncate

count

count

create

create

drop

drop

load

unload

getInfo

getProperties

changeProperties

rename

getResponsibleShard

getRevision

grantAccess

revokeAccess

resetAccess

getPermissions