Interface IndexDefinition

An existing index as reported by the engine.

interface IndexDefinition {
    name: string;
    unique?: boolean;
    type?: string;
    using?: string;
    fields: string[];
    where?: string | WhereOptions;
    invisible?: boolean;
}

Index

Properties

name unique? type? using? fields where? invisible?

Properties

name

name: string

`Optional`unique

unique?: boolean

`Optional`type

type?: string

`Optional`using

using?: string

fields

fields: string[]

`Optional`where

where?: string | WhereOptions

See IndexOptions.where.

`Optional`invisible

invisible?: boolean

See IndexOptions.invisible.