IndexMetadataArgs

Arguments for IndexMetadata class.

Hierarchy

IndexMetadataArgs

Index

Properties

Optional columns

columns: function | string[]

Columns combination to be used as index.

Optional fulltext

fulltext: undefined | true | false

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

Optional name

name: undefined | string

Index name.

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 synchronize

synchronize: undefined | true | false

Indicates if index must sync with database index.

target

target: Function | string

Class to which index is applied.

Optional unique

unique: undefined | true | false

Indicates if index must be unique or not.

Optional where

where: undefined | string

Index filter condition.