Class ForeignKey

Hierarchy

ForeignKey

Index

Constructors

Properties

foreign foreignColumns localColumns name onDelete onUpdate table

Methods

addReference getColumnMapping getName valueOf

Constructors

constructor

new ForeignKey(table: Table, name: string, foreign: Table): ForeignKey
Parameters
- table: Table
- name: string
- foreign: Table
Returns ForeignKey
- Defined in packages/sql/src/schema/table.ts:255

Properties

foreign

foreign: Table

foreignColumns

foreignColumns: Column[] = []

localColumns

localColumns: Column[] = []

name

name: string

onDelete

onDelete: ForeignKeyAction = 'CASCADE'

onUpdate

onUpdate: ForeignKeyAction = 'CASCADE'

table

table: Table

Methods

addReference

addReference(localColumnName: string, foreignColumnName: string): void
Parameters
- localColumnName: string
- foreignColumnName: string
Returns void
- Defined in packages/sql/src/schema/table.ts:269

getColumnMapping

getColumnMapping(): [from: Column, to: Column][]
Returns [from: Column, to: Column][]
- Defined in packages/sql/src/schema/table.ts:274

getName

getName(): string
Returns string
- Defined in packages/sql/src/schema/table.ts:258

valueOf

valueOf(): string
Returns string
- Defined in packages/sql/src/schema/table.ts:282

Generated using TypeDoc