Class QueryIndexManager
-
Constructor Summary
ConstructorDescriptionQueryIndexManager
(ReactorOps reactor, AsyncQueryIndexManager async) Creates a newQueryIndexManager
. -
Method Summary
Modifier and TypeMethodDescriptionasync()
Provides access to theAsyncQueryIndexManager
.void
buildDeferredIndexes
(String bucketName) Builds all currently deferred indexes in the bucket's default collection.void
buildDeferredIndexes
(String bucketName, BuildQueryIndexOptions options) Builds all currently deferred indexes in a collection.void
createIndex
(String bucketName, String indexName, Collection<String> fields) Creates a named query index.void
createIndex
(String bucketName, String indexName, Collection<String> fields, CreateQueryIndexOptions options) Creates a named query index with custom options.void
createPrimaryIndex
(String bucketName) Creates a primary query index.void
createPrimaryIndex
(String bucketName, CreatePrimaryQueryIndexOptions options) Creates a primary query index with custom options.void
Drops a query index from a bucket.void
dropIndex
(String bucketName, String indexName, DropQueryIndexOptions options) Drops a query index from a bucket with custom options.void
dropPrimaryIndex
(String bucketName) Drops the primary index from a bucket.void
dropPrimaryIndex
(String bucketName, DropPrimaryQueryIndexOptions options) Drops the primary index from a bucket with custom options.getAllIndexes
(String bucketName) Fetches all indexes from the bucket.getAllIndexes
(String bucketName, GetAllQueryIndexesOptions options) Fetches all indexes from the bucket with custom options.reactive()
Provides access to theReactiveQueryIndexManager
.void
watchIndexes
(String bucketName, Collection<String> indexNames, Duration timeout) Watches/Polls indexes until they are online.void
watchIndexes
(String bucketName, Collection<String> indexNames, Duration timeout, WatchQueryIndexesOptions options) Watches/Polls indexes until they are online with custom options.
-
Constructor Details
-
QueryIndexManager
Creates a newQueryIndexManager
.This API is not intended to be called by the user directly, use
Cluster.queryIndexes()
instead.- Parameters:
async
- the async index manager.
-
-
Method Details
-
async
Provides access to theAsyncQueryIndexManager
. -
reactive
Provides access to theReactiveQueryIndexManager
. -
createPrimaryIndex
Creates a primary query index.By default, this method will create an index on the bucket. If an index needs to be created on a collection, both
CreatePrimaryQueryIndexOptions.scopeName(String)
andCreatePrimaryQueryIndexOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket to create the index on.- Throws:
IndexFailureException
- if creating the index failed (see reason for details).IndexExistsException
- if an index already exists with the given name on the keyspace.CouchbaseException
- if any other generic unhandled/unexpected errors.
-
createPrimaryIndex
Creates a primary query index with custom options.By default, this method will create an index on the bucket. If an index needs to be created on a collection, both
CreatePrimaryQueryIndexOptions.scopeName(String)
andCreatePrimaryQueryIndexOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket to create the index on.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 the keyspace.CouchbaseException
- if any other generic unhandled/unexpected errors.
-
createIndex
Creates a named query index.By default, this method will create an index on the bucket. If an index needs to be created on a collection, both
CreateQueryIndexOptions.scopeName(String)
andCreateQueryIndexOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket to create the index on.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 the keyspace.CouchbaseException
- if any other generic unhandled/unexpected errors.
-
createIndex
public void createIndex(String bucketName, String indexName, Collection<String> fields, CreateQueryIndexOptions options) Creates a named query index with custom options.By default, this method will create an index on the bucket. If an index needs to be created on a collection, both
CreateQueryIndexOptions.scopeName(String)
andCreateQueryIndexOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket to create the index on.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 the keyspace.CouchbaseException
- if any other generic unhandled/unexpected errors.
-
getAllIndexes
Fetches all indexes from the bucket.By default, this method will fetch all index on the bucket. If the indexes should be loaded for a collection, both
GetAllQueryIndexesOptions.scopeName(String)
andGetAllQueryIndexesOptions.collectionName(String)
must be set. If all indexes for a scope should be loaded, only theGetAllQueryIndexesOptions.scopeName(String)
can be set.- Parameters:
bucketName
- the name of the bucket to load the indexes from.- Returns:
- a list of (potentially empty) indexes or failed with an error.
- Throws:
CouchbaseException
- if any other generic unhandled/unexpected errors.
-
getAllIndexes
Fetches all indexes from the bucket with custom options.By default, this method will fetch all index on the bucket. If the indexes should be loaded for a collection, both
GetAllQueryIndexesOptions.scopeName(String)
andGetAllQueryIndexesOptions.collectionName(String)
must be set. If all indexes for a scope should be loaded, only theGetAllQueryIndexesOptions.scopeName(String)
can be set.- Parameters:
bucketName
- the name of the bucket to load the indexes from.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
Drops the primary index from a bucket.By default, this method will drop the primary index on the bucket. If the index should be dropped on a collection, both
DropPrimaryQueryIndexOptions.scopeName(String)
andDropPrimaryQueryIndexOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket to drop the indexes from.- 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
Drops the primary index from a bucket with custom options.By default, this method will drop the primary index on the bucket. If the index should be dropped on a collection, both
DropPrimaryQueryIndexOptions.scopeName(String)
andDropPrimaryQueryIndexOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket to drop the indexes from.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
Drops a query index from a bucket.By default, this method will drop the index on the bucket. If the index should be dropped on a collection, both
DropQueryIndexOptions.scopeName(String)
andDropQueryIndexOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket to drop the indexes from.indexName
- the name of the index top 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
Drops a query index from a bucket with custom options.By default, this method will drop the index on the bucket. If the index should be dropped on a collection, both
DropQueryIndexOptions.scopeName(String)
andDropQueryIndexOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket to drop the indexes from.indexName
- the name of the index top 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
Builds all currently deferred indexes in the bucket's default collection.To target a different collection, see
buildDeferredIndexes(String, BuildQueryIndexOptions)
.- Parameters:
bucketName
- the name of the bucket to build deferred indexes for.- Throws:
CouchbaseException
- if any other generic unhandled/unexpected errors.
-
buildDeferredIndexes
Builds all currently deferred indexes in a collection.By default, this method targets the bucket's default collection. To target a different collection, specify both
BuildQueryIndexOptions.scopeName(String)
andBuildQueryIndexOptions.collectionName(String)
.- Parameters:
bucketName
- the name of the bucket to build deferred indexes for.options
- the custom options to apply.- Throws:
CouchbaseException
- if any other generic unhandled/unexpected errors.
-
watchIndexes
Watches/Polls indexes until they are online.By default, this method will watch the indexes on the bucket. If the indexes should be watched on a collection, both
WatchQueryIndexesOptions.scopeName(String)
andWatchQueryIndexesOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket where the indexes should be watched.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(String bucketName, Collection<String> indexNames, Duration timeout, WatchQueryIndexesOptions options) Watches/Polls indexes until they are online with custom options.By default, this method will watch the indexes on the bucket. If the indexes should be watched on a collection, both
WatchQueryIndexesOptions.scopeName(String)
andWatchQueryIndexesOptions.collectionName(String)
must be set.- Parameters:
bucketName
- the name of the bucket where the indexes should be watched.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.
-