/
TableColumn.ts
192 lines (163 loc) · 5.46 KB
/
TableColumn.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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
import {TableColumnOptions} from "../options/TableColumnOptions";
/**
* Table's columns in the database represented in this class.
*/
export class TableColumn {
// -------------------------------------------------------------------------
// Public Properties
// -------------------------------------------------------------------------
/**
* Column name.
*/
name: string;
/**
* Column type.
*/
type: string;
/**
* Column's default value.
*/
default?: any;
/**
* ON UPDATE trigger. Works only for MySQL.
*/
onUpdate?: string;
/**
* Indicates if column is NULL, or is NOT NULL in the database.
*/
isNullable: boolean = false;
/**
* Indicates if column is auto-generated sequence.
*/
isGenerated: boolean = false;
/**
* Specifies generation strategy if this column will use auto increment.
*/
generationStrategy?: "uuid"|"increment";
/**
* Indicates if column is a primary key.
*/
isPrimary: boolean = false;
/**
* Indicates if column has unique value.
*/
isUnique: boolean = false;
/**
* Indicates if column stores array.
*/
isArray: boolean = false;
/**
* Column's comment.
*/
comment?: string;
/**
* Column type's length. Used only on some column types.
* For example type = "string" and length = "100" means that ORM will create a column with type varchar(100).
*/
length: string = "";
/**
* Column type's display width. Used only on some column types in MySQL.
* For example, INT(4) specifies an INT with a display width of four digits.
*/
width?: number;
/**
* Defines column character set.
*/
charset?: string;
/**
* Defines column collation.
*/
collation?: string;
/**
* The precision for a decimal (exact numeric) column (applies only for decimal column), which is the maximum
* number of digits that are stored for the values.
*/
precision?: number|null;
/**
* The scale for a decimal (exact numeric) column (applies only for decimal column), which represents the number
* of digits to the right of the decimal point and must not be greater than precision.
*/
scale?: number;
/**
* Puts ZEROFILL attribute on to numeric column. Works only for MySQL.
* If you specify ZEROFILL for a numeric column, MySQL automatically adds the UNSIGNED attribute to the column
*/
zerofill: boolean = false;
/**
* Puts UNSIGNED attribute on to numeric column. Works only for MySQL.
*/
unsigned: boolean = false;
/**
* Array of possible enumerated values.
*/
enum?: any[];
/**
* Generated column expression. Supports only in MySQL.
*/
asExpression?: string;
/**
* Generated column type. Supports only in MySQL.
*/
generatedType?: "VIRTUAL"|"STORED";
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
constructor(options?: TableColumnOptions) {
if (options) {
this.name = options.name;
this.type = options.type || "";
this.length = options.length || "";
this.width = options.width;
this.charset = options.charset;
this.collation = options.collation;
this.precision = options.precision;
this.scale = options.scale;
this.zerofill = options.zerofill || false;
this.unsigned = this.zerofill ? true : (options.unsigned || false);
this.default = options.default;
this.onUpdate = options.onUpdate;
this.isNullable = options.isNullable || false;
this.isGenerated = options.isGenerated || false;
this.generationStrategy = options.generationStrategy;
this.isPrimary = options.isPrimary || false;
this.isUnique = options.isUnique || false;
this.isArray = options.isArray || false;
this.comment = options.comment;
this.enum = options.enum;
this.asExpression = options.asExpression;
this.generatedType = options.generatedType;
}
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Clones this column to a new column with exact same properties as this column has.
*/
clone(): TableColumn {
return new TableColumn(<TableColumnOptions>{
name: this.name,
type: this.type,
length: this.length,
width: this.width,
charset: this.charset,
collation: this.collation,
precision: this.precision,
scale: this.scale,
zerofill: this.zerofill,
unsigned: this.unsigned,
enum: this.enum,
asExpression: this.asExpression,
generatedType: this.generatedType,
default: this.default,
onUpdate: this.onUpdate,
isNullable: this.isNullable,
isGenerated: this.isGenerated,
generationStrategy: this.generationStrategy,
isPrimary: this.isPrimary,
isUnique: this.isUnique,
isArray: this.isArray,
comment: this.comment
});
}
}