public class SearchIndexManager extends Object
SearchIndexManager
allows to manage search index structures in a couchbase cluster.Constructor and Description |
---|
SearchIndexManager(AsyncSearchIndexManager asyncIndexManager) |
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 SearchIndexManager(AsyncSearchIndexManager asyncIndexManager)
public SearchIndex getIndex(String name, GetSearchIndexOptions options)
name
- the name of the search index.public List<SearchIndex> getAllIndexes(GetAllSearchIndexesOptions options)
public long getIndexedDocumentsCount(String name, GetIndexedSearchIndexOptions options)
name
- the name of the search index.public List<JsonObject> analyzeDocument(String name, JsonObject document, AnalyzeDocumentOptions options)
name
- the name of the search index.document
- the document to be analyzed.public void upsertIndex(SearchIndex index, UpsertSearchIndexOptions options)
index
- the index definition including name and settings.public void dropIndex(String name, DropSearchIndexOptions options)
name
- the name of the search index.public void pauseIngest(String name, PauseIngestSearchIndexOptions options)
name
- the name of the search index.public void resumeIngest(String name, ResumeIngestSearchIndexOptions options)
name
- the name of the search index.public void allowQuerying(String name, AllowQueryingSearchIndexOptions options)
name
- the name of the search index.public void disallowQuerying(String name, DisallowQueryingSearchIndexOptions options)
name
- the name of the search index.public void freezePlan(String name, FreezePlanSearchIndexOptions options)
name
- the name of the search index.public void unfreezePlan(String name, UnfreezePlanSearchIndexOptions options)
name
- the name of the search index.public SearchIndex getIndex(String name)
name
- the name of the search index.public List<SearchIndex> getAllIndexes()
public long getIndexedDocumentsCount(String name)
name
- the name of the search index.public List<JsonObject> analyzeDocument(String name, JsonObject document)
name
- the name of the search index.document
- the document to be analyzed.public void upsertIndex(SearchIndex index)
index
- the index definition including name and settings.public void dropIndex(String name)
name
- the name of the search index.public void pauseIngest(String name)
name
- the name of the search index.public void resumeIngest(String name)
name
- the name of the search index.public void allowQuerying(String name)
name
- the name of the search index.public void disallowQuerying(String name)
name
- the name of the search index.public void freezePlan(String name)
name
- the name of the search index.public void unfreezePlan(String name)
name
- the name of the search index.Copyright © 2020 Couchbase, Inc.. All rights reserved.