# Class: ReferenceDefinition

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

Represents a REFERENCES clause definition that can be shared between column and table constraints.

Extends

• SqlComponent

Constructors

Constructor

new ReferenceDefinition(params): ReferenceDefinition

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

Parameters

params

targetTable

QualifiedName

columns?

IdentifierString[] | null

matchType?

MatchType

onDelete?

ReferentialAction | null

onUpdate?

ReferentialAction | null

deferrable?

ConstraintDeferrability

initially?

ConstraintInitially

Returns

ReferenceDefinition

Overrides

SqlComponent.constructor

Properties

kind

static kind: symbol

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

Overrides

SqlComponent.kind

---

targetTable

targetTable: QualifiedName

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

---

columns

columns: IdentifierString[] | null

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

---

matchType

matchType: MatchType

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

---

onDelete

onDelete: ReferentialAction | null

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

---

onUpdate

onUpdate: ReferentialAction | null

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

---

deferrable

deferrable: ConstraintDeferrability

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

---

initially

initially: ConstraintInitially

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

---

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