Class ScopeSearchIndexManager

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

Methods

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

Methods

allowQuerying

  • allowQuerying(indexName, options?, callback?): Promise<void>

  • Enables querying of an index.

    Parameters

    • indexName: string

      The name of the index to enable querying for.

    • Optional options: AllowSearchQueryingOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

analyzeDocument

  • analyzeDocument(indexName, document, options?, callback?): 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.

    • Optional options: AnalyzeSearchDocumentOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<any>

      A node-style callback to be invoked after execution.

    Returns Promise<any>

disallowQuerying

  • disallowQuerying(indexName, options?, callback?): Promise<void>

  • Disables querying of an index.

    Parameters

    • indexName: string

      The name of the index to disable querying for.

    • Optional options: DisallowSearchQueryingOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

dropIndex

  • dropIndex(indexName, options?, callback?): Promise<void>

  • Drops an index.

    Parameters

    • indexName: string

      The name of the index to drop.

    • Optional options: DropSearchIndexOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

freezePlan

  • freezePlan(indexName, options?, callback?): Promise<void>

  • Freezes the indexing plan for execution of queries.

    Parameters

    • indexName: string

      The name of the index to freeze the plan of.

    • Optional options: FreezeSearchPlanOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

getAllIndexes

  • getAllIndexes(options?, callback?): Promise<SearchIndex[]>

  • Returns a list of all existing indexes.

    Parameters

    Returns Promise<SearchIndex[]>

getIndex

  • getIndex(indexName, options?, callback?): Promise<SearchIndex>

  • Returns an index by it's name.

    Parameters

    Returns Promise<SearchIndex>

getIndexedDocumentsCount

  • getIndexedDocumentsCount(indexName, options?, callback?): Promise<number>

  • Returns the number of documents that have been indexed.

    Parameters

    • indexName: string

      The name of the index to return the count for.

    • Optional options: GetSearchIndexedDocumentsCountOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<number>

      A node-style callback to be invoked after execution.

    Returns Promise<number>

pauseIngest

  • pauseIngest(indexName, options?, callback?): Promise<void>

  • Pauses the ingestion of documents into an index.

    Parameters

    • indexName: string

      The name of the index to pause.

    • Optional options: PauseSearchIngestOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

resumeIngest

  • resumeIngest(indexName, options?, callback?): Promise<void>

  • Resumes the ingestion of documents into an index.

    Parameters

    • indexName: string

      The name of the index to resume.

    • Optional options: ResumeSearchIngestOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

unfreezePlan

  • unfreezePlan(indexName, options?, callback?): Promise<void>

  • Unfreezes the indexing plan for execution of queries.

    Parameters

    • indexName: string

      The name of the index to freeze the plan of.

    • Optional options: UnfreezeSearchPlanOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

upsertIndex

  • upsertIndex(indexDefinition, options?, callback?): Promise<void>

  • Creates or updates an existing index.

    Parameters

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

allowQueryinganalyzeDocumentdisallowQueryingdropIndexfreezePlangetAllIndexesgetIndexgetIndexedDocumentsCountpauseIngestresumeIngestunfreezePlanupsertIndex