Options
All
  • Public
  • Public/Protected
  • All
Menu

Database's table index options.

Hierarchy

  • TableIndexOptions

Index

Properties

columnNames

columnNames: string[]

Columns included in this index.

Optional isFulltext

isFulltext: undefined | true | false

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

Optional isSpatial

isSpatial: 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 isUnique

isUnique: undefined | true | false

Indicates if this index is unique.

Optional name

name: undefined | string

Constraint name.

Optional where

where: undefined | string

Index filter condition.

Generated using TypeDoc