Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IndexMetadataArgs

Arguments for IndexMetadata class.

Hierarchy

  • IndexMetadataArgs

Index

Properties

Optional background

background: boolean

Builds the index in the background so that building an index an does not block other database activities. This option is only supported for mongodb database.

Optional columns

columns: function | string[]

Columns combination to be used as index.

Optional expireAfterSeconds

expireAfterSeconds: number

Specifies a time to live, in seconds. This option is only supported for mongodb database.

Optional fulltext

fulltext: boolean

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

Optional name

name: string

Index name.

Optional sparse

sparse: boolean

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: boolean

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

Optional synchronize

synchronize: boolean

Indicates if index must sync with database index.

target

target: Function | string

Class to which index is applied.

Optional unique

unique: boolean

Indicates if index must be unique or not.

Optional where

where: string

Index filter condition.

Generated using TypeDoc