Package com.c8db.internal

Class C8CollectionImpl

java.lang.Object

com.c8db.internal.C8Executeable<E>

com.c8db.internal.InternalC8Collection<C8DBImpl,C8DatabaseImpl,C8ExecutorSync>

com.c8db.internal.C8CollectionImpl

All Implemented Interfaces:

C8Collection, C8SerializationAccessor

public class C8CollectionImpl
extends InternalC8Collection<C8DBImpl,C8DatabaseImpl,C8ExecutorSync>
implements C8Collection

Field Summary

Fields inherited from class com.c8db.internal.InternalC8Collection

name, PATH_API_COLLECTION, PATH_API_DOCUMENT, PATH_API_INDEX

Fields inherited from class com.c8db.internal.C8Executeable

context, executor, util

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	C8CollectionImpl(C8DatabaseImpl 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.
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)	Creates a fulltext index for the collection, if it does not already exist.
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)	Creates a hash 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)	Creates a skip-list 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.
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
Permissions	getPermissions(String user)	Get the collection access level
CollectionPropertiesEntity	getProperties()	Reads the properties of the specified collection
void	grantAccess(String user, Permissions permissions)	Grants or revoke access to the collection for user user.
<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	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
<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> 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.

Methods inherited from class com.c8db.internal.InternalC8Collection

changePropertiesRequest, countRequest, createFulltextIndexRequest, createGeoIndexRequest, createHashIndexRequest, createPersistentIndexRequest, createSkiplistIndexRequest, createTTLIndexRequest, db, deleteDocumentRequest, deleteDocumentResponseDeserializer, deleteDocumentsRequest, deleteDocumentsResponseDeserializer, deleteIndexRequest, deleteIndexResponseDeserializer, documentExistsRequest, dropRequest, getDocumentRequest, getDocumentsRequest, getDocumentsResponseDeserializer, getIndexesRequest, getIndexesResponseDeserializer, getIndexRequest, getInfoRequest, getPermissionsRequest, getPermissionsResponseDeserialzer, getPropertiesRequest, getRevisionRequest, grantAccessRequest, insertDocumentRequest, insertDocumentResponseDeserializer, insertDocumentsRequest, insertDocumentsResponseDeserializer, name, renameRequest, replaceDocumentRequest, replaceDocumentResponseDeserializer, replaceDocumentsRequest, replaceDocumentsResponseDeserializer, resetAccessRequest, responsibleShardRequest, truncateRequest, updateDocumentRequest, updateDocumentResponseDeserializer, updateDocumentsRequest, updateDocumentsResponseDeserializer

Methods inherited from class com.c8db.internal.C8Executeable

createPath, executor, request, util, util

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.c8db.C8Collection

db, name

Methods inherited from interface com.c8db.C8SerializationAccessor

util, util

Constructor Detail

C8CollectionImpl

protected C8CollectionImpl(C8DatabaseImpl db,
                           String name)

Method Detail

exists

public boolean exists()
               throws C8DBException

Description copied from interface: C8Collection

Checks whether the collection exists

Specified by:

exists in interface C8Collection

Returns:

true if the collection exists, otherwise false

Throws:

C8DBException

truncate

public CollectionEntity truncate()
                          throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

truncate in interface C8Collection

Returns:

information about the collection

Throws:

C8DBException

See Also:

API Documentation

truncate

public CollectionEntity truncate(CollectionTruncateOptions options)
                          throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

truncate in interface C8Collection

Returns:

information about the collection

Throws:

C8DBException

See Also:

API Documentation

count

public CollectionPropertiesEntity count()
                                 throws C8DBException

Description copied from interface: C8Collection

Counts the documents in a collection

Specified by:

count in interface C8Collection

Returns:

information about the collection, including the number of documents

Throws:

C8DBException

See Also:

API Documentation

count

public CollectionPropertiesEntity count(CollectionCountOptions options)
                                 throws C8DBException

Description copied from interface: C8Collection

Counts the documents in a collection

Specified by:

count in interface C8Collection

Returns:

information about the collection, including the number of documents

Throws:

C8DBException

See Also:

API Documentation

create

public CollectionEntity create()
                        throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

create in interface C8Collection

Returns:

information about the collection

Throws:

C8DBException

See Also:

API Documentation

create

public CollectionEntity create(CollectionCreateOptions options)
                        throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

create in interface C8Collection

Parameters:

options - Additional options, can be null

Returns:

information about the collection

Throws:

C8DBException

See Also:

API Documentation

drop

public void drop()
          throws C8DBException

Description copied from interface: C8Collection

Deletes the collection from the database.

Specified by:

drop in interface C8Collection

Throws:

C8DBException

See Also:

API Documentation

drop

public void drop(boolean isSystem)
          throws C8DBException

Description copied from interface: C8Collection

Deletes the collection from the database.

Specified by:

drop in interface C8Collection

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:

C8DBException

See Also:

API Documentation

getInfo

public CollectionEntity getInfo()
                         throws C8DBException

Description copied from interface: C8Collection

Returns information about the collection

Specified by:

getInfo in interface C8Collection

Returns:

information about the collection

Throws:

C8DBException

See Also:

API Documentation

getProperties

public CollectionPropertiesEntity getProperties()
                                         throws C8DBException

Description copied from interface: C8Collection

Reads the properties of the specified collection

Specified by:

getProperties in interface C8Collection

Returns:

properties of the collection

Throws:

C8DBException

See Also:

API Documentation

changeProperties

public CollectionPropertiesEntity changeProperties(CollectionPropertiesOptions options)
                                            throws C8DBException

Description copied from interface: C8Collection

Changes the properties of the collection

Specified by:

changeProperties in interface C8Collection

Parameters:

options - Additional options, can be null

Returns:

properties of the collection

Throws:

C8DBException

See Also:

API Documentation

rename

public CollectionEntity rename(String newName)
                        throws C8DBException

Description copied from interface: C8Collection

Renames the collection

Specified by:

rename in interface C8Collection

Parameters:

newName - The new name

Returns:

information about the collection

Throws:

C8DBException

See Also:

API Documentation

grantAccess

public void grantAccess(String user,
                        Permissions permissions)
                 throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

user - The name of the user

permissions - The permissions the user grant

Throws:

C8DBException

See Also:

API Documentation

revokeAccess

public void revokeAccess(String user)
                  throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

user - The name of the user

Throws:

C8DBException

See Also:

API Documentation

resetAccess

public void resetAccess(String user)
                 throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

resetAccess in interface C8Collection

Parameters:

user - The name of the user

Throws:

C8DBException

See Also:

API Documentation

getPermissions

public Permissions getPermissions(String user)
                           throws C8DBException

Description copied from interface: C8Collection

Get the collection access level

Specified by:

getPermissions in interface C8Collection

Parameters:

user - The name of the user

Returns:

permissions of the user

Throws:

C8DBException

See Also:

API Documentation

insertDocument

public <T> DocumentCreateEntity<T> insertDocument(T value)
                                           throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

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

Returns:

information about the document

Throws:

C8DBException

See Also:

API Documentation

insertDocument

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

Description copied from interface: C8Collection

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 C8Collection

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:

C8DBException

See Also:

API Documentation

insertDocuments

public <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Collection<T> values)
                                                                 throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

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

Returns:

information about the documents

Throws:

C8DBException

See Also:

API Documentation

insertDocuments

public <T> MultiDocumentEntity<DocumentCreateEntity<T>> insertDocuments(Collection<T> values,
                                                                        DocumentCreateOptions options)
                                                                 throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

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

options - Additional options, can be null

Returns:

information about the documents

Throws:

C8DBException

See Also:

API Documentation

getDocument

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

Description copied from interface: C8Collection

Retrieves the document with the given key from the collection.

Specified by:

getDocument in interface C8Collection

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:

C8DBException

See Also:

API Documentation

getDocument

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

Description copied from interface: C8Collection

Retrieves the document with the given key from the collection.

Specified by:

getDocument in interface C8Collection

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:

C8DBException

See Also:

API Documentation

getDocuments

public <T> MultiDocumentEntity<T> getDocuments(Collection<String> keys,
                                               Class<T> type)
                                        throws C8DBException

Description copied from interface: C8Collection

Retrieves multiple documents with the given _key from the collection.

Specified by:

getDocuments in interface C8Collection

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:

C8DBException

getDocuments

public <T> MultiDocumentEntity<T> getDocuments(Collection<String> keys,
                                               Class<T> type,
                                               DocumentReadOptions options)
                                        throws C8DBException

Description copied from interface: C8Collection

Retrieves multiple documents with the given _key from the collection.

Specified by:

getDocuments in interface C8Collection

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:

C8DBException

replaceDocument

public <T> DocumentUpdateEntity<T> replaceDocument(String key,
                                                   T value)
                                            throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

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:

C8DBException

See Also:

API Documentation

replaceDocument

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

Description copied from interface: C8Collection

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 C8Collection

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:

C8DBException

See Also:

API Documentation

replaceDocuments

public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values)
                                                                  throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

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

Returns:

information about the documents

Throws:

C8DBException

See Also:

API Documentation

replaceDocuments

public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> replaceDocuments(Collection<T> values,
                                                                         DocumentReplaceOptions options)
                                                                  throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

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

options - Additional options, can be null

Returns:

information about the documents

Throws:

C8DBException

See Also:

API Documentation

updateDocument

public <T> DocumentUpdateEntity<T> updateDocument(String key,
                                                  T value)
                                           throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

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:

C8DBException

See Also:

API Documentation

updateDocument

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

Description copied from interface: C8Collection

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 C8Collection

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:

C8DBException

See Also:

API Documentation

updateDocuments

public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(Collection<T> values)
                                                                 throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

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

Returns:

information about the documents

Throws:

C8DBException

See Also:

API Documentation

updateDocuments

public <T> MultiDocumentEntity<DocumentUpdateEntity<T>> updateDocuments(Collection<T> values,
                                                                        DocumentUpdateOptions options)
                                                                 throws C8DBException

Description copied from interface: C8Collection

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 C8Collection

Parameters:

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

options - Additional options, can be null

Returns:

information about the documents

Throws:

C8DBException

See Also:

API Documentation

deleteDocument

public DocumentDeleteEntity<Void> deleteDocument(String key)
                                          throws C8DBException

Description copied from interface: C8Collection

Deletes the document with the given key from the collection.

Specified by:

deleteDocument in interface C8Collection

Parameters:

key - The key of the document

Returns:

information about the document

Throws:

C8DBException

See Also:

API Documentation

deleteDocument

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

Description copied from interface: C8Collection

Deletes the document with the given key from the collection.

Specified by:

deleteDocument in interface C8Collection

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:

C8DBException

See Also:

API Documentation

deleteDocuments

public MultiDocumentEntity<DocumentDeleteEntity<Void>> deleteDocuments(Collection<?> values)
                                                                throws C8DBException

Description copied from interface: C8Collection

Deletes multiple documents from the collection.

Specified by:

deleteDocuments in interface C8Collection

Parameters:

values - The keys of the documents or the documents themselves

Returns:

information about the documents

Throws:

C8DBException

See Also:

API Documentation

deleteDocuments

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

Description copied from interface: C8Collection

Deletes multiple documents from the collection.

Specified by:

deleteDocuments in interface C8Collection

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:

C8DBException

See Also:

API Documentation

documentExists

public Boolean documentExists(String key)

Description copied from interface: C8Collection

Checks if the document exists by reading a single document head

Specified by:

documentExists in interface C8Collection

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)
                       throws C8DBException

Description copied from interface: C8Collection

Checks if the document exists by reading a single document head

Specified by:

documentExists in interface C8Collection

Parameters:

key - The key of the document

options - Additional options, can be null

Returns:

true if the document was found, otherwise false

Throws:

C8DBException - only thrown when DocumentExistsOptions.isCatchException() == false

See Also:

API Documentation

getIndex

public IndexEntity getIndex(String id)
                     throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

getIndex in interface C8Collection

Parameters:

id - The index-handle

Returns:

information about the index

Throws:

C8DBException

See Also:

API Documentation

deleteIndex

public String deleteIndex(String id)
                   throws C8DBException

Description copied from interface: C8Collection

Deletes the index with the given id from the collection.

Specified by:

deleteIndex in interface C8Collection

Parameters:

id - The index-handle

Returns:

the id of the index

Throws:

C8DBException

See Also:

API Documentation

ensureHashIndex

public IndexEntity ensureHashIndex(Iterable<String> fields,
                                   HashIndexOptions options)
                            throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

ensureHashIndex in interface C8Collection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

C8DBException

See Also:

API Documentation

ensureSkiplistIndex

public IndexEntity ensureSkiplistIndex(Iterable<String> fields,
                                       SkiplistIndexOptions options)
                                throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

ensureSkiplistIndex in interface C8Collection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

C8DBException

See Also:

API Documentation

ensurePersistentIndex

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

Description copied from interface: C8Collection

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

Specified by:

ensurePersistentIndex in interface C8Collection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

C8DBException

See Also:

API Documentation

ensureGeoIndex

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

Description copied from interface: C8Collection

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

Specified by:

ensureGeoIndex in interface C8Collection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

C8DBException

See Also:

API Documentation

ensureFulltextIndex

public IndexEntity ensureFulltextIndex(Iterable<String> fields,
                                       FulltextIndexOptions options)
                                throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

ensureFulltextIndex in interface C8Collection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

C8DBException

See Also:

API Documentation

ensureTTLIndex

public IndexEntity ensureTTLIndex(Iterable<String> fields,
                                  TTLIndexOptions options)
                           throws C8DBException

Description copied from interface: C8Collection

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

Specified by:

ensureTTLIndex in interface C8Collection

Parameters:

fields - A list of attribute paths

options - Additional options, can be null

Returns:

information about the index

Throws:

C8DBException

getIndexes

public Collection<IndexEntity> getIndexes()
                                   throws C8DBException

Description copied from interface: C8Collection

Fetches a list of all indexes on this collection.

Specified by:

getIndexes in interface C8Collection

Returns:

information about the indexes

Throws:

C8DBException

See Also:

API Documentation