Class CollectionQueryIndexManager
- java.lang.Object
-
- com.couchbase.client.java.manager.query.CollectionQueryIndexManager
-
-
Constructor Summary
Constructors Constructor Description CollectionQueryIndexManager(AsyncCollectionQueryIndexManager async)Creates a newCollectionQueryIndexManager.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbuildDeferredIndexes()Builds all currently deferred indexes on this collection.voidbuildDeferredIndexes(BuildQueryIndexOptions options)Builds all currently deferred indexes on this collection, with custom options.voidcreateIndex(String indexName, Collection<String> fields)Creates a named query index on this collection.voidcreateIndex(String indexName, Collection<String> fields, CreateQueryIndexOptions options)Creates a named query index with custom options, on this collection.voidcreatePrimaryIndex()Creates a primary query index on this collection.voidcreatePrimaryIndex(CreatePrimaryQueryIndexOptions options)Creates a primary query index with custom options, on this collection.voiddropIndex(String indexName)Drops a query index from this collection.voiddropIndex(String indexName, DropQueryIndexOptions options)Drops a query index from this collection with custom options.voiddropPrimaryIndex()Drops the primary index from this collection.voiddropPrimaryIndex(DropPrimaryQueryIndexOptions options)Drops the primary index from this collection with custom options.List<QueryIndex>getAllIndexes()Fetches all indexes on this collection.List<QueryIndex>getAllIndexes(GetAllQueryIndexesOptions options)Fetches all indexes from this collection with custom options.voidwatchIndexes(Collection<String> indexNames, Duration timeout)Watches/Polls indexes on this collection until they are online.voidwatchIndexes(Collection<String> indexNames, Duration timeout, WatchQueryIndexesOptions options)Watches/Polls indexes on this collection until they are online with custom options.
-
-
-
Constructor Detail
-
CollectionQueryIndexManager
@Internal public CollectionQueryIndexManager(AsyncCollectionQueryIndexManager async)
Creates a newCollectionQueryIndexManager.This API is not intended to be called by the user directly, use
Collection.queryIndexes()instead.
-
-
Method Detail
-
createPrimaryIndex
public void createPrimaryIndex()
Creates a primary query index on this collection.- Throws:
IndexFailureException- if creating the index failed (see reason for details).IndexExistsException- if an index already exists with the given name on this collection.CouchbaseException- if any other generic unhandled/unexpected errors.
-
createPrimaryIndex
public void createPrimaryIndex(CreatePrimaryQueryIndexOptions options)
Creates a primary query index with custom options, on this collection.- Parameters:
options- the custom options to apply.- Throws:
IndexFailureException- if creating the index failed (see reason for details).IndexExistsException- if an index already exists with the given name on this collection.CouchbaseException- if any other generic unhandled/unexpected errors.
-
createIndex
public void createIndex(String indexName, Collection<String> fields)
Creates a named query index on this collection.- Parameters:
indexName- the name of the query index.fields- the collection of fields that are part of the index.- Throws:
IndexFailureException- if creating the index failed (see reason for details).IndexExistsException- if an index already exists with the given name on this collection.CouchbaseException- if any other generic unhandled/unexpected errors.
-
createIndex
public void createIndex(String indexName, Collection<String> fields, CreateQueryIndexOptions options)
Creates a named query index with custom options, on this collection.- Parameters:
indexName- the name of the query index.fields- the collection of fields that are part of the index.options- the custom options to apply.- Throws:
IndexFailureException- if creating the index failed (see reason for details).IndexExistsException- if an index already exists with the given name on this collection.CouchbaseException- if any other generic unhandled/unexpected errors.
-
getAllIndexes
public List<QueryIndex> getAllIndexes()
Fetches all indexes on this collection.- Returns:
- a list of (potentially empty) indexes or failed with an error.
- Throws:
CouchbaseException- if any other generic unhandled/unexpected errors.
-
getAllIndexes
public List<QueryIndex> getAllIndexes(GetAllQueryIndexesOptions options)
Fetches all indexes from this collection with custom options.- Parameters:
options- the custom options to apply.- Returns:
- a list of (potentially empty) indexes or failed with an error.
- Throws:
CouchbaseException- if any other generic unhandled/unexpected errors.
-
dropPrimaryIndex
public void dropPrimaryIndex()
Drops the primary index from this collection.- Throws:
IndexNotFoundException- if the index does not exist.IndexFailureException- if dropping the index failed (see reason for details).CouchbaseException- if any other generic unhandled/unexpected errors.
-
dropPrimaryIndex
public void dropPrimaryIndex(DropPrimaryQueryIndexOptions options)
Drops the primary index from this collection with custom options.- Parameters:
options- the custom options to apply.- Throws:
IndexNotFoundException- if the index does not exist.IndexFailureException- if dropping the index failed (see reason for details).CouchbaseException- if any other generic unhandled/unexpected errors.
-
dropIndex
public void dropIndex(String indexName)
Drops a query index from this collection.- Parameters:
indexName- the name of the index to drop.- Throws:
IndexNotFoundException- if the index does not exist.IndexFailureException- if dropping the index failed (see reason for details).CouchbaseException- if any other generic unhandled/unexpected errors.
-
dropIndex
public void dropIndex(String indexName, DropQueryIndexOptions options)
Drops a query index from this collection with custom options.- Parameters:
indexName- the name of the index to drop.options- the custom options to apply.- Throws:
IndexNotFoundException- if the index does not exist.IndexFailureException- if dropping the index failed (see reason for details).CouchbaseException- if any other generic unhandled/unexpected errors.
-
buildDeferredIndexes
public void buildDeferredIndexes()
Builds all currently deferred indexes on this collection.- Throws:
CouchbaseException- if any other generic unhandled/unexpected errors.
-
buildDeferredIndexes
public void buildDeferredIndexes(BuildQueryIndexOptions options)
Builds all currently deferred indexes on this collection, with custom options.- Parameters:
options- the custom options to apply.- Throws:
CouchbaseException- if any other generic unhandled/unexpected errors.
-
watchIndexes
public void watchIndexes(Collection<String> indexNames, Duration timeout)
Watches/Polls indexes on this collection until they are online.- Parameters:
indexNames- the names of the indexes to watch.timeout- the maximum amount of time the indexes should be watched.- Throws:
CouchbaseException- if any other generic unhandled/unexpected errors.
-
watchIndexes
public void watchIndexes(Collection<String> indexNames, Duration timeout, WatchQueryIndexesOptions options)
Watches/Polls indexes on this collection until they are online with custom options.- Parameters:
indexNames- the names of the indexes to watch.timeout- the maximum amount of time the indexes should be watched.options- the custom options to apply.- Throws:
CouchbaseException- if any other generic unhandled/unexpected errors.
-
-