public class ArangoCollectionImpl extends InternalArangoCollection<ArangoDBImpl,ArangoDatabaseImpl,ArangoExecutorSync> implements ArangoCollection
name, PATH_API_COLLECTION
executor, serde
Modifier | Constructor and Description |
---|---|
protected |
ArangoCollectionImpl(ArangoDatabaseImpl db,
String name) |
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. |
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(Collection<?> values)
Deletes multiple documents from the collection.
|
<T> MultiDocumentEntity<DocumentDeleteEntity<T>> |
deleteDocuments(Collection<?> values,
DocumentDeleteOptions options)
Deletes multiple documents from the collection.
|
<T> MultiDocumentEntity<DocumentDeleteEntity<T>> |
deleteDocuments(Collection<?> values,
DocumentDeleteOptions options,
Class<T> type)
Deletes multiple documents 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.
|
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.
|
IndexEntity |
ensureHashIndex(Iterable<String> fields,
HashIndexOptions options)
Deprecated.
|
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.
|
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(RawData values)
Bulk imports the given values into the collection.
|
DocumentImportEntity |
importDocuments(RawData 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(Collection<?> 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.
|
<T> MultiDocumentEntity<DocumentCreateEntity<T>> |
insertDocuments(Collection<T> values,
DocumentCreateOptions options,
Class<T> type)
Creates new documents from the given documents, 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.
|
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(Collection<?> 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.
|
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> |
replaceDocuments(Collection<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.
|
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.
|
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(Collection<?> 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<?> values,
DocumentUpdateOptions options,
Class<T> returnType)
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.
|
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.
|
changePropertiesRequest, countRequest, createFulltextIndexRequest, createGeoIndexRequest, createHashIndexRequest, createInvertedIndexRequest, createPersistentIndexRequest, createSkiplistIndexRequest, createTtlIndexRequest, createZKDIndexRequest, db, deleteDocumentRequest, deleteDocumentsRequest, deleteDocumentsRequest, deleteDocumentsResponseDeserializer, deleteIndexRequest, deleteIndexResponseDeserializer, documentExistsRequest, dropRequest, getCollectionContentClass, 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
createPath, executor, getSerde, request
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
db, name
getSerde
protected ArangoCollectionImpl(ArangoDatabaseImpl db, String name)
public DocumentCreateEntity<Void> insertDocument(Object value)
ArangoCollection
insertDocument
in interface ArangoCollection
value
- A representation of a single document (POJO or RawData
public <T> DocumentCreateEntity<T> insertDocument(T value, DocumentCreateOptions options)
ArangoCollection
insertDocument
in interface ArangoCollection
value
- A representation of a single document (POJO or RawData
)options
- Additional optionspublic <T> DocumentCreateEntity<T> insertDocument(T value, DocumentCreateOptions options, Class<T> type)
ArangoCollection
insertDocument
in interface ArangoCollection
value
- A representation of a single document (POJO or RawData
)options
- Additional optionstype
- Deserialization target type for the returned documents.public MultiDocumentEntity<DocumentCreateEntity<Void>> insertDocuments(RawData values)
ArangoCollection
insertDocuments
in interface ArangoCollection
values
- Raw data representing a collection of documentspublic MultiDocumentEntity<DocumentCreateEntity<RawData>> insertDocuments(RawData values, DocumentCreateOptions options)
ArangoCollection
insertDocuments
in interface ArangoCollection
values
- Raw data representing a collection of documentsoptions
- Additional optionspublic MultiDocumentEntity<DocumentCreateEntity<Void>> insertDocuments(Collection<?> values)
ArangoCollection
insertDocuments
in interface ArangoCollection
values
- A List of documentspublic <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Collection<T> values, DocumentCreateOptions options)
ArangoCollection
insertDocuments
in interface ArangoCollection
values
- A List of documents (POJO or RawData
)options
- Additional optionspublic <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Collection<T> values, DocumentCreateOptions options, Class<T> type)
ArangoCollection
insertDocuments
in interface ArangoCollection
values
- A List of documents (POJO or RawData
)options
- Additional optionstype
- Deserialization target type for the returned documents.public DocumentImportEntity importDocuments(Collection<?> values)
ArangoCollection
importDocuments
in interface ArangoCollection
values
- A List of documents (POJO or RawData
)public DocumentImportEntity importDocuments(Collection<?> values, DocumentImportOptions options)
ArangoCollection
importDocuments
in interface ArangoCollection
values
- A List of documents (POJO or RawData
)options
- Additional options, can be nullpublic DocumentImportEntity importDocuments(RawData values)
ArangoCollection
importDocuments
in interface ArangoCollection
values
- Raw data representing a collection of documentspublic DocumentImportEntity importDocuments(RawData values, DocumentImportOptions options)
ArangoCollection
importDocuments
in interface ArangoCollection
values
- Raw data representing a collection of documentsoptions
- Additional options, can be nullpublic <T> T getDocument(String key, Class<T> type)
ArangoCollection
key
from the collection.getDocument
in interface ArangoCollection
key
- The key of the documenttype
- The type of the document (POJO or RawData
)public <T> T getDocument(String key, Class<T> type, DocumentReadOptions options)
ArangoCollection
key
from the collection.getDocument
in interface ArangoCollection
key
- The key of the documenttype
- The type of the document (POJO or RawData
)options
- Additional options, can be nullpublic <T> MultiDocumentEntity<T> getDocuments(Collection<String> keys, Class<T> type)
ArangoCollection
_key
from the collection.getDocuments
in interface ArangoCollection
keys
- The keys of the documentstype
- The type of the documents (POJO or RawData
)public <T> MultiDocumentEntity<T> getDocuments(Collection<String> keys, Class<T> type, DocumentReadOptions options)
ArangoCollection
_key
from the collection.getDocuments
in interface ArangoCollection
keys
- The keys of the documentstype
- The type of the documents (POJO or RawData
)options
- Additional options, can be nullpublic DocumentUpdateEntity<Void> replaceDocument(String key, Object value)
ArangoCollection
key
with the one in the body, provided there is such a document and no
precondition is violatedreplaceDocument
in interface ArangoCollection
key
- The key of the documentvalue
- A representation of a single document (POJO or RawData
)public <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplaceOptions options)
ArangoCollection
key
with the one in the body, provided there is such a document and no
precondition is violatedreplaceDocument
in interface ArangoCollection
key
- The key of the documentvalue
- A representation of a single document (POJO or RawData
)options
- Additional optionspublic <T> DocumentUpdateEntity<T> replaceDocument(String key, T value, DocumentReplaceOptions options, Class<T> type)
ArangoCollection
key
with the one in the body, provided there is such a document and no
precondition is violatedreplaceDocument
in interface ArangoCollection
key
- The key of the documentvalue
- A representation of a single document (POJO or RawData
)options
- Additional optionstype
- Deserialization target type for the returned documents.public MultiDocumentEntity<DocumentUpdateEntity<Void>> replaceDocuments(RawData values)
ArangoCollection
replaceDocuments
in interface ArangoCollection
values
- Raw data representing a collection of documentspublic MultiDocumentEntity<DocumentUpdateEntity<RawData>> replaceDocuments(RawData values, DocumentReplaceOptions options)
ArangoCollection
replaceDocuments
in interface ArangoCollection
values
- Raw data representing a collection of documentsoptions
- Additional optionspublic MultiDocumentEntity<DocumentUpdateEntity<Void>> replaceDocuments(Collection<?> values)
ArangoCollection
replaceDocuments
in interface ArangoCollection
values
- A List of documents (POJO or RawData
)public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values, DocumentReplaceOptions options)
ArangoCollection
replaceDocuments
in interface ArangoCollection
values
- A List of documents (POJO or RawData
)options
- Additional optionspublic <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values, DocumentReplaceOptions options, Class<T> type)
ArangoCollection
replaceDocuments
in interface ArangoCollection
values
- A List of documents (POJO or RawData
)options
- Additional optionstype
- Deserialization target type for the returned documents.public DocumentUpdateEntity<Void> updateDocument(String key, Object value)
ArangoCollection
updateDocument
in interface ArangoCollection
key
- The key of the documentvalue
- A representation of a single document (POJO or RawData
)public <T> DocumentUpdateEntity<T> updateDocument(String key, T value, DocumentUpdateOptions options)
ArangoCollection
updateDocument
in interface ArangoCollection
key
- The key of the documentvalue
- A representation of a single document (POJO or RawData
)options
- Additional optionspublic <T> DocumentUpdateEntity<T> updateDocument(String key, Object value, DocumentUpdateOptions options, Class<T> returnType)
ArangoCollection
updateDocument
in interface ArangoCollection
key
- The key of the documentvalue
- A representation of a single document (POJO or RawData
)options
- Additional optionsreturnType
- Type of the returned newDocument and/or oldDocumentpublic MultiDocumentEntity<DocumentUpdateEntity<Void>> updateDocuments(RawData values)
ArangoCollection
updateDocuments
in interface ArangoCollection
values
- Raw data representing a collection of documentspublic MultiDocumentEntity<DocumentUpdateEntity<RawData>> updateDocuments(RawData values, DocumentUpdateOptions options)
ArangoCollection
updateDocuments
in interface ArangoCollection
values
- Raw data representing a collection of documentsoptions
- Additional optionspublic MultiDocumentEntity<DocumentUpdateEntity<Void>> updateDocuments(Collection<?> values)
ArangoCollection
updateDocuments
in interface ArangoCollection
values
- A list of documents (POJO or RawData
)public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(Collection<T> values, DocumentUpdateOptions options)
ArangoCollection
updateDocuments
in interface ArangoCollection
values
- A list of documents (POJO or RawData
)options
- Additional optionspublic <T> MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(Collection<?> values, DocumentUpdateOptions options, Class<T> returnType)
ArangoCollection
updateDocuments
in interface ArangoCollection
values
- A list of documents (POJO or RawData
)options
- Additional optionsreturnType
- Type of the returned newDocument and/or oldDocumentpublic DocumentDeleteEntity<Void> deleteDocument(String key)
ArangoCollection
key
from the collection.deleteDocument
in interface ArangoCollection
key
- The key of the documentpublic DocumentDeleteEntity<Void> deleteDocument(String key, DocumentDeleteOptions options)
ArangoCollection
key
from the collection.deleteDocument
in interface ArangoCollection
key
- The key of the documentoptions
- Additional optionspublic <T> DocumentDeleteEntity<T> deleteDocument(String key, DocumentDeleteOptions options, Class<T> type)
ArangoCollection
key
from the collection.deleteDocument
in interface ArangoCollection
key
- The key of the documentoptions
- Additional optionstype
- Deserialization target type for the returned documents.public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(RawData values)
ArangoCollection
deleteDocuments
in interface ArangoCollection
values
- Raw data representing the keys of the documents or the documents themselvespublic MultiDocumentEntity<DocumentDeleteEntity<RawData>> deleteDocuments(RawData values, DocumentDeleteOptions options)
ArangoCollection
deleteDocuments
in interface ArangoCollection
values
- Raw data representing the keys of the documents or the documents themselvesoptions
- Additional optionspublic MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(Collection<?> values)
ArangoCollection
deleteDocuments
in interface ArangoCollection
values
- The keys of the documents or the documents themselvespublic <T> MultiDocumentEntity<DocumentDeleteEntity<T>> deleteDocuments(Collection<?> values, DocumentDeleteOptions options)
ArangoCollection
deleteDocuments
in interface ArangoCollection
values
- The keys of the documents or the documents themselvesoptions
- Additional optionspublic <T> MultiDocumentEntity<DocumentDeleteEntity<T>> deleteDocuments(Collection<?> values, DocumentDeleteOptions options, Class<T> type)
ArangoCollection
deleteDocuments
in interface ArangoCollection
values
- The keys of the documents or the documents themselvesoptions
- Additional optionstype
- Deserialization target type for the returned documents.public Boolean documentExists(String key)
ArangoCollection
documentExists
in interface ArangoCollection
key
- The key of the documentpublic Boolean documentExists(String key, DocumentExistsOptions options)
ArangoCollection
documentExists
in interface ArangoCollection
key
- The key of the documentoptions
- Additional options, can be nullpublic IndexEntity getIndex(String id)
ArangoCollection
id
and returns it.
ArangoCollection.getInvertedIndex(String)
instead.getIndex
in interface ArangoCollection
id
- The index-handlepublic InvertedIndexEntity getInvertedIndex(String id)
ArangoCollection
id
and returns it.getInvertedIndex
in interface ArangoCollection
id
- The index-handlepublic String deleteIndex(String id)
ArangoCollection
id
from the collection.deleteIndex
in interface ArangoCollection
id
- The index-handle@Deprecated public IndexEntity ensureHashIndex(Iterable<String> fields, HashIndexOptions options)
ArangoCollection
ensureHashIndex
in interface ArangoCollection
fields
- A list of attribute pathsoptions
- Additional options, can be null@Deprecated public IndexEntity ensureSkiplistIndex(Iterable<String> fields, SkiplistIndexOptions options)
ArangoCollection
ensureSkiplistIndex
in interface ArangoCollection
fields
- A list of attribute pathsoptions
- Additional options, can be nullpublic IndexEntity ensurePersistentIndex(Iterable<String> fields, PersistentIndexOptions options)
ArangoCollection
ensurePersistentIndex
in interface ArangoCollection
fields
- A list of attribute pathsoptions
- Additional options, can be nullpublic InvertedIndexEntity ensureInvertedIndex(InvertedIndexOptions options)
ArangoCollection
ensureInvertedIndex
in interface ArangoCollection
options
- index creation optionspublic IndexEntity ensureGeoIndex(Iterable<String> fields, GeoIndexOptions options)
ArangoCollection
ensureGeoIndex
in interface ArangoCollection
fields
- A list of attribute pathsoptions
- Additional options, can be null@Deprecated public IndexEntity ensureFulltextIndex(Iterable<String> fields, FulltextIndexOptions options)
ArangoCollection
ensureFulltextIndex
in interface ArangoCollection
fields
- A list of attribute pathsoptions
- Additional options, can be nullpublic IndexEntity ensureTtlIndex(Iterable<String> fields, TtlIndexOptions options)
ArangoCollection
ensureTtlIndex
in interface ArangoCollection
fields
- A list of attribute pathsoptions
- Additional options, can be nullpublic IndexEntity ensureZKDIndex(Iterable<String> fields, ZKDIndexOptions options)
ArangoCollection
ensureZKDIndex
in interface ArangoCollection
fields
- A list of attribute pathsoptions
- Additional options, can be nullpublic Collection<IndexEntity> getIndexes()
ArangoCollection
ArangoCollection.getInvertedIndexes()
instead.getIndexes
in interface ArangoCollection
public Collection<InvertedIndexEntity> getInvertedIndexes()
ArangoCollection
getInvertedIndexes
in interface ArangoCollection
public boolean exists()
ArangoCollection
exists
in interface ArangoCollection
public CollectionEntity truncate()
ArangoCollection
truncate
in interface ArangoCollection
public CollectionEntity truncate(CollectionTruncateOptions options)
ArangoCollection
truncate
in interface ArangoCollection
public CollectionPropertiesEntity count()
ArangoCollection
count
in interface ArangoCollection
public CollectionPropertiesEntity count(CollectionCountOptions options)
ArangoCollection
count
in interface ArangoCollection
public CollectionEntity create()
ArangoCollection
create
in interface ArangoCollection
public CollectionEntity create(CollectionCreateOptions options)
ArangoCollection
options
for this collection's name, then returns collection
information from the server.create
in interface ArangoCollection
options
- Additional options, can be nullpublic void drop()
ArangoCollection
drop
in interface ArangoCollection
public void drop(boolean isSystem)
ArangoCollection
drop
in interface ArangoCollection
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.public CollectionEntity getInfo()
ArangoCollection
getInfo
in interface ArangoCollection
public CollectionPropertiesEntity getProperties()
ArangoCollection
getProperties
in interface ArangoCollection
public CollectionPropertiesEntity changeProperties(CollectionPropertiesOptions options)
ArangoCollection
changeProperties
in interface ArangoCollection
options
- Additional options, can be nullpublic CollectionEntity rename(String newName)
ArangoCollection
rename
in interface ArangoCollection
newName
- The new namepublic ShardEntity getResponsibleShard(Object value)
ArangoCollection
getResponsibleShard
in interface ArangoCollection
value
- A projection of the document containing at least the shard key (_key or a custom attribute) for
which the responsible shard should be determinedpublic CollectionRevisionEntity getRevision()
ArangoCollection
getRevision
in interface ArangoCollection
public void grantAccess(String user, Permissions permissions)
ArangoCollection
grantAccess
in interface ArangoCollection
user
- The name of the userpermissions
- The permissions the user grantpublic void revokeAccess(String user)
ArangoCollection
revokeAccess
in interface ArangoCollection
user
- The name of the userpublic void resetAccess(String user)
ArangoCollection
resetAccess
in interface ArangoCollection
user
- The name of the userpublic Permissions getPermissions(String user)
ArangoCollection
getPermissions
in interface ArangoCollection
user
- The name of the userCopyright © 2016–2023 ArangoDB GmbH. All rights reserved.