# Class: TableConstraintDefinition

Defined in: packages/core/src/models/CreateTableQuery.ts:101

Table-level constraint definition.

Extends

• SqlComponent

Constructors

Constructor

new TableConstraintDefinition(params): TableConstraintDefinition

Defined in: packages/core/src/models/CreateTableQuery.ts:112

Parameters

params

kind

TableConstraintKind

constraintName?

IdentifierString

columns?

IdentifierString[] | null

reference?

ReferenceDefinition

checkExpression?

ValueComponent

rawClause?

RawString

deferrable?

ConstraintDeferrability

initially?

ConstraintInitially

Returns

TableConstraintDefinition

Overrides

SqlComponent.constructor

Properties

kind

static kind: symbol

Defined in: packages/core/src/models/CreateTableQuery.ts:102

Overrides

SqlComponent.kind

---

kind

kind: TableConstraintKind

Defined in: packages/core/src/models/CreateTableQuery.ts:103

---

constraintName?

optional constraintName: IdentifierString

Defined in: packages/core/src/models/CreateTableQuery.ts:104

---

columns

columns: IdentifierString[] | null

Defined in: packages/core/src/models/CreateTableQuery.ts:105

---

reference?

optional reference: ReferenceDefinition

Defined in: packages/core/src/models/CreateTableQuery.ts:106

---

checkExpression?

optional checkExpression: ValueComponent

Defined in: packages/core/src/models/CreateTableQuery.ts:107

---

rawClause?

optional rawClause: RawString

Defined in: packages/core/src/models/CreateTableQuery.ts:108

---

deferrable

deferrable: ConstraintDeferrability

Defined in: packages/core/src/models/CreateTableQuery.ts:109

---

initially

initially: ConstraintInitially

Defined in: packages/core/src/models/CreateTableQuery.ts:110

---

comments

comments: string[] | null = null

Defined in: packages/core/src/models/SqlComponent.ts:29

Inherited from

SqlComponent.comments

---

positionedComments

positionedComments: PositionedComment[] | null = null

Defined in: packages/core/src/models/SqlComponent.ts:32

Inherited from

SqlComponent.positionedComments

Methods

getKind()

getKind(): symbol

Defined in: packages/core/src/models/SqlComponent.ts:15

Returns

symbol

Inherited from

SqlComponent.getKind

---

accept()

accept<T&gt;(visitor): T

Defined in: packages/core/src/models/SqlComponent.ts:19

Type Parameters

T

T

Parameters

visitor

SqlComponentVisitor<T&gt;

Returns

T

Inherited from

SqlComponent.accept

---

toSqlString()

toSqlString(formatter): string

Defined in: packages/core/src/models/SqlComponent.ts:23

Parameters

formatter

SqlComponentVisitor<string&gt;

Returns

string

Inherited from

SqlComponent.toSqlString

---

addPositionedComments()

addPositionedComments(position, comments): void

Defined in: packages/core/src/models/SqlComponent.ts:37

Add comments at a specific position

Parameters

position

"before" | "after"

comments

string[]

Returns

void

Inherited from

SqlComponent.addPositionedComments

---

getPositionedComments()

getPositionedComments(position): string[]

Defined in: packages/core/src/models/SqlComponent.ts:56

Get comments for a specific position

Parameters

position

"before" | "after"

Returns

string[]

Inherited from

SqlComponent.getPositionedComments

---

getAllPositionedComments()

getAllPositionedComments(): string[]

Defined in: packages/core/src/models/SqlComponent.ts:66

Get all positioned comments as a flat array in order (before, after)

Returns

string[]

Inherited from

SqlComponent.getAllPositionedComments