public class QueryIndexManager extends Object
Constructor and Description |
---|
QueryIndexManager(AsyncQueryIndexManager async)
Creates a new
QueryIndexManager . |
Modifier and Type | Method and Description |
---|---|
AsyncQueryIndexManager |
async()
Provides access to the
AsyncQueryIndexManager . |
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 |
dropIndex(String bucketName,
String indexName)
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.
|
List<QueryIndex> |
getAllIndexes(String bucketName)
Fetches all indexes from the bucket.
|
List<QueryIndex> |
getAllIndexes(String bucketName,
GetAllQueryIndexesOptions options)
Fetches all indexes from the bucket with custom options.
|
ReactiveQueryIndexManager |
reactive()
Provides access to the
ReactiveQueryIndexManager . |
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.
|
@Stability.Internal public QueryIndexManager(AsyncQueryIndexManager async)
QueryIndexManager
.
This API is not intended to be called by the user directly, use Cluster.queryIndexes()
instead.
async
- the async index manager.public AsyncQueryIndexManager async()
AsyncQueryIndexManager
.public ReactiveQueryIndexManager reactive()
ReactiveQueryIndexManager
.public void createPrimaryIndex(String bucketName)
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)
and
CreatePrimaryQueryIndexOptions.collectionName(String)
must be set.
bucketName
- the name of the bucket to create the index on.com.couchbase.client.core.error.IndexFailureException
- if creating the index failed (see reason for details).com.couchbase.client.core.error.IndexExistsException
- if an index already exists with the given name on the keyspace.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createPrimaryIndex(String bucketName, CreatePrimaryQueryIndexOptions 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)
and
CreatePrimaryQueryIndexOptions.collectionName(String)
must be set.
bucketName
- the name of the bucket to create the index on.options
- the custom options to apply.com.couchbase.client.core.error.IndexFailureException
- if creating the index failed (see reason for details).com.couchbase.client.core.error.IndexExistsException
- if an index already exists with the given name on the keyspace.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createIndex(String bucketName, String indexName, Collection<String> fields)
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)
and CreateQueryIndexOptions.collectionName(String)
must be set.
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.com.couchbase.client.core.error.IndexFailureException
- if creating the index failed (see reason for details).com.couchbase.client.core.error.IndexExistsException
- if an index already exists with the given name on the keyspace.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createIndex(String bucketName, String indexName, Collection<String> fields, CreateQueryIndexOptions 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)
and CreateQueryIndexOptions.collectionName(String)
must be set.
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.com.couchbase.client.core.error.IndexFailureException
- if creating the index failed (see reason for details).com.couchbase.client.core.error.IndexExistsException
- if an index already exists with the given name on the keyspace.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<QueryIndex> getAllIndexes(String bucketName)
By default, this method will fetch all index on the bucket. If the indexes should be loaded for a collection,
both GetAllQueryIndexesOptions.scopeName(String)
and
GetAllQueryIndexesOptions.collectionName(String)
must be set. If all indexes for a scope should be loaded,
only the GetAllQueryIndexesOptions.scopeName(String)
can be set.
bucketName
- the name of the bucket to load the indexes from.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<QueryIndex> getAllIndexes(String bucketName, GetAllQueryIndexesOptions 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)
and
GetAllQueryIndexesOptions.collectionName(String)
must be set. If all indexes for a scope should be loaded,
only the GetAllQueryIndexesOptions.scopeName(String)
can be set.
bucketName
- the name of the bucket to load the indexes from.options
- the custom options to apply.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropPrimaryIndex(String bucketName)
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)
and
DropPrimaryQueryIndexOptions.collectionName(String)
must be set.
bucketName
- the name of the bucket to drop the indexes from.com.couchbase.client.core.error.IndexNotFoundException
- if the index does not exist.com.couchbase.client.core.error.IndexFailureException
- if dropping the index failed (see reason for details).com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropPrimaryIndex(String bucketName, DropPrimaryQueryIndexOptions 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)
and
DropPrimaryQueryIndexOptions.collectionName(String)
must be set.
bucketName
- the name of the bucket to drop the indexes from.options
- the custom options to apply.com.couchbase.client.core.error.IndexNotFoundException
- if the index does not exist.com.couchbase.client.core.error.IndexFailureException
- if dropping the index failed (see reason for details).com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropIndex(String bucketName, String indexName)
By default, this method will drop the index on the bucket. If the index should be dropped on a collection,
both DropQueryIndexOptions.scopeName(String)
and
DropQueryIndexOptions.collectionName(String)
must be set.
bucketName
- the name of the bucket to drop the indexes from.indexName
- the name of the index top drop.com.couchbase.client.core.error.IndexNotFoundException
- if the index does not exist.com.couchbase.client.core.error.IndexFailureException
- if dropping the index failed (see reason for details).com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropIndex(String bucketName, String indexName, DropQueryIndexOptions 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)
and
DropQueryIndexOptions.collectionName(String)
must be set.
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.com.couchbase.client.core.error.IndexNotFoundException
- if the index does not exist.com.couchbase.client.core.error.IndexFailureException
- if dropping the index failed (see reason for details).com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void buildDeferredIndexes(String bucketName)
To target a different collection, see buildDeferredIndexes(String, BuildQueryIndexOptions)
.
bucketName
- the name of the bucket to build deferred indexes for.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void buildDeferredIndexes(String bucketName, BuildQueryIndexOptions options)
By default, this method targets the bucket's default collection.
To target a different collection, specify both
BuildQueryIndexOptions.scopeName(String)
and
BuildQueryIndexOptions.collectionName(String)
.
bucketName
- the name of the bucket to build deferred indexes for.options
- the custom options to apply.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void watchIndexes(String bucketName, Collection<String> indexNames, Duration timeout)
By default, this method will watch the indexes on the bucket. If the indexes should be watched on a collection,
both WatchQueryIndexesOptions.scopeName(String)
and
WatchQueryIndexesOptions.collectionName(String)
must be set.
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.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void watchIndexes(String bucketName, Collection<String> indexNames, Duration timeout, WatchQueryIndexesOptions 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)
and
WatchQueryIndexesOptions.collectionName(String)
must be set.
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.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.Copyright © 2024 Couchbase, Inc.. All rights reserved.