Class UniqueConstraint

Table unique constraint for one or more columns

Hierarchy

Constraint
- UniqueConstraint

Index

Constructors

Properties

columns name? order type CONSTRAINT UNIQUE

Methods

add buildNameSql buildSql compareTo copy getColumns getName getOrder getType setOrder

Constructors

constructor

new UniqueConstraint(name?: string, ...columns: UserColumn[]): UniqueConstraint
Parameters
- Optional name: string
- Rest ...columns: UserColumn[]
Returns UniqueConstraint
Overrides Constraint.constructor
- Defined in lib/db/table/uniqueConstraint.ts:19

Properties

columns

columns: UserColumn[] = []

Columns included in the unique constraint

`Optional` name

name?: string

order

order: number = Number.MAX_SAFE_INTEGER

type

type: ConstraintType

`Static` CONSTRAINT

CONSTRAINT: string = 'CONSTRAINT'

Constraint keyword

`Static` UNIQUE

UNIQUE: string = 'UNIQUE'

Constraint keyword

Methods

add

add(...columns: UserColumn[]): void
Add columns
Parameters
- Rest ...columns: UserColumn[]
  
  columns
Returns void
- Defined in lib/db/table/uniqueConstraint.ts:54

buildNameSql

buildNameSql(): string
Build the name SQL

Returns
name SQL

Returns string
Inherited from Constraint.buildNameSql
- Defined in lib/db/table/constraint.ts:18

buildSql

buildSql(): string
Builds the sql

Returns string
Overrides Constraint.buildSql
- Defined in lib/db/table/uniqueConstraint.ts:27

compareTo

compareTo(constraint: Constraint): number
Parameters
- constraint: Constraint
Returns number
Inherited from Constraint.compareTo
- Defined in lib/db/table/constraint.ts:49

copy

copy(): UniqueConstraint
Inherit Doc

Returns UniqueConstraint
Overrides Constraint.copy
- Defined in lib/db/table/uniqueConstraint.ts:46

getColumns

getColumns(): UserColumn[]
Get the columns

Returns
columns

Returns UserColumn[]
- Defined in lib/db/table/uniqueConstraint.ts:65

getName

getName(): string
Returns string
Inherited from Constraint.getName
- Defined in lib/db/table/constraint.ts:37

getOrder

getOrder(order: number): number
Parameters
- order: number
Returns number
Inherited from Constraint.getOrder
- Defined in lib/db/table/constraint.ts:53

getType

getType(): ConstraintType
Returns ConstraintType
Inherited from Constraint.getType
- Defined in lib/db/table/constraint.ts:41

setOrder

setOrder(order: number): void
Parameters
- order: number
Returns void
Inherited from Constraint.setOrder
- Defined in lib/db/table/constraint.ts:45

Generated using TypeDoc