Class

SearchIndexManager

SearchIndexManager

SearchIndexManager provides an interface for managing the search indexes on the cluster.

Methods

# async allowQuerying(indexName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
indexName string
options Object <optional>
timeout number <optional>
callback AllowQueryingCallback <optional>

View Source searchindexmanager.js, line 354

SearchIndexNotFoundError
Promise.<boolean>

# async analyzeDocument(indexName, document, optionsopt, callbackopt) → {Promise.<Array.<Object>>}

Parameters:
Name Type Attributes Description
indexName string
document *
options Object <optional>
timeout number <optional>
callback AnalyzeDocumentCallback <optional>

View Source searchindexmanager.js, line 481

SearchIndexNotFoundError
Promise.<Array.<Object>>

# async disallowQuerying(indexName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
indexName string
options Object <optional>
timeout number <optional>
callback DisallowQueryingCallback <optional>

View Source searchindexmanager.js, line 396

SearchIndexNotFoundError
Promise.<boolean>

# async dropIndex(indexName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
indexName string
options Object <optional>
timeout number <optional>
callback DropSearchIndexCallback <optional>

View Source searchindexmanager.js, line 186

SearchIndexNotFoundError
Promise.<boolean>

# async freezePlan(indexName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
indexName string
options Object <optional>
timeout number <optional>
callback FreezePlanCallback <optional>

View Source searchindexmanager.js, line 438

SearchIndexNotFoundError
Promise.<boolean>

# async getAllIndexes(optionsopt, callbackopt) → {Promise.<Array.<SearchIndex>>}

Parameters:
Name Type Attributes Description
options Object <optional>
timeout number <optional>
callback GetAllSearchIndexesCallback <optional>

View Source searchindexmanager.js, line 98

Promise.<Array.<SearchIndex>>

# async getIndex(indexName, optionsopt, callbackopt) → {Promise.<SearchIndex>}

Parameters:
Name Type Attributes Description
indexName string
options Object <optional>
timeout number <optional>
callback GetSearchIndexCallback <optional>

View Source searchindexmanager.js, line 58

SearchIndexNotFoundError
Promise.<SearchIndex>

# async getIndexedDocumentsCount(indexName, optionsopt, callbackopt) → {Promise.<number>}

Parameters:
Name Type Attributes Description
indexName string
options Object <optional>
timeout number <optional>
callback GetIndexedDocumentsCountCallback <optional>

View Source searchindexmanager.js, line 228

SearchIndexNotFoundError
Promise.<number>

# async pauseIngest(indexName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
indexName string
options Object <optional>
timeout number <optional>
callback PauseIngestCallback <optional>

View Source searchindexmanager.js, line 270

SearchIndexNotFoundError
Promise.<boolean>

# async resumeIngest(indexName, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
indexName string
options Object <optional>
timeout number <optional>
callback ResumeIngestCallback <optional>

View Source searchindexmanager.js, line 312

SearchIndexNotFoundError
Promise.<boolean>

# async upsertIndex(indexDefinition, optionsopt, callbackopt) → {Promise.<boolean>}

Parameters:
Name Type Attributes Description
indexDefinition SearchIndex
options Object <optional>
timeout number <optional>
callback UpsertSearchIndexCallback <optional>

View Source searchindexmanager.js, line 140

SearchIndexNotFoundError
Promise.<boolean>