Interface ISearchIndex

Provides information about a search index. This class is currently incomplete and must be casted from any in TypeScript.

interface ISearchIndex {
    name: string;
    params: {
        [key: string]: any;
    };
    planParams: {
        [key: string]: any;
    };
    sourceName: string;
    sourceParams: {
        [key: string]: any;
    };
    sourceType: string;
    sourceUuid: string;
    type: string;
    uuid?: string;
}

Implemented by

Properties

name params planParams sourceName sourceParams sourceType sourceUuid type uuid?

Properties

name

name: string

The name of the search index.

params

params: {
    [key: string]: any;
}

Parameters to specify such as the store type and mappins.

Type declaration

  • [key: string]: any

planParams

planParams: {
    [key: string]: any;
}

Plan properties such as the number of replicas and number of partitions.

Type declaration

  • [key: string]: any

sourceName

sourceName: string

Name of the source of the data (ie: the bucket name).

sourceParams

sourceParams: {
    [key: string]: any;
}

Extra parameters for the source. These are usually things like advanced connection options and tuning parameters.

Type declaration

  • [key: string]: any

sourceType

sourceType: string

The type of the source (couchbase or nil).

sourceUuid

sourceUuid: string

The UUID of the data source.

type

type: string

The type of index to use (fulltext-index or fulltext-alias).

Optional uuid

uuid?: string

The UUID of the search index. Used for updates to ensure consistency.

Settings

Member Visibility

Theme

On This Page

nameparamsplanParamssourceNamesourceParamssourceTypesourceUuidtypeuuid