Type alias EnsureMdiPrefixedIndexOptions

EnsureMdiPrefixedIndexOptions: EnsureIndexOptionsType<"mdi-prefixed", string[], {
    estimates?: boolean;
    fieldValueTypes: "double";
    prefixFields: string[];
    sparse?: boolean;
    storedValues?: string[];
    unique?: boolean;
}>

Options for creating a prefixed MDI index.

Type declaration

  • Optional estimates?: boolean

    If set to false, index selectivity estimates will be disabled for this index.

    Default: true

  • fieldValueTypes: "double"

    Data type of the dimension attributes.

  • prefixFields: string[]

    An array of attribute names used as a search prefix.

  • Optional sparse?: boolean

    If set to true, the index will omit documents that do not contain at least one of the attribute paths in fields and these documents will be ignored for uniqueness checks.

    Default: false

  • Optional storedValues?: string[]

    An array of attribute paths that will be stored in the index but can not be used for index lookups or sorting but can avoid full document lookups.

  • Optional unique?: boolean

    If set to true, a unique index will be created.

    Default: false

Settings

Theme