@Stability.Volatile public class CollectionQueryIndexManager extends Object
Constructor and Description |
---|
CollectionQueryIndexManager(AsyncCollectionQueryIndexManager async)
Creates a new
CollectionQueryIndexManager . |
Modifier and Type | Method and Description |
---|---|
void |
buildDeferredIndexes()
Builds all currently deferred indexes on this collection.
|
void |
buildDeferredIndexes(BuildQueryIndexOptions options)
Builds all currently deferred indexes on this collection, with custom options.
|
void |
createIndex(String indexName,
Collection<String> fields)
Creates a named query index on this collection.
|
void |
createIndex(String indexName,
Collection<String> fields,
CreateQueryIndexOptions options)
Creates a named query index with custom options, on this collection.
|
void |
createPrimaryIndex()
Creates a primary query index on this collection.
|
void |
createPrimaryIndex(CreatePrimaryQueryIndexOptions options)
Creates a primary query index with custom options, on this collection.
|
void |
dropIndex(String indexName)
Drops a query index from this collection.
|
void |
dropIndex(String indexName,
DropQueryIndexOptions options)
Drops a query index from this collection with custom options.
|
void |
dropPrimaryIndex()
Drops the primary index from this collection.
|
void |
dropPrimaryIndex(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.
|
void |
watchIndexes(Collection<String> indexNames,
Duration timeout)
Watches/Polls indexes on this collection until they are online.
|
void |
watchIndexes(Collection<String> indexNames,
Duration timeout,
WatchQueryIndexesOptions options)
Watches/Polls indexes on this collection until they are online with custom options.
|
@Stability.Internal public CollectionQueryIndexManager(AsyncCollectionQueryIndexManager async)
CollectionQueryIndexManager
.
This API is not intended to be called by the user directly, use Collection.queryIndexes()
instead.
public void createPrimaryIndex()
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 this collection.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createPrimaryIndex(CreatePrimaryQueryIndexOptions options)
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 this collection.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createIndex(String indexName, Collection<String> fields)
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 this collection.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void createIndex(String indexName, Collection<String> fields, CreateQueryIndexOptions options)
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 this collection.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<QueryIndex> getAllIndexes()
com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public List<QueryIndex> getAllIndexes(GetAllQueryIndexesOptions options)
options
- the custom options to apply.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void dropPrimaryIndex()
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(DropPrimaryQueryIndexOptions options)
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 indexName)
indexName
- the name of the index to 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 indexName, DropQueryIndexOptions options)
indexName
- the name of the index to 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()
com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void buildDeferredIndexes(BuildQueryIndexOptions options)
options
- the custom options to apply.com.couchbase.client.core.error.CouchbaseException
- if any other generic unhandled/unexpected errors.public void watchIndexes(Collection<String> indexNames, Duration timeout)
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(Collection<String> indexNames, Duration timeout, WatchQueryIndexesOptions options)
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.