Package com.couchbase.client.java.manager.query

Class ReactiveCollectionQueryIndexManager

java.lang.Object

com.couchbase.client.java.manager.query.ReactiveCollectionQueryIndexManager

@Volatile
public class ReactiveCollectionQueryIndexManager
extends Object

Performs management operations on query indexes at the ReactiveCollection level.

Constructor Summary

Constructors

Constructor	Description
ReactiveCollectionQueryIndexManager(AsyncCollectionQueryIndexManager async)	Creates a new ReactiveCollectionQueryIndexManager.

Method Summary

Modifier and Type	Method	Description
Mono<Void>	buildDeferredIndexes()	Builds all currently deferred indexes on this collection.
Mono<Void>	buildDeferredIndexes(BuildQueryIndexOptions options)	Builds all currently deferred indexes on this collection, with custom options.
Mono<Void>	createIndex(String indexName, Collection<String> fields)	Creates a named query index on this collection.
Mono<Void>	createIndex(String indexName, Collection<String> fields, CreateQueryIndexOptions options)	Creates a named query index with custom options, on this collection.
Mono<Void>	createPrimaryIndex()	Creates a primary query index on this collection.
Mono<Void>	createPrimaryIndex(CreatePrimaryQueryIndexOptions options)	Creates a primary query index with custom options, on this collection.
Mono<Void>	dropIndex(String indexName)	Drops a query index from this collection.
Mono<Void>	dropIndex(String indexName, DropQueryIndexOptions options)	Drops a query index from this collection with custom options.
Mono<Void>	dropPrimaryIndex()	Drops the primary index from this collection.
Mono<Void>	dropPrimaryIndex(DropPrimaryQueryIndexOptions options)	Drops the primary index from this collection.
Flux<QueryIndex>	getAllIndexes()	Fetches all indexes on this collection.
Flux<QueryIndex>	getAllIndexes(GetAllQueryIndexesOptions options)	Fetches all indexes from this collection with custom options.
Mono<Void>	watchIndexes(Collection<String> indexNames, Duration timeout)	Watches/Polls indexes on this collection until they are online.
Mono<Void>	watchIndexes(Collection<String> indexNames, Duration timeout, WatchQueryIndexesOptions options)	Watches/Polls indexes on this collection until they are online with custom options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReactiveCollectionQueryIndexManager

@Internal
public ReactiveCollectionQueryIndexManager(AsyncCollectionQueryIndexManager async)

Creates a new ReactiveCollectionQueryIndexManager.

This API is not intended to be called by the user directly, use ReactiveCluster.queryIndexes() instead.

Parameters:

async - the async index manager.

Method Detail

createIndex

public Mono<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 Mono<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.

createPrimaryIndex

public Mono<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 Mono<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.

getAllIndexes

public Flux<QueryIndex> getAllIndexes()

Fetches all indexes on this collection.

Returns:

a (potentially empty) Flux of indexes or failed with an error.

Throws:

CouchbaseException - if any other generic unhandled/unexpected errors.

getAllIndexes

public Flux<QueryIndex> getAllIndexes(GetAllQueryIndexesOptions options)

Fetches all indexes from this collection with custom options.

Parameters:

options - the custom options to apply.

Returns:

a (potentially empty) Flux of indexes or failed with an error.

Throws:

CouchbaseException - if any other generic unhandled/unexpected errors.

dropPrimaryIndex

public Mono<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 Mono<Void> dropPrimaryIndex(DropPrimaryQueryIndexOptions options)

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.

dropIndex

public Mono<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 Mono<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 Mono<Void> buildDeferredIndexes()

Builds all currently deferred indexes on this collection.

Throws:

CouchbaseException - if any other generic unhandled/unexpected errors.

buildDeferredIndexes

public Mono<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 Mono<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 Mono<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.