Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes all index options.

Hierarchy

  • IndexOptions

Index

Properties

Optional fulltext

fulltext: undefined | true | false

The FULLTEXT modifier indexes the entire column and does not allow prefixing. Works only in MySQL.

Optional sparse

sparse: undefined | true | false

If true, the index only references documents with the specified field. These indexes use less space but behave differently in some situations (particularly sorts). This option is only supported for mongodb database.

Optional spatial

spatial: undefined | true | false

The SPATIAL modifier indexes the entire column and does not allow indexed columns to contain NULL values. Works only in MySQL.

Optional unique

unique: undefined | true | false

Indicates if this composite index must be unique or not.

Optional where

where: undefined | string

Index filter condition.

Generated using TypeDoc