-
-
Notifications
You must be signed in to change notification settings - Fork 528
/
SchemaGenerator.ts
605 lines (482 loc) · 22 KB
/
SchemaGenerator.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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
import type { Knex } from 'knex';
import type { Dictionary, EntityMetadata, MikroORM } from '@mikro-orm/core';
import { AbstractSchemaGenerator, Utils } from '@mikro-orm/core';
import type { Check, ForeignKey, Index, SchemaDifference, TableDifference } from '../typings';
import { DatabaseSchema } from './DatabaseSchema';
import type { DatabaseTable } from './DatabaseTable';
import type { AbstractSqlDriver } from '../AbstractSqlDriver';
import { SchemaComparator } from './SchemaComparator';
/**
* Should be renamed to `SqlSchemaGenerator` in v6
*/
export class SchemaGenerator extends AbstractSchemaGenerator<AbstractSqlDriver> {
private readonly helper = this.platform.getSchemaHelper()!;
private readonly options = this.config.get('schemaGenerator');
protected lastEnsuredDatabase?: string;
static register(orm: MikroORM): void {
orm.config.registerExtension('@mikro-orm/schema-generator', new SchemaGenerator(orm.em));
}
/** @deprecated use `dropSchema` and `createSchema` commands respectively */
async generate(): Promise<string> {
const [dropSchema, createSchema] = await Promise.all([
this.getDropSchemaSQL({ wrap: false }),
this.getCreateSchemaSQL({ wrap: false }),
]);
return this.wrapSchema(dropSchema + createSchema);
}
async createSchema(options?: { wrap?: boolean; schema?: string }): Promise<void> {
await this.ensureDatabase();
const sql = await this.getCreateSchemaSQL(options);
await this.execute(sql);
}
/**
* Returns true if the database was created.
*/
async ensureDatabase(): Promise<boolean> {
const dbName = this.config.get('dbName')!;
if (this.lastEnsuredDatabase === dbName) {
return true;
}
const exists = await this.helper.databaseExists(this.connection, dbName);
this.lastEnsuredDatabase = dbName;
if (!exists) {
this.config.set('dbName', this.helper.getManagementDbName());
await this.driver.reconnect();
await this.createDatabase(dbName);
this.config.set('dbName', dbName);
await this.driver.reconnect();
return true;
}
return false;
}
getTargetSchema(schema?: string): DatabaseSchema {
const metadata = this.getOrderedMetadata(schema);
const schemaName = schema ?? this.config.get('schema') ?? this.platform.getDefaultSchemaName();
return DatabaseSchema.fromMetadata(metadata, this.platform, this.config, schemaName);
}
async getCreateSchemaSQL(options: { wrap?: boolean; schema?: string } = {}): Promise<string> {
const wrap = options.wrap ?? this.options.disableForeignKeys;
const toSchema = this.getTargetSchema(options.schema);
let ret = '';
for (const namespace of toSchema.getNamespaces()) {
if (namespace === this.platform.getDefaultSchemaName()) {
continue;
}
ret += await this.dump(this.knex.schema.createSchemaIfNotExists(namespace));
}
for (const tableDef of toSchema.getTables()) {
ret += await this.dump(this.createTable(tableDef));
}
for (const tableDef of toSchema.getTables()) {
ret += await this.dump(this.createSchemaBuilder(tableDef.schema).alterTable(tableDef.name, table => this.createForeignKeys(table, tableDef, options.schema)));
}
return this.wrapSchema(ret, { wrap });
}
async dropSchema(options: { wrap?: boolean; dropMigrationsTable?: boolean; dropDb?: boolean; schema?: string } = {}): Promise<void> {
if (options.dropDb) {
const name = this.config.get('dbName')!;
return this.dropDatabase(name);
}
const sql = await this.getDropSchemaSQL(options);
await this.execute(sql);
}
async clearDatabase(options?: { schema?: string; truncate?: boolean }): Promise<void> {
// truncate by default, so no value is considered as true
/* istanbul ignore if */
if (options?.truncate === false) {
return super.clearDatabase(options);
}
await this.execute(this.helper.disableForeignKeysSQL());
for (const meta of this.getOrderedMetadata(options?.schema).reverse()) {
await this.driver.createQueryBuilder(meta.className, this.em?.getTransactionContext(), 'write', false)
.withSchema(options?.schema)
.truncate();
}
await this.execute(this.helper.enableForeignKeysSQL());
if (this.em) {
const allowGlobalContext = this.config.get('allowGlobalContext');
this.config.set('allowGlobalContext', true);
this.em.clear();
this.config.set('allowGlobalContext', allowGlobalContext);
}
}
async getDropSchemaSQL(options: { wrap?: boolean; dropMigrationsTable?: boolean; schema?: string } = {}): Promise<string> {
await this.ensureDatabase();
const wrap = options.wrap ?? this.options.disableForeignKeys;
const metadata = this.getOrderedMetadata(options.schema).reverse();
const schema = await DatabaseSchema.create(this.connection, this.platform, this.config, options.schema);
let ret = '';
// remove FKs explicitly if we can't use cascading statement and we don't disable FK checks (we need this for circular relations)
for (const meta of metadata) {
const table = schema.getTable(meta.tableName);
if (!this.platform.usesCascadeStatement() && table && !wrap) {
for (const fk of Object.values(table.getForeignKeys())) {
const builder = this.createSchemaBuilder(table.schema).alterTable(table.name, tbl => {
tbl.dropForeign(fk.columnNames, fk.constraintName);
});
ret += await this.dump(builder, '\n');
}
}
}
for (const meta of metadata) {
ret += await this.dump(this.dropTable(meta.collection, this.getSchemaName(meta, options)), '\n');
}
if (options.dropMigrationsTable) {
ret += await this.dump(this.dropTable(this.config.get('migrations').tableName!, this.config.get('schema')), '\n');
}
return this.wrapSchema(ret + '\n', { wrap });
}
private getSchemaName(meta: EntityMetadata, options: { schema?: string }): string | undefined {
const schemaName = options.schema ?? this.config.get('schema');
/* istanbul ignore next */
return meta.schema && meta.schema === '*' ? schemaName : (meta.schema ?? schemaName);
}
async updateSchema(options: { wrap?: boolean; safe?: boolean; dropTables?: boolean; fromSchema?: DatabaseSchema; schema?: string } = {}): Promise<void> {
const sql = await this.getUpdateSchemaSQL(options);
await this.execute(sql);
}
async getUpdateSchemaSQL(options: { wrap?: boolean; safe?: boolean; dropTables?: boolean; fromSchema?: DatabaseSchema; schema?: string } = {}): Promise<string> {
await this.ensureDatabase();
const { fromSchema, toSchema } = await this.prepareSchemaForComparison(options);
const comparator = new SchemaComparator(this.platform);
const diffUp = comparator.compare(fromSchema, toSchema);
return this.diffToSQL(diffUp, options);
}
async getUpdateSchemaMigrationSQL(options: { wrap?: boolean; safe?: boolean; dropTables?: boolean; fromSchema?: DatabaseSchema; schema?: string } = {}): Promise<{ up: string; down: string }> {
await this.ensureDatabase();
const { fromSchema, toSchema } = await this.prepareSchemaForComparison(options);
const comparator = new SchemaComparator(this.platform);
const diffUp = comparator.compare(fromSchema, toSchema);
const diffDown = comparator.compare(toSchema, fromSchema);
return {
up: await this.diffToSQL(diffUp, options),
down: this.platform.supportsDownMigrations() ? await this.diffToSQL(diffDown, options) : '',
};
}
private async prepareSchemaForComparison(options: { wrap?: boolean; safe?: boolean; dropTables?: boolean; fromSchema?: DatabaseSchema; schema?: string }) {
options.wrap ??= this.options.disableForeignKeys;
options.safe ??= false;
options.dropTables ??= true;
const toSchema = this.getTargetSchema(options.schema);
const fromSchema = options.fromSchema ?? await DatabaseSchema.create(this.connection, this.platform, this.config, options.schema);
const wildcardSchemaTables = Object.values(this.metadata.getAll()).filter(meta => meta.schema === '*').map(meta => meta.tableName);
fromSchema.prune(options.schema, wildcardSchemaTables);
toSchema.prune(options.schema, wildcardSchemaTables);
return { fromSchema, toSchema };
}
async diffToSQL(schemaDiff: SchemaDifference, options: { wrap?: boolean; safe?: boolean; dropTables?: boolean; schema?: string }): Promise<string> {
let ret = '';
if (this.platform.supportsSchemas()) {
for (const newNamespace of schemaDiff.newNamespaces) {
// schema might already exist, e.g. explicit usage of `public` in postgres
ret += await this.dump(this.knex.schema.createSchemaIfNotExists(newNamespace));
}
}
if (!options.safe) {
for (const orphanedForeignKey of schemaDiff.orphanedForeignKeys) {
const [schemaName, tableName] = this.splitTableName(orphanedForeignKey.localTableName);
ret += await this.dump(this.createSchemaBuilder(schemaName).alterTable(tableName, table => {
return table.dropForeign(orphanedForeignKey.columnNames, orphanedForeignKey.constraintName);
}));
}
}
for (const newTable of Object.values(schemaDiff.newTables)) {
ret += await this.dump(this.createTable(newTable));
}
for (const newTable of Object.values(schemaDiff.newTables)) {
ret += await this.dump(this.createSchemaBuilder(newTable.schema).alterTable(newTable.name, table => {
this.createForeignKeys(table, newTable, options.schema);
}));
}
if (options.dropTables && !options.safe) {
for (const table of Object.values(schemaDiff.removedTables)) {
ret += await this.dump(this.dropTable(table.name, table.schema));
}
}
for (const changedTable of Object.values(schemaDiff.changedTables)) {
for (const builder of this.preAlterTable(changedTable, options.safe!)) {
ret += await this.dump(builder);
}
}
for (const changedTable of Object.values(schemaDiff.changedTables)) {
for (const builder of this.alterTable(changedTable, options.safe!)) {
ret += await this.dump(builder);
}
}
if (options.dropTables && !options.safe) {
for (const removedNamespace of schemaDiff.removedNamespaces) {
ret += await this.dump(this.knex.schema.dropSchema(removedNamespace));
}
}
return this.wrapSchema(ret, options);
}
private getReferencedTableName(referencedTableName: string, schema?: string) {
const [schemaName, tableName] = this.splitTableName(referencedTableName);
schema = schemaName ?? schema ?? this.config.get('schema');
/* istanbul ignore next */
if (schema && schemaName === '*') {
return `${schema}.${referencedTableName.replace(/^\*\./, '')}`;
}
if (schemaName === this.platform.getDefaultSchemaName()) {
return tableName;
}
return `${schemaName}.${tableName}`;
}
private createForeignKey(table: Knex.CreateTableBuilder, foreignKey: ForeignKey, schema?: string) {
if (!this.options.createForeignKeyConstraints) {
return;
}
const builder = table
.foreign(foreignKey.columnNames, foreignKey.constraintName)
.references(foreignKey.referencedColumnNames)
.inTable(this.getReferencedTableName(foreignKey.referencedTableName, schema))
.withKeyName(foreignKey.constraintName);
if (foreignKey.updateRule) {
builder.onUpdate(foreignKey.updateRule);
}
if (foreignKey.deleteRule) {
builder.onDelete(foreignKey.deleteRule);
}
}
/**
* We need to drop foreign keys first for all tables to allow dropping PK constraints.
*/
private preAlterTable(diff: TableDifference, safe: boolean): Knex.SchemaBuilder[] {
const ret: Knex.SchemaBuilder[] = [];
const push = (sql: string) => sql ? ret.push(this.knex.schema.raw(sql)) : undefined;
push(this.helper.getPreAlterTable(diff, safe));
const [schemaName, tableName] = this.splitTableName(diff.name);
ret.push(this.createSchemaBuilder(schemaName).alterTable(tableName, table => {
for (const foreignKey of Object.values(diff.removedForeignKeys)) {
table.dropForeign(foreignKey.columnNames, foreignKey.constraintName);
}
for (const foreignKey of Object.values(diff.changedForeignKeys)) {
table.dropForeign(foreignKey.columnNames, foreignKey.constraintName);
}
}));
return ret;
}
private splitTableName(name: string): [string | undefined, string] {
const parts = name.split('.');
const tableName = parts.pop()!;
const schemaName = parts.pop();
return [schemaName, tableName];
}
private alterTable(diff: TableDifference, safe: boolean): Knex.SchemaBuilder[] {
const ret: Knex.SchemaBuilder[] = [];
const [schemaName, tableName] = this.splitTableName(diff.name);
ret.push(this.createSchemaBuilder(schemaName).alterTable(tableName, table => {
for (const index of Object.values(diff.removedIndexes)) {
this.dropIndex(table, index);
}
for (const index of Object.values(diff.changedIndexes)) {
this.dropIndex(table, index);
}
for (const check of Object.values(diff.removedChecks)) {
this.dropCheck(table, check);
}
for (const check of Object.values(diff.changedChecks)) {
this.dropCheck(table, check);
}
for (const column of Object.values(diff.addedColumns)) {
const col = this.helper.createTableColumn(table, column, diff.fromTable);
this.helper.configureColumn(column, col, this.knex);
const foreignKey = Object.values(diff.addedForeignKeys).find(fk => fk.columnNames.length === 1 && fk.columnNames[0] === column.name);
if (foreignKey && this.options.createForeignKeyConstraints) {
delete diff.addedForeignKeys[foreignKey.constraintName];
col.references(foreignKey.referencedColumnNames[0])
.inTable(this.getReferencedTableName(foreignKey.referencedTableName))
.withKeyName(foreignKey.constraintName)
.onUpdate(foreignKey.updateRule!)
.onDelete(foreignKey.deleteRule!);
}
}
/* istanbul ignore else */
if (!safe) {
for (const column of Object.values(diff.removedColumns)) {
table.dropColumn(column.name);
}
}
for (const { column, changedProperties } of Object.values(diff.changedColumns)) {
if (changedProperties.size === 1 && changedProperties.has('comment')) {
continue;
}
const col = this.helper.createTableColumn(table, column, diff.fromTable, changedProperties).alter();
this.helper.configureColumn(column, col, this.knex, changedProperties);
}
for (const { column } of Object.values(diff.changedColumns).filter(diff => diff.changedProperties.has('autoincrement'))) {
this.helper.pushTableQuery(table, this.helper.getAlterColumnAutoincrement(tableName, column));
}
for (const { column, changedProperties } of Object.values(diff.changedColumns).filter(diff => diff.changedProperties.has('comment'))) {
if (['type', 'nullable', 'autoincrement', 'unsigned', 'default', 'enumItems'].some(t => changedProperties.has(t))) {
continue; // will be handled via knex
}
this.helper.pushTableQuery(table, this.helper.getChangeColumnCommentSQL(tableName, column));
}
for (const [oldColumnName, column] of Object.entries(diff.renamedColumns)) {
this.helper.pushTableQuery(table, this.helper.getRenameColumnSQL(tableName, oldColumnName, column, schemaName));
}
for (const foreignKey of Object.values(diff.addedForeignKeys)) {
this.createForeignKey(table, foreignKey);
}
for (const foreignKey of Object.values(diff.changedForeignKeys)) {
this.createForeignKey(table, foreignKey);
}
for (const index of Object.values(diff.addedIndexes)) {
this.createIndex(table, index, diff.toTable);
}
for (const index of Object.values(diff.changedIndexes)) {
this.createIndex(table, index, diff.toTable, true);
}
for (const [oldIndexName, index] of Object.entries(diff.renamedIndexes)) {
if (index.unique) {
this.dropIndex(table, index, oldIndexName);
this.createIndex(table, index, diff.toTable);
} else {
this.helper.pushTableQuery(table, this.helper.getRenameIndexSQL(diff.name, index, oldIndexName));
}
}
for (const check of Object.values(diff.addedChecks)) {
this.createCheck(table, check);
}
for (const check of Object.values(diff.changedChecks)) {
this.createCheck(table, check);
}
if ('changedComment' in diff) {
const comment = diff.changedComment ? this.platform.quoteValue(diff.changedComment).replace(/^'|'$/g, '') : '';
table.comment(comment);
}
}));
return ret;
}
/**
* creates new database and connects to it
*/
async createDatabase(name: string): Promise<void> {
await this.driver.execute(this.helper.getCreateDatabaseSQL('' + this.knex.ref(name)));
this.config.set('dbName', name);
await this.driver.reconnect();
}
async dropDatabase(name: string): Promise<void> {
this.config.set('dbName', this.helper.getManagementDbName());
await this.driver.reconnect();
await this.driver.execute(this.helper.getDropDatabaseSQL('' + this.knex.ref(name)));
}
async execute(sql: string, options: { wrap?: boolean } = {}) {
options.wrap ??= false;
const lines = this.wrapSchema(sql, options).split('\n').filter(i => i.trim());
if (lines.length === 0) {
return;
}
if (this.platform.supportsMultipleStatements()) {
const query = lines.join('\n');
return void await this.driver.execute(query);
}
await Utils.runSerial(lines, line => this.driver.execute(line));
}
private wrapSchema(sql: string, options: { wrap?: boolean } = {}): string {
options.wrap ??= this.options.disableForeignKeys;
if (!options.wrap || sql.trim() === '') {
return sql;
}
let ret = this.helper.getSchemaBeginning(this.config.get('charset'));
ret += sql;
ret += this.helper.getSchemaEnd();
return ret;
}
private createSchemaBuilder(schema?: string): Knex.SchemaBuilder {
const builder = this.knex.schema;
if (schema && schema !== this.platform.getDefaultSchemaName()) {
builder.withSchema(schema);
}
return builder;
}
private createTable(tableDef: DatabaseTable): Knex.SchemaBuilder {
return this.createSchemaBuilder(tableDef.schema).createTable(tableDef.name, table => {
tableDef.getColumns().forEach(column => {
const col = this.helper.createTableColumn(table, column, tableDef);
this.helper.configureColumn(column, col, this.knex);
});
for (const index of tableDef.getIndexes()) {
const createPrimary = !tableDef.getColumns().some(c => c.autoincrement && c.primary) || this.helper.hasNonDefaultPrimaryKeyName(tableDef);
this.createIndex(table, index, tableDef, createPrimary);
}
for (const check of tableDef.getChecks()) {
this.createCheck(table, check);
}
if (tableDef.comment) {
const comment = this.platform.quoteValue(tableDef.comment).replace(/^'|'$/g, '');
table.comment(comment);
}
if (!this.helper.supportsSchemaConstraints()) {
for (const fk of Object.values(tableDef.getForeignKeys())) {
this.createForeignKey(table, fk);
}
}
this.helper.finalizeTable(table, this.config.get('charset'), this.config.get('collate'));
});
}
private createIndex(table: Knex.CreateTableBuilder, index: Index, tableDef: DatabaseTable, createPrimary = false) {
if (index.primary && !createPrimary) {
return;
}
if (index.primary) {
const keyName = this.helper.hasNonDefaultPrimaryKeyName(tableDef) ? index.keyName : undefined;
table.primary(index.columnNames, keyName);
} else if (index.unique) {
table.unique(index.columnNames, { indexName: index.keyName });
} else if (index.expression) {
this.helper.pushTableQuery(table, index.expression);
} else if (index.type === 'fulltext') {
const columns = index.columnNames.map(name => ({ name, type: tableDef.getColumn(name)!.type }));
if (this.platform.supportsCreatingFullTextIndex()) {
this.helper.pushTableQuery(table, this.platform.getFullTextIndexExpression(index.keyName, tableDef.schema, tableDef.name, columns));
}
} else {
table.index(index.columnNames, index.keyName, index.type as Dictionary);
}
}
private dropIndex(table: Knex.CreateTableBuilder, index: Index, oldIndexName = index.keyName) {
if (index.primary) {
table.dropPrimary(oldIndexName);
} else if (index.unique) {
table.dropUnique(index.columnNames, oldIndexName);
} else {
table.dropIndex(index.columnNames, oldIndexName);
}
}
private createCheck(table: Knex.CreateTableBuilder, check: Check) {
table.check(check.expression as string, {}, check.name);
}
private dropCheck(table: Knex.CreateTableBuilder, check: Check) {
table.dropChecks(check.name);
}
private dropTable(name: string, schema?: string): Knex.SchemaBuilder {
let builder = this.createSchemaBuilder(schema).dropTableIfExists(name);
if (this.platform.usesCascadeStatement()) {
builder = this.knex.schema.raw(builder.toQuery() + ' cascade');
}
return builder;
}
private createForeignKeys(table: Knex.CreateTableBuilder, tableDef: DatabaseTable, schema?: string): void {
if (!this.helper.supportsSchemaConstraints()) {
return;
}
for (const fk of Object.values(tableDef.getForeignKeys())) {
this.createForeignKey(table, fk, schema);
}
}
private async dump(builder: Knex.SchemaBuilder, append = '\n\n'): Promise<string> {
const sql = await builder.generateDdlCommands();
const queries = [...sql.pre, ...sql.sql, ...sql.post];
if (queries.length === 0) {
return '';
}
const dump = `${queries.map(q => typeof q === 'object' ? (q as Dictionary).sql : q).join(';\n')};${append}`;
const tmp = dump.replace(/pragma table_.+/ig, '').replace(/\n\n+/g, '\n').trim();
return tmp ? tmp + append : '';
}
private get knex() {
return this.connection.getKnex();
}
}