Package com.couchbase.client.java.manager.search

Class ReactiveSearchIndexManager

java.lang.Object

com.couchbase.client.java.manager.search.ReactiveSearchIndexManager

public class ReactiveSearchIndexManager
extends Object

The ReactiveSearchIndexManager allows to manage search index structures in a couchbase cluster.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
ReactiveSearchIndexManager(AsyncSearchIndexManager asyncIndexManager)

Method Summary

Modifier and Type	Method	Description
Mono<Void>	allowQuerying(String name)	Allows querying against an index.
Mono<Void>	allowQuerying(String name, AllowQueryingSearchIndexOptions options)	Allows querying against an index.
Flux<JsonObject>	analyzeDocument(String name, JsonObject document)	Allows to see how a document is analyzed against a specific index.
Flux<JsonObject>	analyzeDocument(String name, JsonObject document, AnalyzeDocumentOptions options)	Allows to see how a document is analyzed against a specific index.
Mono<Void>	disallowQuerying(String name)	Disallows querying against an index.
Mono<Void>	disallowQuerying(String name, DisallowQueryingSearchIndexOptions options)	Disallows querying against an index.
Mono<Void>	dropIndex(String name)	Drops an index.
Mono<Void>	dropIndex(String name, DropSearchIndexOptions options)	Drops an index.
Mono<Void>	freezePlan(String name)	Freeze the assignment of index partitions to nodes.
Mono<Void>	freezePlan(String name, FreezePlanSearchIndexOptions options)	Freeze the assignment of index partitions to nodes.
Flux<SearchIndex>	getAllIndexes()	Fetches all indexes from the server.
Flux<SearchIndex>	getAllIndexes(GetAllSearchIndexesOptions options)	Fetches all indexes from the server.
Mono<SearchIndex>	getIndex(String name)	Fetches an index from the server if it exists.
Mono<SearchIndex>	getIndex(String name, GetSearchIndexOptions options)	Fetches an index from the server if it exists.
Mono<Long>	getIndexedDocumentsCount(String name)	Retrieves the number of documents that have been indexed for an index.
Mono<Long>	getIndexedDocumentsCount(String name, GetIndexedSearchIndexOptions options)	Retrieves the number of documents that have been indexed for an index.
Mono<Void>	pauseIngest(String name)	Pauses updates and maintenance for an index.
Mono<Void>	pauseIngest(String name, PauseIngestSearchIndexOptions options)	Pauses updates and maintenance for an index.
Mono<Void>	resumeIngest(String name)	Resumes updates and maintenance for an index.
Mono<Void>	resumeIngest(String name, ResumeIngestSearchIndexOptions options)	Resumes updates and maintenance for an index.
Mono<Void>	unfreezePlan(String name)	Unfreeze the assignment of index partitions to nodes.
Mono<Void>	unfreezePlan(String name, UnfreezePlanSearchIndexOptions options)	Unfreeze the assignment of index partitions to nodes.
Mono<Void>	upsertIndex(SearchIndex index)	Creates, or updates, an index.
Mono<Void>	upsertIndex(SearchIndex index, UpsertSearchIndexOptions options)	Creates, or updates, an index.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactiveSearchIndexManager

public ReactiveSearchIndexManager(AsyncSearchIndexManager asyncIndexManager)

Method Detail

getIndex

public Mono<SearchIndex> getIndex(String name,
                                  GetSearchIndexOptions options)

Fetches an index from the server if it exists.

Parameters:

name - the name of the search index.

Returns:

the index definition if it exists.

getAllIndexes

public Flux<SearchIndex> getAllIndexes(GetAllSearchIndexesOptions options)

Fetches all indexes from the server.

Returns:

all currently present indexes.

getIndexedDocumentsCount

public Mono<Long> getIndexedDocumentsCount(String name,
                                           GetIndexedSearchIndexOptions options)

Retrieves the number of documents that have been indexed for an index.

Parameters:

name - the name of the search index.

Returns:

the number of indexed documents.

analyzeDocument

public Flux<JsonObject> analyzeDocument(String name,
                                        JsonObject document,
                                        AnalyzeDocumentOptions options)

Allows to see how a document is analyzed against a specific index.

Parameters:

name - the name of the search index.

document - the document to be analyzed.

Returns:

the analyzed sections for the document.

upsertIndex

public Mono<Void> upsertIndex(SearchIndex index,
                              UpsertSearchIndexOptions options)

Creates, or updates, an index.

Parameters:

index - the index definition including name and settings.

dropIndex

public Mono<Void> dropIndex(String name,
                            DropSearchIndexOptions options)

Drops an index.

Parameters:

name - the name of the search index.

pauseIngest

public Mono<Void> pauseIngest(String name,
                              PauseIngestSearchIndexOptions options)

Pauses updates and maintenance for an index.

Parameters:

name - the name of the search index.

resumeIngest

public Mono<Void> resumeIngest(String name,
                               ResumeIngestSearchIndexOptions options)

Resumes updates and maintenance for an index.

Parameters:

name - the name of the search index.

allowQuerying

public Mono<Void> allowQuerying(String name,
                                AllowQueryingSearchIndexOptions options)

Allows querying against an index.

Parameters:

name - the name of the search index.

disallowQuerying

public Mono<Void> disallowQuerying(String name,
                                   DisallowQueryingSearchIndexOptions options)

Disallows querying against an index.

Parameters:

name - the name of the search index.

freezePlan

public Mono<Void> freezePlan(String name,
                             FreezePlanSearchIndexOptions options)

Freeze the assignment of index partitions to nodes.

Parameters:

name - the name of the search index.

unfreezePlan

public Mono<Void> unfreezePlan(String name,
                               UnfreezePlanSearchIndexOptions options)

Unfreeze the assignment of index partitions to nodes.

Parameters:

name - the name of the search index.

getIndex

public Mono<SearchIndex> getIndex(String name)

Fetches an index from the server if it exists.

Parameters:

name - the name of the search index.

Returns:

the index definition if it exists.

getAllIndexes

public Flux<SearchIndex> getAllIndexes()

Fetches all indexes from the server.

Returns:

all currently present indexes.

getIndexedDocumentsCount

public Mono<Long> getIndexedDocumentsCount(String name)

Retrieves the number of documents that have been indexed for an index.

Parameters:

name - the name of the search index.

Returns:

the number of indexed documents.

analyzeDocument

public Flux<JsonObject> analyzeDocument(String name,
                                        JsonObject document)

Allows to see how a document is analyzed against a specific index.

Parameters:

name - the name of the search index.

document - the document to be analyzed.

Returns:

the analyzed sections for the document.

upsertIndex

public Mono<Void> upsertIndex(SearchIndex index)

Creates, or updates, an index.

Parameters:

index - the index definition including name and settings.

dropIndex

public Mono<Void> dropIndex(String name)

Drops an index.

Parameters:

name - the name of the search index.

pauseIngest

public Mono<Void> pauseIngest(String name)

Pauses updates and maintenance for an index.

Parameters:

name - the name of the search index.

resumeIngest

public Mono<Void> resumeIngest(String name)

Resumes updates and maintenance for an index.

Parameters:

name - the name of the search index.

allowQuerying

public Mono<Void> allowQuerying(String name)

Allows querying against an index.

Parameters:

name - the name of the search index.

disallowQuerying

public Mono<Void> disallowQuerying(String name)

Disallows querying against an index.

Parameters:

name - the name of the search index.

freezePlan

public Mono<Void> freezePlan(String name)

Freeze the assignment of index partitions to nodes.

Parameters:

name - the name of the search index.

unfreezePlan

public Mono<Void> unfreezePlan(String name)

Unfreeze the assignment of index partitions to nodes.

Parameters:

name - the name of the search index.