Class SearchIndexManager

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

Index

Methods

allowQuerying analyzeDocument disallowQuerying dropIndex freezePlan getAllIndexes getIndex getIndexedDocumentsCount pauseIngest resumeIngest unfreezePlan upsertIndex

Methods

allowQuerying

allowQuerying(
    indexName: string,
    options?: AllowSearchQueryingOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Enables querying of an index.
Parameters
- indexName: string
  The name of the index to enable querying for.
- Optionaloptions: AllowSearchQueryingOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/searchindexmanager.ts:592

analyzeDocument

analyzeDocument(
    indexName: string,
    document: any,
    options?: AnalyzeSearchDocumentOptions,
    callback?: NodeCallback<any>,
): Promise<any>
Performs analysis of a specific document by an index.
Parameters
- indexName: string
  The name of the index to use for the analysis.
- document: any
  The document to analyze.
- Optionaloptions: AnalyzeSearchDocumentOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<any>
  A node-style callback to be invoked after execution.
Returns Promise<any>
- Defined in lib/searchindexmanager.ts:753

disallowQuerying

disallowQuerying(
    indexName: string,
    options?: DisallowSearchQueryingOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Disables querying of an index.
Parameters
- indexName: string
  The name of the index to disable querying for.
- Optionaloptions: DisallowSearchQueryingOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/searchindexmanager.ts:632

dropIndex

dropIndex(
    indexName: string,
    options?: DropSearchIndexOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Drops an index.
Parameters
- indexName: string
  The name of the index to drop.
- Optionaloptions: DropSearchIndexOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/searchindexmanager.ts:434

freezePlan

freezePlan(
    indexName: string,
    options?: FreezeSearchPlanOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Freezes the indexing plan for execution of queries.
Parameters
- indexName: string
  The name of the index to freeze the plan of.
- Optionaloptions: FreezeSearchPlanOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/searchindexmanager.ts:672

getAllIndexes

getAllIndexes(
options?: GetAllSearchIndexesOptions,
callback?: NodeCallback<SearchIndex[]>,
): Promise<SearchIndex[]>
Returns a list of all existing indexes.
Parameters
- Optionaloptions: GetAllSearchIndexesOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<SearchIndex[]>
  A node-style callback to be invoked after execution.
Returns Promise<SearchIndex[]>
- Defined in lib/searchindexmanager.ts:355

getIndex

getIndex(
    indexName: string,
    options?: GetSearchIndexOptions,
    callback?: NodeCallback<SearchIndex>,
): Promise<SearchIndex>
Returns an index by it's name.
Parameters
- indexName: string
  The index to retrieve.
- Optionaloptions: GetSearchIndexOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<SearchIndex>
  A node-style callback to be invoked after execution.
Returns Promise<SearchIndex>
- Defined in lib/searchindexmanager.ts:316

getIndexedDocumentsCount

getIndexedDocumentsCount(
    indexName: string,
    options?: GetSearchIndexedDocumentsCountOptions,
    callback?: NodeCallback<number>,
): Promise<number>
Returns the number of documents that have been indexed.
Parameters
- indexName: string
  The name of the index to return the count for.
- Optionaloptions: GetSearchIndexedDocumentsCountOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<number>
  A node-style callback to be invoked after execution.
Returns Promise<number>
- Defined in lib/searchindexmanager.ts:473

pauseIngest

pauseIngest(
    indexName: string,
    options?: PauseSearchIngestOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Pauses the ingestion of documents into an index.
Parameters
- indexName: string
  The name of the index to pause.
- Optionaloptions: PauseSearchIngestOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/searchindexmanager.ts:512

resumeIngest

resumeIngest(
    indexName: string,
    options?: ResumeSearchIngestOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Resumes the ingestion of documents into an index.
Parameters
- indexName: string
  The name of the index to resume.
- Optionaloptions: ResumeSearchIngestOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/searchindexmanager.ts:552

unfreezePlan

unfreezePlan(
    indexName: string,
    options?: UnfreezeSearchPlanOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Unfreezes the indexing plan for execution of queries.
Parameters
- indexName: string
  The name of the index to freeze the plan of.
- Optionaloptions: UnfreezeSearchPlanOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/searchindexmanager.ts:712

upsertIndex

upsertIndex(
    indexDefinition: ISearchIndex,
    options?: UpsertSearchIndexOptions,
    callback?: NodeCallback<void>,
): Promise<void>
Creates or updates an existing index.
Parameters
- indexDefinition: ISearchIndex
  The index to update.
- Optionaloptions: UpsertSearchIndexOptions
  Optional parameters for this operation.
- Optionalcallback: NodeCallback<void>
  A node-style callback to be invoked after execution.
Returns Promise<void>
- Defined in lib/searchindexmanager.ts:395

Class SearchIndexManager

Index

Methods

Methods

allowQuerying

Parameters

Returns Promise<void>

analyzeDocument

Parameters

Returns Promise<any>

disallowQuerying

Parameters

Returns Promise<void>

dropIndex

Parameters

Returns Promise<void>

freezePlan

Parameters

Returns Promise<void>

getAllIndexes

Parameters

Returns Promise<SearchIndex[]>

getIndex

Parameters

Returns Promise<SearchIndex>

getIndexedDocumentsCount

Parameters

Returns Promise<number>

pauseIngest

Parameters

Returns Promise<void>

resumeIngest

Parameters

Returns Promise<void>

unfreezePlan

Parameters

Returns Promise<void>

upsertIndex

Parameters

Returns Promise<void>

Settings

On This Page