Class DbIndex

Creates a new index instance which is needed to create an database index.

Hierarchy

  • DbIndex

Constructors

constructor

Properties

keys unique ASC DESC GEO

Accessors

isCompound isUnique

Methods

hasKey toJSON fromJSON

Constructors

constructor

  • Parameters

    • keys: string | IndexSpec | {
          [name: string]: string;
      }

      The name of the field which will be used for the index, an object of an field and index type combination or an array of objects to create an compound index

    • Optional unique: boolean

      Indicates if the index will be unique

    Returns DbIndex

Properties

keys

keys: IndexSpec

An array of mappings from field to index type which are parts of this index/compound index

unique

unique: boolean

Static Readonly ASC

ASC: "asc" = 'asc'

Static Readonly DESC

DESC: "desc" = 'desc'

Static Readonly GEO

GEO: "geo"

Accessors

isCompound

  • get isCompound(): boolean

  • Indicates if this index is a compound index of multiple attributes

    Returns boolean

isUnique

  • get isUnique(): boolean

  • Indicates if this index is an unique index

    Returns boolean

Methods

hasKey

  • Indicates if this index is for the given field or includes it in a compound index

    Returns

    true if the index contains this field

    Parameters

    • name: string

      The name of the field to check for

    Returns boolean

toJSON

  • Returns a JSON representation of the Index object

    Returns

    A Json of this Index object

    Returns JsonMap

Static fromJSON

  • Returns DbIndex Object created from the given JSON

    Returns

    Parameters

    Returns DbIndex

Settings

Member Visibility

Theme

Generated using TypeDoc