/
TableForeignKeyOptions.ts
47 lines (39 loc) · 1.14 KB
/
TableForeignKeyOptions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/**
* Foreign key options.
*/
export interface TableForeignKeyOptions {
// -------------------------------------------------------------------------
// Public Properties
// -------------------------------------------------------------------------
/**
* Name of the table which contains this foreign key.
*/
name?: string;
/**
* Column names which included by this foreign key.
*/
columnNames: string[];
/**
* Table referenced in the foreign key.
*/
referencedTableName: string;
/**
* Column names which included by this foreign key.
*/
referencedColumnNames: string[];
/**
* "ON DELETE" of this foreign key, e.g. what action database should perform when
* referenced stuff is being deleted.
*/
onDelete?: string;
/**
* "ON UPDATE" of this foreign key, e.g. what action database should perform when
* referenced stuff is being updated.
*/
onUpdate?: string;
/**
* Set this foreign key constraint as "DEFERRABLE" e.g. check constraints at start
* or at the end of a transaction
*/
deferrable?: string;
}