Class SearchIndexManager

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

Hierarchy

  • SearchIndexManager

Methods

  • 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>

  • 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<void>

      A node-style callback to be invoked after execution.

    Returns 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>

  • 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>

  • 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>

  • Returns a list of all existing indexes.

    Parameters

    Returns Promise<SearchIndex[]>

  • Returns an index by it's name.

    Parameters

    • indexName: string

      The index to retrieve.

    • Optional options: GetSearchIndexOptions

      Optional parameters for this operation.

    • Optional callback: NodeCallback<SearchIndex>

      A node-style callback to be invoked after execution.

    Returns Promise<SearchIndex>

  • 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>

  • 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>

  • 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>

  • Creates or updates an existing index.

    Parameters

    Returns Promise<void>

Generated using TypeDoc