Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IndexOptions

Hierarchy

Index

Properties

concurrently?: boolean

PostgreSQL will build the index without taking any write locks. Postgres only.

default

false

fields?: (string | Literal | Fn | IndexField)[]

The fields to index.

name?: string

The name of the index. Defaults to model name + _ + fields concatenated

operator?: string

Index operator type. Postgres only

parser?: null | string

For FULLTEXT columns set your parser

prefix?: string

Prefix to append to the index name.

type?: IndexType

Index type. Only used by mysql. One of UNIQUE, FULLTEXT and SPATIAL

unique?: boolean

Should the index by unique? Can also be triggered by setting type to UNIQUE

default

false

using?: string

The method to create the index by (USING statement in SQL). BTREE and HASH are supported by mysql and postgres. Postgres additionally supports GIST, SPGIST, BRIN and GIN.

where?: WhereOptions<any>

Optional where parameter for index. Can be used to limit the index to certain rows.

Generated using TypeDoc