UniqueOptions <T, H>

Hierarchy

• BaseOptions<T, H>
  • UniqueOptions

Index

Properties

• columns
• deferMode
• disabled
• expression
• fillFactor
• include
• name
• options
• properties
• where

Properties

optionalinheritedcolumns

columns?: IndexColumnOptions[]

Inherited from BaseOptions.columns

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>)

Inherited from BaseOptions.expression

optionalinheritedfillFactor

fillFactor?: number

Inherited from BaseOptions.fillFactor

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

optionalinheritedinclude

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

Inherited from BaseOptions.include

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

Inherited from BaseOptions.name

optionalinheritedoptions

options?: Dictionary

Inherited from BaseOptions.options

optionalinheritedproperties

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

Inherited from BaseOptions.properties

optionalinheritedwhere

where?: string | FilterQuery<NoInfer<T> extends EntityClass<P> ? P : NoInfer<T>>

Inherited from BaseOptions.where

Predicate for partial indexes. Object form is a FilterQuery and is portable across SQL drivers and MongoDB; string form is a raw SQL fragment (SQL drivers only).

Native support: PostgreSQL, SQLite, MSSQL (WHERE), MongoDB (partialFilterExpression). MySQL 8.0.13+ / Oracle: emulated via CASE WHEN functional index (uniqueness only enforced where the predicate holds). MariaDB is not supported — it has no inline expression indexes; define a virtual generated column and index that instead.