Version: Next

UniqueOptions <T, H>

Hierarchy

BaseOptions<T, H>
- UniqueOptions

Index

Properties

columns
deferMode
disabled
expression
fillFactor
include
name
options
properties

Properties

optionalinheritedcolumns

columns?: IndexColumnOptions[]

Advanced column options for the index. When specified, allows fine-grained control over each column in the index including sort order, nulls ordering, prefix length, and collation. If both columns and properties are specified, columns takes precedence for index creation.

optionaldeferMode

deferMode?: DeferMode | immediate | deferred

optionaldisabled

disabled?: boolean

Whether the index is disabled (MSSQL only). A disabled index is not used for query planning and is not maintained on writes. It can be re-enabled later using ALTER INDEX ... REBUILD.

optionalinheritedexpression

expression?: string | (T extends EntityClass<P> ? IndexCallback<P> : IndexCallback<T>)

optionalinheritedfillFactor

fillFactor?: number

Fill factor for the index as a percentage 0-100 (PostgreSQL, MSSQL).

optionalinheritedinclude

include?: T extends EntityClass<P> ? Properties<P, H> : Properties<T, H>

Columns to include in the index but not as part of the key (PostgreSQL, MSSQL). These columns are stored in the leaf level of the index but not used for searching.

optionalinheritedname

name?: string

optionalinheritedoptions

options?: Dictionary

optionalinheritedproperties

properties?: T extends EntityClass<P> ? Properties<P, H> : Properties<T, H>