public class AsyncScopeSearchIndexManager extends Object
AsyncScopeSearchIndexManager
allows to manage scope level search indexes.
All management is done with scope FTS indexes. For global FTS indexes, use @AsyncSearchIndexManager
.
Constructor and Description |
---|
AsyncScopeSearchIndexManager(com.couchbase.client.core.api.CoreCouchbaseOps couchbaseOps,
AsyncScope scope,
AsyncCluster cluster) |
Modifier and Type | Method and 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.
|
public AsyncScopeSearchIndexManager(com.couchbase.client.core.api.CoreCouchbaseOps couchbaseOps, AsyncScope scope, AsyncCluster cluster)
public CompletableFuture<SearchIndex> getIndex(String name)
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".CompletableFuture
the found index once complete.public CompletableFuture<SearchIndex> getIndex(String name, GetSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
the found index once complete.public CompletableFuture<List<SearchIndex>> getAllIndexes()
CompletableFuture
with all index definitions once complete.public CompletableFuture<List<SearchIndex>> getAllIndexes(GetAllSearchIndexesOptions options)
CompletableFuture
with all index definitions once complete.public CompletableFuture<Long> getIndexedDocumentsCount(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
with the indexed documents count once complete.public CompletableFuture<Long> getIndexedDocumentsCount(String name, GetIndexedSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
with the indexed documents count once complete.public CompletableFuture<Void> upsertIndex(SearchIndex index)
index
- the index definition to upsert.CompletableFuture
indicating request completion.public CompletableFuture<Void> upsertIndex(SearchIndex index, UpsertSearchIndexOptions options)
index
- the index definition to upsert.CompletableFuture
indicating request completion.public CompletableFuture<Void> dropIndex(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> dropIndex(String name, DropSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<List<JsonObject>> analyzeDocument(String name, JsonObject document)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".document
- the document to analyze.CompletableFuture
with analyzed document parts once complete.public CompletableFuture<List<JsonObject>> analyzeDocument(String name, JsonObject document, AnalyzeDocumentOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".document
- the document to analyze.CompletableFuture
with analyzed document parts once complete.public CompletableFuture<Void> pauseIngest(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> pauseIngest(String name, PauseIngestSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> resumeIngest(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> resumeIngest(String name, ResumeIngestSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> allowQuerying(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> allowQuerying(String name, AllowQueryingSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> disallowQuerying(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> disallowQuerying(String name, DisallowQueryingSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> freezePlan(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> freezePlan(String name, FreezePlanSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> unfreezePlan(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.public CompletableFuture<Void> unfreezePlan(String name, UnfreezePlanSearchIndexOptions options)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".CompletableFuture
indicating request completion.Copyright © 2024 Couchbase, Inc.. All rights reserved.