Interface AttributeIndexOptions

interface AttributeIndexOptions {
    attribute?: Omit<IndexField, "name">;
    concurrently?: boolean;
    include?: Literal | (string | Literal)[];
    msg?: string;
    name?: string;
    operator?: string;
    parser?: null | string;
    prefix?: string;
    type?: IndexType;
    unique?: boolean;
    using?: string;
    where?: WhereOptions;
}

Hierarchy

Properties

attribute? concurrently? include? msg? name? operator? parser? prefix? type? unique? using? where?

Properties

Optionalattribute

attribute?: Omit<IndexField, "name">

Configures the options for this index attribute.

Optionalconcurrently

concurrently?: boolean

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

Default

false

Optionalinclude

include?: Literal | (string | Literal)[]

Non-key columns to be added to the lead level of the nonclustered index.

Optionalmsg

msg?: string

The message to display if the unique constraint is violated.

Optionalname

name?: string

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

Optionaloperator

operator?: string

Index operator type. Postgres only

Optionalparser

parser?: null | string

For FULLTEXT columns set your parser

Optionalprefix

prefix?: string

Prefix to append to the index name.

Optionaltype

type?: IndexType

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

Optionalunique

unique?: boolean

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

Default

false

Optionalusing

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.

Optionalwhere

where?: WhereOptions

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

Settings

Member Visibility

On This Page

Properties