Function: Unique()

Unique(): PropertyDecorator

Defined in: src/decorators/UniqueDecorator.ts:18

Property decorator that enforces a UNIQUE constraint on the mapped database column.

DDL generation emits a UNIQUE INDEX on this column across all supported providers. For composite unique constraints (unique across multiple columns together), use the @Index({ unique: true, columns: ['col1', 'col2'] }) decorator instead.

Returns

PropertyDecorator

Usecase

Email addresses, usernames, slugs, and other naturally unique scalar fields.

Example

@Unique()
@Column({ maxLength: 255 })
email!: string;