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