Package com.arangodb.internal

Class ArangoCollectionImpl

java.lang.Object

com.arangodb.internal.ArangoExecuteable

com.arangodb.internal.InternalArangoCollection

com.arangodb.internal.ArangoCollectionImpl

All Implemented Interfaces:

ArangoCollection, ArangoSerdeAccessor

public class ArangoCollectionImpl
extends InternalArangoCollection
implements ArangoCollection

Author:

Mark Vollmary, Michele Rastelli

Field Summary

Fields inherited from class com.arangodb.internal.InternalArangoCollection

dbName, name, PATH_API_COLLECTION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ArangoCollectionImpl(ArangoDatabaseImpl db, String name)

Method Summary

Modifier and Type	Method	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.
DocumentDeleteEntity<Void>	deleteDocument(String key, DocumentDeleteOptions options)	Deletes the document with the given key from the collection.
<T> DocumentDeleteEntity<T>	deleteDocument(String key, DocumentDeleteOptions options, Class<T> type)	Deletes the document with the given key from the collection.
MultiDocumentEntity<DocumentDeleteEntity<Void>>	deleteDocuments(RawData values)	Deletes multiple documents from the collection.
MultiDocumentEntity<DocumentDeleteEntity<RawData>>	deleteDocuments(RawData values, DocumentDeleteOptions options)	Deletes multiple documents from the collection.
MultiDocumentEntity<DocumentDeleteEntity<Void>>	deleteDocuments(Iterable<?> values)	Deletes multiple documents from the collection.
MultiDocumentEntity<DocumentDeleteEntity<Void>>	deleteDocuments(Iterable<?> values, DocumentDeleteOptions options)	Deletes multiple documents from the collection.
<T> MultiDocumentEntity<DocumentDeleteEntity<T>>	deleteDocuments(Iterable<?> values, DocumentDeleteOptions options, Class<T> type)	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.
IndexEntity	ensureGeoIndex(Iterable<String> fields, GeoIndexOptions options)	Creates a geo-spatial index for the collection, if it does not already exist.
InvertedIndexEntity	ensureInvertedIndex(InvertedIndexOptions options)	Creates an inverted index for the collection, if it does not already exist.
IndexEntity	ensureMDIndex(Iterable<String> fields, MDIndexOptions options)	Creates a multi-dimensional index for the collection, if it does not already exist.
IndexEntity	ensureMDPrefixedIndex(Iterable<String> fields, MDPrefixedIndexOptions options)	Creates a multi-dimensional prefixed 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	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(Iterable<String> keys, Class<T> type)	Retrieves multiple documents with the given _key from the collection.
<T> MultiDocumentEntity<T>	getDocuments(Iterable<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(RawData values)	Bulk imports the given values into the collection.
DocumentImportEntity	importDocuments(RawData values, DocumentImportOptions options)	Bulk imports the given values into the collection.
DocumentImportEntity	importDocuments(Iterable<?> values)	Bulk imports the given values into the collection.
DocumentImportEntity	importDocuments(Iterable<?> values, DocumentImportOptions options)	Bulk imports the given values into the collection.
DocumentCreateEntity<Void>	insertDocument(Object 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> DocumentCreateEntity<T>	insertDocument(T value, DocumentCreateOptions options, Class<T> type)	Creates a new document from the given document, unless there is already a document with the _key given.
MultiDocumentEntity<DocumentCreateEntity<Void>>	insertDocuments(RawData values)	Creates new documents from the given documents, unless there is already a document with the _key given.
MultiDocumentEntity<DocumentCreateEntity<RawData>>	insertDocuments(RawData values, DocumentCreateOptions options)	Creates new documents from the given documents, unless there is already a document with the _key given.
MultiDocumentEntity<DocumentCreateEntity<Void>>	insertDocuments(Iterable<?> values)	Creates new documents from the given documents, unless there is already a document with the _key given.
MultiDocumentEntity<DocumentCreateEntity<Void>>	insertDocuments(Iterable<?> values, DocumentCreateOptions options)	Creates new documents from the given documents, unless there is already a document with the _key given.
<T> MultiDocumentEntity<DocumentCreateEntity<T>>	insertDocuments(Iterable<? extends T> values, DocumentCreateOptions options, Class<T> type)	Creates new documents from the given documents, unless there is already a document with the _key given.
CollectionEntity	rename(String newName)	Renames the collection
DocumentUpdateEntity<Void>	replaceDocument(String key, Object 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> DocumentUpdateEntity<T>	replaceDocument(String key, T value, DocumentReplaceOptions options, Class<T> type)	Replaces the document with key with the one in the body, provided there is such a document and no precondition is violated
MultiDocumentEntity<DocumentUpdateEntity<Void>>	replaceDocuments(RawData 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.
MultiDocumentEntity<DocumentUpdateEntity<RawData>>	replaceDocuments(RawData 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.
MultiDocumentEntity<DocumentUpdateEntity<Void>>	replaceDocuments(Iterable<?> 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.
MultiDocumentEntity<DocumentUpdateEntity<Void>>	replaceDocuments(Iterable<?> 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.
<T> MultiDocumentEntity<DocumentUpdateEntity<T>>	replaceDocuments(Iterable<? extends T> values, DocumentReplaceOptions options, Class<T> type)	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
DocumentUpdateEntity<Void>	updateDocument(String key, Object value)	Partially updates the document identified by document-key.
<T> DocumentUpdateEntity<T>	updateDocument(String key, Object value, DocumentUpdateOptions options, Class<T> returnType)	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.
MultiDocumentEntity<DocumentUpdateEntity<Void>>	updateDocuments(RawData values)	Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.
MultiDocumentEntity<DocumentUpdateEntity<RawData>>	updateDocuments(RawData values, DocumentUpdateOptions options)	Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.
MultiDocumentEntity<DocumentUpdateEntity<Void>>	updateDocuments(Iterable<?> values)	Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.
MultiDocumentEntity<DocumentUpdateEntity<Void>>	updateDocuments(Iterable<?> values, DocumentUpdateOptions options)	Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.
<T> MultiDocumentEntity<DocumentUpdateEntity<T>>	updateDocuments(Iterable<?> values, DocumentUpdateOptions options, Class<T> returnType)	Partially updates documents, the documents to update are specified by the _key attributes in the objects on values.

Methods inherited from class com.arangodb.internal.InternalArangoCollection

changePropertiesRequest, countRequest, createFulltextIndexRequest, createGeoIndexRequest, createInvertedIndexRequest, createMDIndexRequest, createPersistentIndexRequest, createTtlIndexRequest, createZKDIndexRequest, deleteDocumentRequest, deleteDocumentsRequest, deleteDocumentsRequest, deleteDocumentsResponseDeserializer, deleteIndexRequest, deleteIndexResponseDeserializer, documentExistsRequest, dropRequest, getDocumentRequest, getDocumentResponseDeserializer, getDocumentsRequest, getDocumentsResponseDeserializer, getIndexesRequest, getIndexesResponseDeserializer, getIndexRequest, getInfoRequest, getInvertedIndexesResponseDeserializer, getPermissionsRequest, getPermissionsResponseDeserialzer, getPropertiesRequest, getRevisionRequest, grantAccessRequest, importDocumentsRequest, importDocumentsRequest, importDocumentsRequest, insertDocumentRequest, insertDocumentsRequest, insertDocumentsRequest, insertDocumentsResponseDeserializer, name, renameRequest, replaceDocumentRequest, replaceDocumentsRequest, replaceDocumentsRequest, replaceDocumentsResponseDeserializer, resetAccessRequest, responsibleShardRequest, truncateRequest, updateDocumentRequest, updateDocumentsRequest, updateDocumentsRequest, updateDocumentsResponseDeserializer

Methods inherited from class com.arangodb.internal.ArangoExecuteable

createPath, executorAsync, executorSync, getSerde, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.arangodb.ArangoCollection

name

Methods inherited from interface com.arangodb.ArangoSerdeAccessor

getSerde

Constructor Details

ArangoCollectionImpl

protected ArangoCollectionImpl(ArangoDatabaseImpl db,
 String name)

Method Details

db

public ArangoDatabase db()

Description copied from interface: ArangoCollection

The the handler of the database the collection is within

Specified by:

db in interface ArangoCollection

Returns:

database handler

insertDocument

public DocumentCreateEntity<Void> insertDocument(Object value)

Description copied from interface: ArangoCollection

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.

Specified by:

insertDocument in interface ArangoCollection

Parameters:

value - A representation of a single document (POJO or RawData

Returns:

information about the document

See Also:

• API Documentation

insertDocument

public <T> DocumentCreateEntity<T> insertDocument(T value,
 DocumentCreateOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

insertDocument in interface ArangoCollection

Parameters:

value - A representation of a single document (POJO or RawData)

options - Additional options

Returns:

information about the document

See Also:

• API Documentation

insertDocument

public <T> DocumentCreateEntity<T> insertDocument(T value,
 DocumentCreateOptions options,
 Class<T> type)

Description copied from interface: ArangoCollection

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.

Specified by:

insertDocument in interface ArangoCollection

Parameters:

value - A representation of a single document (POJO or RawData)

options - Additional options

type - Deserialization target type for the returned documents.

Returns:

information about the document

See Also:

• API Documentation

insertDocuments

public MultiDocumentEntity<DocumentCreateEntity<Void>> insertDocuments(RawData values)

Description copied from interface: ArangoCollection

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.

Specified by:

insertDocuments in interface ArangoCollection

Parameters:

values - Raw data representing a collection of documents

Returns:

information about the documents

See Also:

• API Documentation

insertDocuments

public MultiDocumentEntity<DocumentCreateEntity<RawData>> insertDocuments(RawData values,
 DocumentCreateOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

insertDocuments in interface ArangoCollection

Parameters:

values - Raw data representing a collection of documents

options - Additional options

Returns:

information about the documents

See Also:

• API Documentation

insertDocuments

public MultiDocumentEntity<DocumentCreateEntity<Void>> insertDocuments(Iterable<?> values)

Description copied from interface: ArangoCollection

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.

Specified by:

insertDocuments in interface ArangoCollection

Parameters:

values - A List of documents

Returns:

information about the documents

See Also:

• API Documentation

insertDocuments

public MultiDocumentEntity<DocumentCreateEntity<Void>> insertDocuments(Iterable<?> values,
 DocumentCreateOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

insertDocuments in interface ArangoCollection

Parameters:

values - A List of documents (POJO or RawData)

options - Additional options

Returns:

information about the documents

See Also:

• API Documentation

insertDocuments

public <T>
MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Iterable<? extends T> values,
 DocumentCreateOptions options,
 Class<T> type)

Description copied from interface: ArangoCollection

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.

Specified by:

insertDocuments in interface ArangoCollection

Parameters:

values - A List of documents (POJO or RawData)

options - Additional options

type - Deserialization target type for the returned documents.

Returns:

information about the documents

See Also:

• API Documentation

importDocuments

public DocumentImportEntity importDocuments(Iterable<?> values)

Description copied from interface: ArangoCollection

Bulk imports the given values into the collection.

Specified by:

importDocuments in interface ArangoCollection

Parameters:

values - A List of documents (POJO or RawData)

Returns:

information about the import

See Also:

• API Documentation

importDocuments

public DocumentImportEntity importDocuments(Iterable<?> values,
 DocumentImportOptions options)

Description copied from interface: ArangoCollection

Bulk imports the given values into the collection.

Specified by:

importDocuments in interface ArangoCollection

Parameters:

values - A List of documents (POJO or RawData)

options - Additional options, can be null

Returns:

information about the import

See Also:

• API Documentation

importDocuments

public DocumentImportEntity importDocuments(RawData values)

Description copied from interface: ArangoCollection

Bulk imports the given values into the collection.

Specified by:

importDocuments in interface ArangoCollection

Parameters:

values - Raw data representing a collection of documents

Returns:

information about the import

See Also:

• API Documentation

importDocuments

public DocumentImportEntity importDocuments(RawData values,
 DocumentImportOptions options)

Description copied from interface: ArangoCollection

Bulk imports the given values into the collection.

Specified by:

importDocuments in interface ArangoCollection

Parameters:

values - Raw data representing a collection of documents

options - Additional options, can be null

Returns:

information about the import

See Also:

• API Documentation

getDocument

public <T> T getDocument(String key,
 Class<T> type)

Description copied from interface: ArangoCollection

Retrieves the document with the given key from the collection.

Specified by:

getDocument in interface ArangoCollection

Parameters:

key - The key of the document

type - The type of the document (POJO or RawData)

Returns:

the document identified by the key

See Also:

• API Documentation

getDocument

public <T> T getDocument(String key,
 Class<T> type,
 DocumentReadOptions options)

Description copied from interface: ArangoCollection

Retrieves the document with the given key from the collection.

Specified by:

getDocument in interface ArangoCollection

Parameters:

key - The key of the document

type - The type of the document (POJO or RawData)

options - Additional options, can be null

Returns:

the document identified by the key

See Also:

• API Documentation

getDocuments

public <T> MultiDocumentEntity<T> getDocuments(Iterable<String> keys,
 Class<T> type)

Description copied from interface: ArangoCollection

Retrieves multiple documents with the given _key from the collection.

Specified by:

getDocuments in interface ArangoCollection

Parameters:

keys - The keys of the documents

type - The type of the documents (POJO or RawData)

Returns:

the documents and possible errors

See Also:

• API Documentation

getDocuments

public <T> MultiDocumentEntity<T> getDocuments(Iterable<String> keys,
 Class<T> type,
 DocumentReadOptions options)

Description copied from interface: ArangoCollection

Retrieves multiple documents with the given _key from the collection.

Specified by:

getDocuments in interface ArangoCollection

Parameters:

keys - The keys of the documents

type - The type of the documents (POJO or RawData)

options - Additional options, can be null

Returns:

the documents and possible errors

See Also:

• API Documentation

replaceDocument

public DocumentUpdateEntity<Void> replaceDocument(String key,
 Object value)

Description copied from interface: ArangoCollection

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

Specified by:

replaceDocument in interface ArangoCollection

Parameters:

key - The key of the document

value - A representation of a single document (POJO or RawData)

Returns:

information about the document

See Also:

• API Documentation

replaceDocument

public <T> DocumentUpdateEntity<T> replaceDocument(String key,
 T value,
 DocumentReplaceOptions options)

Description copied from interface: ArangoCollection

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

Specified by:

replaceDocument in interface ArangoCollection

Parameters:

key - The key of the document

value - A representation of a single document (POJO or RawData)

options - Additional options

Returns:

information about the document

See Also:

• API Documentation

replaceDocument

public <T> DocumentUpdateEntity<T> replaceDocument(String key,
 T value,
 DocumentReplaceOptions options,
 Class<T> type)

Description copied from interface: ArangoCollection

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

Specified by:

replaceDocument in interface ArangoCollection

Parameters:

key - The key of the document

value - A representation of a single document (POJO or RawData)

options - Additional options

type - Deserialization target type for the returned documents.

Returns:

information about the document

See Also:

• API Documentation

replaceDocuments

public MultiDocumentEntity<DocumentUpdateEntity<Void>> replaceDocuments(RawData values)

Description copied from interface: ArangoCollection

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.

Specified by:

replaceDocuments in interface ArangoCollection

Parameters:

values - Raw data representing a collection of documents

Returns:

information about the documents

See Also:

• API Documentation

replaceDocuments

public MultiDocumentEntity<DocumentUpdateEntity<RawData>> replaceDocuments(RawData values,
 DocumentReplaceOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

replaceDocuments in interface ArangoCollection

Parameters:

values - Raw data representing a collection of documents

options - Additional options

Returns:

information about the documents

See Also:

• API Documentation

replaceDocuments

public MultiDocumentEntity<DocumentUpdateEntity<Void>> replaceDocuments(Iterable<?> values)

Description copied from interface: ArangoCollection

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.

Specified by:

replaceDocuments in interface ArangoCollection

Parameters:

values - A List of documents (POJO or RawData)

Returns:

information about the documents

See Also:

• API Documentation

replaceDocuments

public MultiDocumentEntity<DocumentUpdateEntity<Void>> replaceDocuments(Iterable<?> values,
 DocumentReplaceOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

replaceDocuments in interface ArangoCollection

Parameters:

values - A List of documents (POJO or RawData)

options - Additional options

Returns:

information about the documents

See Also:

• API Documentation

replaceDocuments

public <T>
MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Iterable<? extends T> values,
 DocumentReplaceOptions options,
 Class<T> type)

Description copied from interface: ArangoCollection

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.

Specified by:

replaceDocuments in interface ArangoCollection

Parameters:

values - A List of documents (POJO or RawData)

options - Additional options

type - Deserialization target type for the returned documents.

Returns:

information about the documents

See Also:

• API Documentation

updateDocument

public DocumentUpdateEntity<Void> updateDocument(String key,
 Object value)

Description copied from interface: ArangoCollection

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.

Specified by:

updateDocument in interface ArangoCollection

Parameters:

key - The key of the document

value - A representation of a single document (POJO or RawData)

Returns:

information about the document

See Also:

• API Documentation

updateDocument

public <T> DocumentUpdateEntity<T> updateDocument(String key,
 T value,
 DocumentUpdateOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

updateDocument in interface ArangoCollection

Parameters:

key - The key of the document

value - A representation of a single document (POJO or RawData)

options - Additional options

Returns:

information about the document

See Also:

• API Documentation

updateDocument

public <T> DocumentUpdateEntity<T> updateDocument(String key,
 Object value,
 DocumentUpdateOptions options,
 Class<T> returnType)

Description copied from interface: ArangoCollection

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.

Specified by:

updateDocument in interface ArangoCollection

Parameters:

key - The key of the document

value - A representation of a single document (POJO or RawData)

options - Additional options

returnType - Type of the returned newDocument and/or oldDocument

Returns:

information about the document

See Also:

• API Documentation

updateDocuments

public MultiDocumentEntity<DocumentUpdateEntity<Void>> updateDocuments(RawData values)

Description copied from interface: ArangoCollection

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.

Specified by:

updateDocuments in interface ArangoCollection

Parameters:

values - Raw data representing a collection of documents

Returns:

information about the documents

See Also:

• API Documentation

updateDocuments

public MultiDocumentEntity<DocumentUpdateEntity<RawData>> updateDocuments(RawData values,
 DocumentUpdateOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

updateDocuments in interface ArangoCollection

Parameters:

values - Raw data representing a collection of documents

options - Additional options

Returns:

information about the documents

See Also:

• API Documentation

updateDocuments

public MultiDocumentEntity<DocumentUpdateEntity<Void>> updateDocuments(Iterable<?> values)

Description copied from interface: ArangoCollection

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.

Specified by:

updateDocuments in interface ArangoCollection

Parameters:

values - A list of documents (POJO or RawData)

Returns:

information about the documents

See Also:

• API Documentation

updateDocuments

public MultiDocumentEntity<DocumentUpdateEntity<Void>> updateDocuments(Iterable<?> values,
 DocumentUpdateOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

updateDocuments in interface ArangoCollection

Parameters:

values - A list of documents (POJO or RawData)

options - Additional options

Returns:

information about the documents

See Also:

• API Documentation

updateDocuments

public <T>
MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(Iterable<?> values,
 DocumentUpdateOptions options,
 Class<T> returnType)

Description copied from interface: ArangoCollection

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.

Specified by:

updateDocuments in interface ArangoCollection

Parameters:

values - A list of documents (POJO or RawData)

options - Additional options

returnType - Type of the returned newDocument and/or oldDocument

Returns:

information about the documents

See Also:

• API Documentation

deleteDocument

public DocumentDeleteEntity<Void> deleteDocument(String key)

Description copied from interface: ArangoCollection

Deletes the document with the given key from the collection.

Specified by:

deleteDocument in interface ArangoCollection

Parameters:

key - The key of the document

Returns:

information about the document

See Also:

• API Documentation

deleteDocument

public DocumentDeleteEntity<Void> deleteDocument(String key,
 DocumentDeleteOptions options)

Description copied from interface: ArangoCollection

Deletes the document with the given key from the collection.

Specified by:

deleteDocument in interface ArangoCollection

Parameters:

key - The key of the document

options - Additional options

Returns:

information about the document

See Also:

• API Documentation

deleteDocument

public <T> DocumentDeleteEntity<T> deleteDocument(String key,
 DocumentDeleteOptions options,
 Class<T> type)

Description copied from interface: ArangoCollection

Deletes the document with the given key from the collection.

Specified by:

deleteDocument in interface ArangoCollection

Parameters:

key - The key of the document

options - Additional options

type - Deserialization target type for the returned documents.

Returns:

information about the document

See Also:

• API Documentation

deleteDocuments

public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(RawData values)

Description copied from interface: ArangoCollection

Deletes multiple documents from the collection.

Specified by:

deleteDocuments in interface ArangoCollection

Parameters:

values - Raw data representing the keys of the documents or the documents themselves

Returns:

information about the documents

See Also:

• API Documentation

deleteDocuments

public MultiDocumentEntity<DocumentDeleteEntity<RawData>> deleteDocuments(RawData values,
 DocumentDeleteOptions options)

Description copied from interface: ArangoCollection

Deletes multiple documents from the collection.

Specified by:

deleteDocuments in interface ArangoCollection

Parameters:

values - Raw data representing the keys of the documents or the documents themselves

options - Additional options

Returns:

information about the documents

See Also:

• API Documentation

deleteDocuments

public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(Iterable<?> values)

Description copied from interface: ArangoCollection

Deletes multiple documents from the collection.

Specified by:

deleteDocuments in interface ArangoCollection

Parameters:

values - The keys of the documents or the documents themselves

Returns:

information about the documents

See Also:

• API Documentation

deleteDocuments

public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(Iterable<?> values,
 DocumentDeleteOptions options)

Description copied from interface: ArangoCollection

Deletes multiple documents from the collection.

Specified by:

deleteDocuments in interface ArangoCollection

Parameters:

values - The keys of the documents or the documents themselves

options - Additional options

Returns:

information about the documents

See Also:

• API Documentation

deleteDocuments

public <T>
MultiDocumentEntity<DocumentDeleteEntity<T>> deleteDocuments(Iterable<?> values,
 DocumentDeleteOptions options,
 Class<T> type)

Description copied from interface: ArangoCollection

Deletes multiple documents from the collection.

Specified by:

deleteDocuments in interface ArangoCollection

Parameters:

values - The keys of the documents or the documents themselves

options - Additional options

type - Deserialization target type for the returned documents.

Returns:

information about the documents

See Also:

• API Documentation

documentExists

public Boolean documentExists(String key)

Description copied from interface: ArangoCollection

Checks if the document exists by reading a single document head

Specified by:

documentExists in interface ArangoCollection

Parameters:

key - The key of the document

Returns:

true if the document was found, otherwise false

See Also:

• API Documentation

documentExists

public Boolean documentExists(String key,
 DocumentExistsOptions options)

Description copied from interface: ArangoCollection

Checks if the document exists by reading a single document head

Specified by:

documentExists in interface ArangoCollection

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

public IndexEntity getIndex(String id)

Description copied from interface: ArangoCollection

Fetches information about the index with the given id and returns it.
Note: inverted indexes are not returned by this method. Use ArangoCollection.getInvertedIndex(String) instead.

Specified by:

getIndex in interface ArangoCollection

Parameters:

id - The index-handle

Returns:

information about the index

See Also:

• API Documentation

getInvertedIndex

public InvertedIndexEntity getInvertedIndex(String id)

Description copied from interface: ArangoCollection

Fetches information about the inverted index with the given id and returns it.

Specified by:

getInvertedIndex in interface ArangoCollection

Parameters:

id - The index-handle

Returns:

information about the index

See Also:

• API Documentation

deleteIndex

public String deleteIndex(String id)

Description copied from interface: ArangoCollection

Deletes the index with the given id from the collection.

Specified by:

deleteIndex in interface ArangoCollection

Parameters:

id - The index-handle

Returns:

the id of the index

See Also:

• API Documentation

ensurePersistentIndex

public IndexEntity ensurePersistentIndex(Iterable<String> fields,
 PersistentIndexOptions options)

Description copied from interface: ArangoCollection

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

Specified by:

ensurePersistentIndex in interface ArangoCollection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

• API Documentation

ensureInvertedIndex

public InvertedIndexEntity ensureInvertedIndex(InvertedIndexOptions options)

Description copied from interface: ArangoCollection

Creates an inverted index for the collection, if it does not already exist.

Specified by:

ensureInvertedIndex in interface ArangoCollection

Parameters:

options - index creation options

Returns:

information about the index

See Also:

• API Documentation

ensureGeoIndex

public IndexEntity ensureGeoIndex(Iterable<String> fields,
 GeoIndexOptions options)

Description copied from interface: ArangoCollection

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

Specified by:

ensureGeoIndex in interface ArangoCollection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

• API Documentation

ensureFulltextIndex

@Deprecated
public IndexEntity ensureFulltextIndex(Iterable<String> fields,
 FulltextIndexOptions options)

Deprecated.

Description copied from interface: ArangoCollection

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

Specified by:

ensureFulltextIndex in interface ArangoCollection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

• API Documentation

ensureTtlIndex

public IndexEntity ensureTtlIndex(Iterable<String> fields,
 TtlIndexOptions options)

Description copied from interface: ArangoCollection

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

Specified by:

ensureTtlIndex in interface ArangoCollection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

• API Documentation

ensureZKDIndex

public IndexEntity ensureZKDIndex(Iterable<String> fields,
 ZKDIndexOptions options)

Description copied from interface: ArangoCollection

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.

Specified by:

ensureZKDIndex in interface ArangoCollection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

See Also:

• API Documentation

ensureMDIndex

public IndexEntity ensureMDIndex(Iterable<String> fields,
 MDIndexOptions options)

Description copied from interface: ArangoCollection

Creates a multi-dimensional index for the collection, if it does not already exist.

Specified by:

ensureMDIndex in interface ArangoCollection

Parameters:

fields - A list of attribute names used for each dimension

options - Additional options, can be null.

Returns:

information about the index

See Also:

• API Documentation

ensureMDPrefixedIndex

public IndexEntity ensureMDPrefixedIndex(Iterable<String> fields,
 MDPrefixedIndexOptions options)

Description copied from interface: ArangoCollection

Creates a multi-dimensional prefixed index for the collection, if it does not already exist.

Specified by:

ensureMDPrefixedIndex in interface ArangoCollection

Parameters:

fields - A list of attribute names used for each dimension

options - Additional options, cannot be null.

Returns:

information about the index

See Also:

• API Documentation

getIndexes

public Collection<IndexEntity> getIndexes()

Description copied from interface: ArangoCollection

Fetches a list of all indexes on this collection.
Note: inverted indexes are not returned by this method. Use ArangoCollection.getInvertedIndexes() instead.

Specified by:

getIndexes in interface ArangoCollection

Returns:

information about the indexes

See Also:

• API Documentation

getInvertedIndexes

public Collection<InvertedIndexEntity> getInvertedIndexes()

Description copied from interface: ArangoCollection

Fetches a list of all inverted indexes on this collection.

Specified by:

getInvertedIndexes in interface ArangoCollection

Returns:

information about the indexes

See Also:

• API Documentation

exists

public boolean exists()

Description copied from interface: ArangoCollection

Checks whether the collection exists

Specified by:

exists in interface ArangoCollection

Returns:

true if the collection exists, otherwise false

See Also:

• API Documentation

truncate

public CollectionEntity truncate()

Description copied from interface: ArangoCollection

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

Specified by:

truncate in interface ArangoCollection

Returns:

information about the collection

See Also:

• API Documentation

truncate

public CollectionEntity truncate(CollectionTruncateOptions options)

Description copied from interface: ArangoCollection

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

Specified by:

truncate in interface ArangoCollection

Returns:

information about the collection

See Also:

• API Documentation

count

public CollectionPropertiesEntity count()

Description copied from interface: ArangoCollection

Counts the documents in a collection

Specified by:

count in interface ArangoCollection

Returns:

information about the collection, including the number of documents

See Also:

• API Documentation

count

public CollectionPropertiesEntity count(CollectionCountOptions options)

Description copied from interface: ArangoCollection

Counts the documents in a collection

Specified by:

count in interface ArangoCollection

Returns:

information about the collection, including the number of documents

See Also:

• API Documentation

create

public CollectionEntity create()

Description copied from interface: ArangoCollection

Creates a collection for this collection's name, then returns collection information from the server.

Specified by:

create in interface ArangoCollection

Returns:

information about the collection

See Also:

• API Documentation

create

public CollectionEntity create(CollectionCreateOptions options)

Description copied from interface: ArangoCollection

Creates a collection with the given options for this collection's name, then returns collection information from the server.

Specified by:

create in interface ArangoCollection

Parameters:

options - Additional options, can be null

Returns:

information about the collection

See Also:

• API Documentation

drop

public void drop()

Description copied from interface: ArangoCollection

Deletes the collection from the database.

Specified by:

drop in interface ArangoCollection

See Also:

• API Documentation

drop

public void drop(boolean isSystem)

Description copied from interface: ArangoCollection

Deletes the collection from the database.

Specified by:

drop in interface ArangoCollection

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.

See Also:

• API Documentation

getInfo

public CollectionEntity getInfo()

Description copied from interface: ArangoCollection

Returns information about the collection

Specified by:

getInfo in interface ArangoCollection

Returns:

information about the collection

See Also:

• API Documentation

getProperties

public CollectionPropertiesEntity getProperties()

Description copied from interface: ArangoCollection

Reads the properties of the specified collection

Specified by:

getProperties in interface ArangoCollection

Returns:

properties of the collection

See Also:

• API Documentation

changeProperties

public CollectionPropertiesEntity changeProperties(CollectionPropertiesOptions options)

Description copied from interface: ArangoCollection

Changes the properties of the collection

Specified by:

changeProperties in interface ArangoCollection

Parameters:

options - Additional options, can be null

Returns:

properties of the collection

See Also:

• API Documentation

rename

public CollectionEntity rename(String newName)

Description copied from interface: ArangoCollection

Renames the collection

Specified by:

rename in interface ArangoCollection

Parameters:

newName - The new name

Returns:

information about the collection

See Also:

• API Documentation

getResponsibleShard

public ShardEntity getResponsibleShard(Object value)

Description copied from interface: ArangoCollection

Returns the responsible shard for the document. Please note that this API is only meaningful and available on a cluster coordinator.

Specified by:

getResponsibleShard in interface ArangoCollection

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

See Also:

• API Documentation

getRevision

public CollectionRevisionEntity getRevision()

Description copied from interface: ArangoCollection

Retrieve the collections revision

Specified by:

getRevision in interface ArangoCollection

Returns:

information about the collection, including the collections revision

See Also:

• API Documentation

grantAccess

public void grantAccess(String user,
 Permissions permissions)

Description copied from interface: ArangoCollection

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

Specified by:

grantAccess in interface ArangoCollection

Parameters:

user - The name of the user

permissions - The permissions the user grant

See Also:

• API Documentation

revokeAccess

public void revokeAccess(String user)

Description copied from interface: ArangoCollection

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

Specified by:

revokeAccess in interface ArangoCollection

Parameters:

user - The name of the user

See Also:

• API Documentation

resetAccess

public void resetAccess(String user)

Description copied from interface: ArangoCollection

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

Specified by:

resetAccess in interface ArangoCollection

Parameters:

user - The name of the user

See Also:

• API Documentation

getPermissions

public Permissions getPermissions(String user)

Description copied from interface: ArangoCollection

Get the collection access level

Specified by:

getPermissions in interface ArangoCollection

Parameters:

user - The name of the user

Returns:

permissions of the user

See Also:

• API Documentation