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

Class AsyncScopeSearchIndexManager

java.lang.Object

com.couchbase.client.java.manager.search.AsyncScopeSearchIndexManager

@Volatile
public class AsyncScopeSearchIndexManager
extends Object

The AsyncScopeSearchIndexManager allows to manage scope level search indexes.

All management is done with scope FTS indexes. For global FTS indexes, use @AsyncSearchIndexManager.

Constructor Summary

Constructors

Constructor	Description
AsyncScopeSearchIndexManager(CoreCouchbaseOps couchbaseOps, AsyncScope scope)

Method Summary

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

AsyncScopeSearchIndexManager

public AsyncScopeSearchIndexManager(CoreCouchbaseOps couchbaseOps,
                                    AsyncScope scope)

Method Detail

getIndex

public CompletableFuture<SearchIndex> getIndex(String name)

Fetches an index from the server if it exists.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName". This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture the found index once complete.

getIndex

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

Fetches an index from the server if it exists.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture the found index once complete.

getAllIndexes

public CompletableFuture<List<SearchIndex>> getAllIndexes()

Fetches all indexes from the server.

Returns:

a CompletableFuture with all index definitions once complete.

getAllIndexes

public CompletableFuture<List<SearchIndex>> getAllIndexes(GetAllSearchIndexesOptions options)

Fetches all indexes from the server.

Returns:

a CompletableFuture with all index definitions once complete.

getIndexedDocumentsCount

public CompletableFuture<Long> getIndexedDocumentsCount(String name)

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

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture with the indexed documents count once complete.

getIndexedDocumentsCount

public CompletableFuture<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. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture with the indexed documents count once complete.

upsertIndex

public CompletableFuture<Void> upsertIndex(SearchIndex index)

Creates, or updates, an index.

Parameters:

index - the index definition to upsert.

Returns:

a CompletableFuture indicating request completion.

upsertIndex

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

Creates, or updates, an index.

Parameters:

index - the index definition to upsert.

Returns:

a CompletableFuture indicating request completion.

dropIndex

public CompletableFuture<Void> dropIndex(String name)

Drops an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

dropIndex

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

Drops an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

analyzeDocument

public CompletableFuture<List<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. This should just be the index name, rather than "bucket.scope.indexName".

document - the document to analyze.

Returns:

a CompletableFuture with analyzed document parts once complete.

analyzeDocument

public CompletableFuture<List<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. This should just be the index name, rather than "bucket.scope.indexName".

document - the document to analyze.

Returns:

a CompletableFuture with analyzed document parts once complete.

pauseIngest

public CompletableFuture<Void> pauseIngest(String name)

Pauses updates and maintenance for an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

pauseIngest

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

Pauses updates and maintenance for an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

resumeIngest

public CompletableFuture<Void> resumeIngest(String name)

Resumes updates and maintenance for an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

resumeIngest

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

Resumes updates and maintenance for an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

allowQuerying

public CompletableFuture<Void> allowQuerying(String name)

Allows querying against an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

allowQuerying

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

Allows querying against an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

disallowQuerying

public CompletableFuture<Void> disallowQuerying(String name)

Disallows querying against an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

disallowQuerying

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

Disallows querying against an index.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

freezePlan

public CompletableFuture<Void> freezePlan(String name)

Freeze the assignment of index partitions to nodes.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

freezePlan

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

Freeze the assignment of index partitions to nodes.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

unfreezePlan

public CompletableFuture<Void> unfreezePlan(String name)

Unfreeze the assignment of index partitions to nodes.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.

unfreezePlan

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

Unfreeze the assignment of index partitions to nodes.

Parameters:

name - the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".

Returns:

a CompletableFuture indicating request completion.