public class ScopeSearchIndexManager extends Object
ScopeSearchIndexManager
allows to manage search indexes.
All management is done with scope FTS indexes. For global FTS indexes, use @SearchIndexManager
.
Constructor and Description |
---|
ScopeSearchIndexManager(AsyncScopeSearchIndexManager internal) |
Modifier and Type | Method and Description |
---|---|
void |
allowQuerying(String name)
Allows querying against an index.
|
void |
allowQuerying(String name,
AllowQueryingSearchIndexOptions options)
Allows querying against an index.
|
List<JsonObject> |
analyzeDocument(String name,
JsonObject document)
Allows to see how a document is analyzed against a specific index.
|
List<JsonObject> |
analyzeDocument(String name,
JsonObject document,
AnalyzeDocumentOptions options)
Allows to see how a document is analyzed against a specific index.
|
void |
disallowQuerying(String name)
Disallows querying against an index.
|
void |
disallowQuerying(String name,
DisallowQueryingSearchIndexOptions options)
Disallows querying against an index.
|
void |
dropIndex(String name)
Drops an index.
|
void |
dropIndex(String name,
DropSearchIndexOptions options)
Drops an index.
|
void |
freezePlan(String name)
Freeze the assignment of index partitions to nodes.
|
void |
freezePlan(String name,
FreezePlanSearchIndexOptions options)
Freeze the assignment of index partitions to nodes.
|
List<SearchIndex> |
getAllIndexes()
Fetches all indexes from the server.
|
List<SearchIndex> |
getAllIndexes(GetAllSearchIndexesOptions options)
Fetches all indexes from the server.
|
SearchIndex |
getIndex(String name)
Fetches an index from the server if it exists.
|
SearchIndex |
getIndex(String name,
GetSearchIndexOptions options)
Fetches an index from the server if it exists.
|
Long |
getIndexedDocumentsCount(String name)
Retrieves the number of documents that have been indexed for an index.
|
Long |
getIndexedDocumentsCount(String name,
GetIndexedSearchIndexOptions options)
Retrieves the number of documents that have been indexed for an index.
|
void |
pauseIngest(String name)
Pauses updates and maintenance for an index.
|
void |
pauseIngest(String name,
PauseIngestSearchIndexOptions options)
Pauses updates and maintenance for an index.
|
void |
resumeIngest(String name)
Resumes updates and maintenance for an index.
|
void |
resumeIngest(String name,
ResumeIngestSearchIndexOptions options)
Resumes updates and maintenance for an index.
|
void |
unfreezePlan(String name)
Unfreeze the assignment of index partitions to nodes.
|
void |
unfreezePlan(String name,
UnfreezePlanSearchIndexOptions options)
Unfreeze the assignment of index partitions to nodes.
|
void |
upsertIndex(SearchIndex index)
Creates, or updates, an index.
|
void |
upsertIndex(SearchIndex index,
UpsertSearchIndexOptions options)
Creates, or updates, an index.
|
public ScopeSearchIndexManager(AsyncScopeSearchIndexManager internal)
public 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 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 List<SearchIndex> getAllIndexes()
CompletableFuture
with all index definitions once complete.public List<SearchIndex> getAllIndexes(GetAllSearchIndexesOptions options)
CompletableFuture
with all index definitions once complete.public 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 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 void upsertIndex(SearchIndex index)
index
- the index definition to upsert.public void upsertIndex(SearchIndex index, UpsertSearchIndexOptions options)
index
- the index definition to upsert.public void dropIndex(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".public 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".public 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 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 void pauseIngest(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".public 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".public void resumeIngest(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".public 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".public void allowQuerying(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".public 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".public void disallowQuerying(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".public 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".public void freezePlan(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".public 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".public void unfreezePlan(String name)
name
- the name of the search index. This should just be the index name, rather than "bucket.scope.indexName".public 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".Copyright © 2024 Couchbase, Inc.. All rights reserved.