forked from typeorm/typeorm
/
MysqlQueryRunner.ts
1728 lines (1464 loc) · 83.8 KB
/
MysqlQueryRunner.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
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {QueryRunner} from "../../query-runner/QueryRunner";
import {ObjectLiteral} from "../../common/ObjectLiteral";
import {TransactionAlreadyStartedError} from "../../error/TransactionAlreadyStartedError";
import {TransactionNotStartedError} from "../../error/TransactionNotStartedError";
import {TableColumn} from "../../schema-builder/table/TableColumn";
import {Table} from "../../schema-builder/table/Table";
import {TableForeignKey} from "../../schema-builder/table/TableForeignKey";
import {TableIndex} from "../../schema-builder/table/TableIndex";
import {QueryRunnerAlreadyReleasedError} from "../../error/QueryRunnerAlreadyReleasedError";
import {View} from "../../schema-builder/view/View";
import {Query} from "../Query";
import {MysqlDriver} from "./MysqlDriver";
import {ReadStream} from "../../platform/PlatformTools";
import {OrmUtils} from "../../util/OrmUtils";
import {QueryFailedError} from "../../error/QueryFailedError";
import {TableIndexOptions} from "../../schema-builder/options/TableIndexOptions";
import {TableUnique} from "../../schema-builder/table/TableUnique";
import {BaseQueryRunner} from "../../query-runner/BaseQueryRunner";
import {Broadcaster} from "../../subscriber/Broadcaster";
import {ColumnType, PromiseUtils} from "../../index";
import {TableCheck} from "../../schema-builder/table/TableCheck";
import {IsolationLevel} from "../types/IsolationLevel";
import {TableExclusion} from "../../schema-builder/table/TableExclusion";
import {VersionUtils} from "../../util/VersionUtils";
/**
* Runs queries on a single mysql database connection.
*/
export class MysqlQueryRunner extends BaseQueryRunner implements QueryRunner {
// -------------------------------------------------------------------------
// Public Implemented Properties
// -------------------------------------------------------------------------
/**
* Database driver used by connection.
*/
driver: MysqlDriver;
// -------------------------------------------------------------------------
// Protected Properties
// -------------------------------------------------------------------------
/**
* Promise used to obtain a database connection from a pool for a first time.
*/
protected databaseConnectionPromise: Promise<any>;
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
constructor(driver: MysqlDriver, mode: "master"|"slave" = "master") {
super();
this.driver = driver;
this.connection = driver.connection;
this.broadcaster = new Broadcaster(this);
this.mode = mode;
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Creates/uses database connection from the connection pool to perform further operations.
* Returns obtained database connection.
*/
connect(): Promise<any> {
if (this.databaseConnection)
return Promise.resolve(this.databaseConnection);
if (this.databaseConnectionPromise)
return this.databaseConnectionPromise;
if (this.mode === "slave" && this.driver.isReplicated) {
this.databaseConnectionPromise = this.driver.obtainSlaveConnection().then(connection => {
this.databaseConnection = connection;
return this.databaseConnection;
});
} else { // master
this.databaseConnectionPromise = this.driver.obtainMasterConnection().then(connection => {
this.databaseConnection = connection;
return this.databaseConnection;
});
}
return this.databaseConnectionPromise;
}
/**
* Releases used database connection.
* You cannot use query runner methods once its released.
*/
release(): Promise<void> {
this.isReleased = true;
if (this.databaseConnection)
this.databaseConnection.release();
return Promise.resolve();
}
/**
* Starts transaction on the current connection.
*/
async startTransaction(isolationLevel?: IsolationLevel): Promise<void> {
if (this.isTransactionActive)
throw new TransactionAlreadyStartedError();
this.isTransactionActive = true;
if (isolationLevel) {
await this.query("SET TRANSACTION ISOLATION LEVEL " + isolationLevel);
await this.query("START TRANSACTION");
} else {
await this.query("START TRANSACTION");
}
}
/**
* Commits transaction.
* Error will be thrown if transaction was not started.
*/
async commitTransaction(): Promise<void> {
if (!this.isTransactionActive)
throw new TransactionNotStartedError();
await this.query("COMMIT");
this.isTransactionActive = false;
}
/**
* Rollbacks transaction.
* Error will be thrown if transaction was not started.
*/
async rollbackTransaction(): Promise<void> {
if (!this.isTransactionActive)
throw new TransactionNotStartedError();
await this.query("ROLLBACK");
this.isTransactionActive = false;
}
/**
* Executes a raw SQL query.
*/
query(query: string, parameters?: any[]): Promise<any> {
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError();
return new Promise(async (ok, fail) => {
try {
const databaseConnection = await this.connect();
this.driver.connection.logger.logQuery(query, parameters, this);
const queryStartTime = +new Date();
databaseConnection.query(query, parameters, (err: any, result: any) => {
// log slow queries if maxQueryExecution time is set
const maxQueryExecutionTime = this.driver.connection.options.maxQueryExecutionTime;
const queryEndTime = +new Date();
const queryExecutionTime = queryEndTime - queryStartTime;
if (maxQueryExecutionTime && queryExecutionTime > maxQueryExecutionTime)
this.driver.connection.logger.logQuerySlow(queryExecutionTime, query, parameters, this);
if (err) {
this.driver.connection.logger.logQueryError(err, query, parameters, this);
return fail(new QueryFailedError(query, parameters, err));
}
ok(result);
});
} catch (err) {
fail(err);
}
});
}
/**
* Returns raw data stream.
*/
stream(query: string, parameters?: any[], onEnd?: Function, onError?: Function): Promise<ReadStream> {
if (this.isReleased)
throw new QueryRunnerAlreadyReleasedError();
return new Promise(async (ok, fail) => {
try {
const databaseConnection = await this.connect();
this.driver.connection.logger.logQuery(query, parameters, this);
const databaseQuery = databaseConnection.query(query, parameters);
if (onEnd) databaseQuery.on("end", onEnd);
if (onError) databaseQuery.on("error", onError);
ok(databaseQuery.stream());
} catch (err) {
fail(err);
}
});
}
/**
* Returns all available database names including system databases.
*/
async getDatabases(): Promise<string[]> {
return Promise.resolve([]);
}
/**
* Returns all available schema names including system schemas.
* If database parameter specified, returns schemas of that database.
*/
async getSchemas(database?: string): Promise<string[]> {
throw new Error(`MySql driver does not support table schemas`);
}
/**
* Checks if database with the given name exist.
*/
async hasDatabase(database: string): Promise<boolean> {
const result = await this.query(`SELECT * FROM \`INFORMATION_SCHEMA\`.\`SCHEMATA\` WHERE \`SCHEMA_NAME\` = '${database}'`);
return result.length ? true : false;
}
/**
* Checks if schema with the given name exist.
*/
async hasSchema(schema: string): Promise<boolean> {
throw new Error(`MySql driver does not support table schemas`);
}
/**
* Checks if table with the given name exist in the database.
*/
async hasTable(tableOrName: Table|string): Promise<boolean> {
const parsedTableName = this.parseTableName(tableOrName);
const sql = `SELECT * FROM \`INFORMATION_SCHEMA\`.\`COLUMNS\` WHERE \`TABLE_SCHEMA\` = '${parsedTableName.database}' AND \`TABLE_NAME\` = '${parsedTableName.tableName}'`;
const result = await this.query(sql);
return result.length ? true : false;
}
/**
* Checks if column with the given name exist in the given table.
*/
async hasColumn(tableOrName: Table|string, column: TableColumn|string): Promise<boolean> {
const parsedTableName = this.parseTableName(tableOrName);
const columnName = column instanceof TableColumn ? column.name : column;
const sql = `SELECT * FROM \`INFORMATION_SCHEMA\`.\`COLUMNS\` WHERE \`TABLE_SCHEMA\` = '${parsedTableName.database}' AND \`TABLE_NAME\` = '${parsedTableName.tableName}' AND \`COLUMN_NAME\` = '${columnName}'`;
const result = await this.query(sql);
return result.length ? true : false;
}
/**
* Creates a new database.
*/
async createDatabase(database: string, ifNotExist?: boolean): Promise<void> {
const up = ifNotExist ? `CREATE DATABASE IF NOT EXISTS \`${database}\`` : `CREATE DATABASE \`${database}\``;
const down = `DROP DATABASE \`${database}\``;
await this.executeQueries(new Query(up), new Query(down));
}
/**
* Drops database.
*/
async dropDatabase(database: string, ifExist?: boolean): Promise<void> {
const up = ifExist ? `DROP DATABASE IF EXISTS \`${database}\`` : `DROP DATABASE \`${database}\``;
const down = `CREATE DATABASE \`${database}\``;
await this.executeQueries(new Query(up), new Query(down));
}
/**
* Creates a new table schema.
*/
async createSchema(schema: string, ifNotExist?: boolean): Promise<void> {
throw new Error(`Schema create queries are not supported by MySql driver.`);
}
/**
* Drops table schema.
*/
async dropSchema(schemaPath: string, ifExist?: boolean): Promise<void> {
throw new Error(`Schema drop queries are not supported by MySql driver.`);
}
/**
* Creates a new table.
*/
async createTable(table: Table, ifNotExist: boolean = false, createForeignKeys: boolean = true): Promise<void> {
if (ifNotExist) {
const isTableExist = await this.hasTable(table);
if (isTableExist) return Promise.resolve();
}
const upQueries: Query[] = [];
const downQueries: Query[] = [];
upQueries.push(this.createTableSql(table, createForeignKeys));
downQueries.push(this.dropTableSql(table));
// we must first drop indices, than drop foreign keys, because drop queries runs in reversed order
// and foreign keys will be dropped first as indices. This order is very important, because we can't drop index
// if it related to the foreign key.
// createTable does not need separate method to create indices, because it create indices in the same query with table creation.
table.indices.forEach(index => downQueries.push(this.dropIndexSql(table, index)));
// if createForeignKeys is true, we must drop created foreign keys in down query.
// createTable does not need separate method to create foreign keys, because it create fk's in the same query with table creation.
if (createForeignKeys)
table.foreignKeys.forEach(foreignKey => downQueries.push(this.dropForeignKeySql(table, foreignKey)));
return this.executeQueries(upQueries, downQueries);
}
/**
* Drop the table.
*/
async dropTable(target: Table|string, ifExist?: boolean, dropForeignKeys: boolean = true): Promise<void> {
// It needs because if table does not exist and dropForeignKeys or dropIndices is true, we don't need
// to perform drop queries for foreign keys and indices.
if (ifExist) {
const isTableExist = await this.hasTable(target);
if (!isTableExist) return Promise.resolve();
}
// if dropTable called with dropForeignKeys = true, we must create foreign keys in down query.
const createForeignKeys: boolean = dropForeignKeys;
const tableName = target instanceof Table ? target.name : target;
const table = await this.getCachedTable(tableName);
const upQueries: Query[] = [];
const downQueries: Query[] = [];
if (dropForeignKeys)
table.foreignKeys.forEach(foreignKey => upQueries.push(this.dropForeignKeySql(table, foreignKey)));
table.indices.forEach(index => upQueries.push(this.dropIndexSql(table, index)));
upQueries.push(this.dropTableSql(table));
downQueries.push(this.createTableSql(table, createForeignKeys));
await this.executeQueries(upQueries, downQueries);
}
/**
* Creates a new view.
*/
async createView(view: View): Promise<void> {
const upQueries: Query[] = [];
const downQueries: Query[] = [];
upQueries.push(this.createViewSql(view));
upQueries.push(await this.insertViewDefinitionSql(view));
downQueries.push(this.dropViewSql(view));
downQueries.push(await this.deleteViewDefinitionSql(view));
await this.executeQueries(upQueries, downQueries);
}
/**
* Drops the view.
*/
async dropView(target: View|string): Promise<void> {
const viewName = target instanceof View ? target.name : target;
const view = await this.getCachedView(viewName);
const upQueries: Query[] = [];
const downQueries: Query[] = [];
upQueries.push(await this.deleteViewDefinitionSql(view));
upQueries.push(this.dropViewSql(view));
downQueries.push(await this.insertViewDefinitionSql(view));
downQueries.push(this.createViewSql(view));
await this.executeQueries(upQueries, downQueries);
}
/**
* Renames a table.
*/
async renameTable(oldTableOrName: Table|string, newTableName: string): Promise<void> {
const upQueries: Query[] = [];
const downQueries: Query[] = [];
const oldTable = oldTableOrName instanceof Table ? oldTableOrName : await this.getCachedTable(oldTableOrName);
const newTable = oldTable.clone();
const dbName = oldTable.name.indexOf(".") === -1 ? undefined : oldTable.name.split(".")[0];
newTable.name = dbName ? `${dbName}.${newTableName}` : newTableName;
// rename table
upQueries.push(new Query(`RENAME TABLE ${this.escapePath(oldTable.name)} TO ${this.escapePath(newTable.name)}`));
downQueries.push(new Query(`RENAME TABLE ${this.escapePath(newTable.name)} TO ${this.escapePath(oldTable.name)}`));
// rename index constraints
newTable.indices.forEach(index => {
// build new constraint name
const columnNames = index.columnNames.map(column => `\`${column}\``).join(", ");
const newIndexName = this.connection.namingStrategy.indexName(newTable, index.columnNames, index.where);
// build queries
let indexType = "";
if (index.isUnique)
indexType += "UNIQUE ";
if (index.isSpatial)
indexType += "SPATIAL ";
if (index.isFulltext)
indexType += "FULLTEXT ";
const indexParser = index.isFulltext && index.parser ? ` WITH PARSER ${index.parser}` : "";
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(newTable)} DROP INDEX \`${index.name}\`, ADD ${indexType}INDEX \`${newIndexName}\` (${columnNames})${indexParser}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(newTable)} DROP INDEX \`${newIndexName}\`, ADD ${indexType}INDEX \`${index.name}\` (${columnNames})${indexParser}`));
// replace constraint name
index.name = newIndexName;
});
// rename foreign key constraint
newTable.foreignKeys.forEach(foreignKey => {
// build new constraint name
const columnNames = foreignKey.columnNames.map(column => `\`${column}\``).join(", ");
const referencedColumnNames = foreignKey.referencedColumnNames.map(column => `\`${column}\``).join(",");
const newForeignKeyName = this.connection.namingStrategy.foreignKeyName(newTable, foreignKey.columnNames, foreignKey.referencedTableName, foreignKey.referencedColumnNames);
// build queries
let up = `ALTER TABLE ${this.escapePath(newTable)} DROP FOREIGN KEY \`${foreignKey.name}\`, ADD CONSTRAINT \`${newForeignKeyName}\` FOREIGN KEY (${columnNames}) ` +
`REFERENCES ${this.escapePath(foreignKey.referencedTableName)}(${referencedColumnNames})`;
if (foreignKey.onDelete)
up += ` ON DELETE ${foreignKey.onDelete}`;
if (foreignKey.onUpdate)
up += ` ON UPDATE ${foreignKey.onUpdate}`;
let down = `ALTER TABLE ${this.escapePath(newTable)} DROP FOREIGN KEY \`${newForeignKeyName}\`, ADD CONSTRAINT \`${foreignKey.name}\` FOREIGN KEY (${columnNames}) ` +
`REFERENCES ${this.escapePath(foreignKey.referencedTableName)}(${referencedColumnNames})`;
if (foreignKey.onDelete)
down += ` ON DELETE ${foreignKey.onDelete}`;
if (foreignKey.onUpdate)
down += ` ON UPDATE ${foreignKey.onUpdate}`;
upQueries.push(new Query(up));
downQueries.push(new Query(down));
// replace constraint name
foreignKey.name = newForeignKeyName;
});
await this.executeQueries(upQueries, downQueries);
// rename old table and replace it in cached tabled;
oldTable.name = newTable.name;
this.replaceCachedTable(oldTable, newTable);
}
/**
* Creates a new column from the column in the table.
*/
async addColumn(tableOrName: Table|string, column: TableColumn): Promise<void> {
const table = tableOrName instanceof Table ? tableOrName : await this.getCachedTable(tableOrName);
const clonedTable = table.clone();
const upQueries: Query[] = [];
const downQueries: Query[] = [];
const skipColumnLevelPrimary = clonedTable.primaryColumns.length > 0;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD ${this.buildCreateColumnSql(column, skipColumnLevelPrimary, false)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP COLUMN \`${column.name}\``));
// create or update primary key constraint
if (column.isPrimary && skipColumnLevelPrimary) {
// if we already have generated column, we must temporary drop AUTO_INCREMENT property.
const generatedColumn = clonedTable.columns.find(column => column.isGenerated && column.generationStrategy === "increment");
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${column.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(column, true)}`));
}
const primaryColumns = clonedTable.primaryColumns;
let columnNames = primaryColumns.map(column => `\`${column.name}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
primaryColumns.push(column);
columnNames = primaryColumns.map(column => `\`${column.name}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
// if we previously dropped AUTO_INCREMENT property, we must bring it back
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(column, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${column.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
}
}
// create column index
const columnIndex = clonedTable.indices.find(index => index.columnNames.length === 1 && index.columnNames[0] === column.name);
if (columnIndex) {
upQueries.push(this.createIndexSql(table, columnIndex));
downQueries.push(this.dropIndexSql(table, columnIndex));
} else if (column.isUnique) {
const uniqueIndex = new TableIndex({
name: this.connection.namingStrategy.indexName(table.name, [column.name]),
columnNames: [column.name],
isUnique: true
});
clonedTable.indices.push(uniqueIndex);
clonedTable.uniques.push(new TableUnique({
name: uniqueIndex.name,
columnNames: uniqueIndex.columnNames
}));
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD UNIQUE INDEX \`${uniqueIndex.name}\` (\`${column.name}\`)`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${uniqueIndex.name}\``));
}
await this.executeQueries(upQueries, downQueries);
clonedTable.addColumn(column);
this.replaceCachedTable(table, clonedTable);
}
/**
* Creates a new columns from the column in the table.
*/
async addColumns(tableOrName: Table|string, columns: TableColumn[]): Promise<void> {
await PromiseUtils.runInSequence(columns, column => this.addColumn(tableOrName, column));
}
/**
* Renames column in the given table.
*/
async renameColumn(tableOrName: Table|string, oldTableColumnOrName: TableColumn|string, newTableColumnOrName: TableColumn|string): Promise<void> {
const table = tableOrName instanceof Table ? tableOrName : await this.getCachedTable(tableOrName);
const oldColumn = oldTableColumnOrName instanceof TableColumn ? oldTableColumnOrName : table.columns.find(c => c.name === oldTableColumnOrName);
if (!oldColumn)
throw new Error(`Column "${oldTableColumnOrName}" was not found in the "${table.name}" table.`);
let newColumn: TableColumn|undefined = undefined;
if (newTableColumnOrName instanceof TableColumn) {
newColumn = newTableColumnOrName;
} else {
newColumn = oldColumn.clone();
newColumn.name = newTableColumnOrName;
}
await this.changeColumn(table, oldColumn, newColumn);
}
/**
* Changes a column in the table.
*/
async changeColumn(tableOrName: Table|string, oldColumnOrName: TableColumn|string, newColumn: TableColumn): Promise<void> {
const table = tableOrName instanceof Table ? tableOrName : await this.getCachedTable(tableOrName);
let clonedTable = table.clone();
const upQueries: Query[] = [];
const downQueries: Query[] = [];
const oldColumn = oldColumnOrName instanceof TableColumn
? oldColumnOrName
: table.columns.find(column => column.name === oldColumnOrName);
if (!oldColumn)
throw new Error(`Column "${oldColumnOrName}" was not found in the "${table.name}" table.`);
if ((newColumn.isGenerated !== oldColumn.isGenerated && newColumn.generationStrategy !== "uuid")
|| oldColumn.type !== newColumn.type
|| oldColumn.length !== newColumn.length
|| oldColumn.generatedType !== newColumn.generatedType) {
await this.dropColumn(table, oldColumn);
await this.addColumn(table, newColumn);
// update cloned table
clonedTable = table.clone();
} else {
if (newColumn.name !== oldColumn.name) {
// We don't change any column properties, just rename it.
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${oldColumn.name}\` \`${newColumn.name}\` ${this.buildCreateColumnSql(oldColumn, true, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${newColumn.name}\` \`${oldColumn.name}\` ${this.buildCreateColumnSql(oldColumn, true, true)}`));
// rename index constraints
clonedTable.findColumnIndices(oldColumn).forEach(index => {
// build new constraint name
index.columnNames.splice(index.columnNames.indexOf(oldColumn.name), 1);
index.columnNames.push(newColumn.name);
const columnNames = index.columnNames.map(column => `\`${column}\``).join(", ");
const newIndexName = this.connection.namingStrategy.indexName(clonedTable, index.columnNames, index.where);
// build queries
let indexType = "";
if (index.isUnique)
indexType += "UNIQUE ";
if (index.isSpatial)
indexType += "SPATIAL ";
if (index.isFulltext)
indexType += "FULLTEXT ";
const indexParser = index.isFulltext && index.parser ? ` WITH PARSER ${index.parser}` : "";
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${index.name}\`, ADD ${indexType}INDEX \`${newIndexName}\` (${columnNames})${indexParser}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${newIndexName}\`, ADD ${indexType}INDEX \`${index.name}\` (${columnNames})${indexParser}`));
// replace constraint name
index.name = newIndexName;
});
// rename foreign key constraints
clonedTable.findColumnForeignKeys(oldColumn).forEach(foreignKey => {
// build new constraint name
foreignKey.columnNames.splice(foreignKey.columnNames.indexOf(oldColumn.name), 1);
foreignKey.columnNames.push(newColumn.name);
const columnNames = foreignKey.columnNames.map(column => `\`${column}\``).join(", ");
const referencedColumnNames = foreignKey.referencedColumnNames.map(column => `\`${column}\``).join(",");
const newForeignKeyName = this.connection.namingStrategy.foreignKeyName(clonedTable, foreignKey.columnNames, foreignKey.referencedTableName, foreignKey.referencedColumnNames);
// build queries
let up = `ALTER TABLE ${this.escapePath(table)} DROP FOREIGN KEY \`${foreignKey.name}\`, ADD CONSTRAINT \`${newForeignKeyName}\` FOREIGN KEY (${columnNames}) ` +
`REFERENCES ${this.escapePath(foreignKey.referencedTableName)}(${referencedColumnNames})`;
if (foreignKey.onDelete)
up += ` ON DELETE ${foreignKey.onDelete}`;
if (foreignKey.onUpdate)
up += ` ON UPDATE ${foreignKey.onUpdate}`;
let down = `ALTER TABLE ${this.escapePath(table)} DROP FOREIGN KEY \`${newForeignKeyName}\`, ADD CONSTRAINT \`${foreignKey.name}\` FOREIGN KEY (${columnNames}) ` +
`REFERENCES ${this.escapePath(foreignKey.referencedTableName)}(${referencedColumnNames})`;
if (foreignKey.onDelete)
down += ` ON DELETE ${foreignKey.onDelete}`;
if (foreignKey.onUpdate)
down += ` ON UPDATE ${foreignKey.onUpdate}`;
upQueries.push(new Query(up));
downQueries.push(new Query(down));
// replace constraint name
foreignKey.name = newForeignKeyName;
});
// rename old column in the Table object
const oldTableColumn = clonedTable.columns.find(column => column.name === oldColumn.name);
clonedTable.columns[clonedTable.columns.indexOf(oldTableColumn!)].name = newColumn.name;
oldColumn.name = newColumn.name;
}
if (this.isColumnChanged(oldColumn, newColumn, true)) {
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${oldColumn.name}\` ${this.buildCreateColumnSql(newColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${newColumn.name}\` ${this.buildCreateColumnSql(oldColumn, true)}`));
}
if (newColumn.isPrimary !== oldColumn.isPrimary) {
// if table have generated column, we must drop AUTO_INCREMENT before changing primary constraints.
const generatedColumn = clonedTable.columns.find(column => column.isGenerated && column.generationStrategy === "increment");
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${generatedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(generatedColumn, true)}`));
}
const primaryColumns = clonedTable.primaryColumns;
// if primary column state changed, we must always drop existed constraint.
if (primaryColumns.length > 0) {
const columnNames = primaryColumns.map(column => `\`${column.name}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
}
if (newColumn.isPrimary === true) {
primaryColumns.push(newColumn);
// update column in table
const column = clonedTable.columns.find(column => column.name === newColumn.name);
column!.isPrimary = true;
const columnNames = primaryColumns.map(column => `\`${column.name}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
} else {
const primaryColumn = primaryColumns.find(c => c.name === newColumn.name);
primaryColumns.splice(primaryColumns.indexOf(primaryColumn!), 1);
// update column in table
const column = clonedTable.columns.find(column => column.name === newColumn.name);
column!.isPrimary = false;
// if we have another primary keys, we must recreate constraint.
if (primaryColumns.length > 0) {
const columnNames = primaryColumns.map(column => `\`${column.name}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
}
}
// if we have generated column, and we dropped AUTO_INCREMENT property before, we must bring it back
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(generatedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${generatedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
}
}
if (newColumn.isUnique !== oldColumn.isUnique) {
if (newColumn.isUnique === true) {
const uniqueIndex = new TableIndex({
name: this.connection.namingStrategy.indexName(table.name, [newColumn.name]),
columnNames: [newColumn.name],
isUnique: true
});
clonedTable.indices.push(uniqueIndex);
clonedTable.uniques.push(new TableUnique({
name: uniqueIndex.name,
columnNames: uniqueIndex.columnNames
}));
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD UNIQUE INDEX \`${uniqueIndex.name}\` (\`${newColumn.name}\`)`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${uniqueIndex.name}\``));
} else {
const uniqueIndex = clonedTable.indices.find(index => {
return index.columnNames.length === 1 && index.isUnique === true && !!index.columnNames.find(columnName => columnName === newColumn.name);
});
clonedTable.indices.splice(clonedTable.indices.indexOf(uniqueIndex!), 1);
const tableUnique = clonedTable.uniques.find(unique => unique.name === uniqueIndex!.name);
clonedTable.uniques.splice(clonedTable.uniques.indexOf(tableUnique!), 1);
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${uniqueIndex!.name}\``));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD UNIQUE INDEX \`${uniqueIndex!.name}\` (\`${newColumn.name}\`)`));
}
}
}
await this.executeQueries(upQueries, downQueries);
this.replaceCachedTable(table, clonedTable);
}
/**
* Changes a column in the table.
*/
async changeColumns(tableOrName: Table|string, changedColumns: { newColumn: TableColumn, oldColumn: TableColumn }[]): Promise<void> {
await PromiseUtils.runInSequence(changedColumns, changedColumn => this.changeColumn(tableOrName, changedColumn.oldColumn, changedColumn.newColumn));
}
/**
* Drops column in the table.
*/
async dropColumn(tableOrName: Table|string, columnOrName: TableColumn|string): Promise<void> {
const table = tableOrName instanceof Table ? tableOrName : await this.getCachedTable(tableOrName);
const column = columnOrName instanceof TableColumn ? columnOrName : table.findColumnByName(columnOrName);
if (!column)
throw new Error(`Column "${columnOrName}" was not found in table "${table.name}"`);
const clonedTable = table.clone();
const upQueries: Query[] = [];
const downQueries: Query[] = [];
// drop primary key constraint
if (column.isPrimary) {
// if table have generated column, we must drop AUTO_INCREMENT before changing primary constraints.
const generatedColumn = clonedTable.columns.find(column => column.isGenerated && column.generationStrategy === "increment");
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${generatedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(generatedColumn, true)}`));
}
// dropping primary key constraint
const columnNames = clonedTable.primaryColumns.map(primaryColumn => `\`${primaryColumn.name}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(clonedTable)} DROP PRIMARY KEY`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(clonedTable)} ADD PRIMARY KEY (${columnNames})`));
// update column in table
const tableColumn = clonedTable.findColumnByName(column.name);
tableColumn!.isPrimary = false;
// if primary key have multiple columns, we must recreate it without dropped column
if (clonedTable.primaryColumns.length > 0) {
const columnNames = clonedTable.primaryColumns.map(primaryColumn => `\`${primaryColumn.name}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(clonedTable)} ADD PRIMARY KEY (${columnNames})`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(clonedTable)} DROP PRIMARY KEY`));
}
// if we have generated column, and we dropped AUTO_INCREMENT property before, and this column is not current dropping column, we must bring it back
if (generatedColumn && generatedColumn.name !== column.name) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(generatedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${generatedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
}
}
// drop column index
const columnIndex = clonedTable.indices.find(index => index.columnNames.length === 1 && index.columnNames[0] === column.name);
if (columnIndex) {
clonedTable.indices.splice(clonedTable.indices.indexOf(columnIndex), 1);
upQueries.push(this.dropIndexSql(table, columnIndex));
downQueries.push(this.createIndexSql(table, columnIndex));
} else if (column.isUnique) {
// we splice constraints both from table uniques and indices.
const uniqueName = this.connection.namingStrategy.uniqueConstraintName(table.name, [column.name]);
const foundUnique = clonedTable.uniques.find(unique => unique.name === uniqueName);
if (foundUnique)
clonedTable.uniques.splice(clonedTable.uniques.indexOf(foundUnique), 1);
const indexName = this.connection.namingStrategy.indexName(table.name, [column.name]);
const foundIndex = clonedTable.indices.find(index => index.name === indexName);
if (foundIndex)
clonedTable.indices.splice(clonedTable.indices.indexOf(foundIndex), 1);
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP INDEX \`${indexName}\``));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD UNIQUE INDEX \`${indexName}\` (\`${column.name}\`)`));
}
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP COLUMN \`${column.name}\``));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD ${this.buildCreateColumnSql(column, true)}`));
await this.executeQueries(upQueries, downQueries);
clonedTable.removeColumn(column);
this.replaceCachedTable(table, clonedTable);
}
/**
* Drops the columns in the table.
*/
async dropColumns(tableOrName: Table|string, columns: TableColumn[]): Promise<void> {
await PromiseUtils.runInSequence(columns, column => this.dropColumn(tableOrName, column));
}
/**
* Creates a new primary key.
*/
async createPrimaryKey(tableOrName: Table|string, columnNames: string[]): Promise<void> {
const table = tableOrName instanceof Table ? tableOrName : await this.getCachedTable(tableOrName);
const clonedTable = table.clone();
const up = this.createPrimaryKeySql(table, columnNames);
const down = this.dropPrimaryKeySql(table);
await this.executeQueries(up, down);
clonedTable.columns.forEach(column => {
if (columnNames.find(columnName => columnName === column.name))
column.isPrimary = true;
});
this.replaceCachedTable(table, clonedTable);
}
/**
* Updates composite primary keys.
*/
async updatePrimaryKeys(tableOrName: Table|string, columns: TableColumn[]): Promise<void> {
const table = tableOrName instanceof Table ? tableOrName : await this.getCachedTable(tableOrName);
const clonedTable = table.clone();
const columnNames = columns.map(column => column.name);
const upQueries: Query[] = [];
const downQueries: Query[] = [];
// if table have generated column, we must drop AUTO_INCREMENT before changing primary constraints.
const generatedColumn = clonedTable.columns.find(column => column.isGenerated && column.generationStrategy === "increment");
if (generatedColumn) {
const nonGeneratedColumn = generatedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${generatedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(generatedColumn, true)}`));
}
// if table already have primary columns, we must drop them.
const primaryColumns = clonedTable.primaryColumns;
if (primaryColumns.length > 0) {
const columnNames = primaryColumns.map(column => `\`${column.name}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNames})`));
}
// update columns in table.
clonedTable.columns
.filter(column => columnNames.indexOf(column.name) !== -1)
.forEach(column => column.isPrimary = true);
const columnNamesString = columnNames.map(columnName => `\`${columnName}\``).join(", ");
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} ADD PRIMARY KEY (${columnNamesString})`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} DROP PRIMARY KEY`));
// if we already have generated column or column is changed to generated, and we dropped AUTO_INCREMENT property before, we must bring it back
const newOrExistGeneratedColumn = generatedColumn ? generatedColumn : columns.find(column => column.isGenerated && column.generationStrategy === "increment");
if (newOrExistGeneratedColumn) {
const nonGeneratedColumn = newOrExistGeneratedColumn.clone();
nonGeneratedColumn.isGenerated = false;
nonGeneratedColumn.generationStrategy = undefined;
upQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${nonGeneratedColumn.name}\` ${this.buildCreateColumnSql(newOrExistGeneratedColumn, true)}`));
downQueries.push(new Query(`ALTER TABLE ${this.escapePath(table)} CHANGE \`${newOrExistGeneratedColumn.name}\` ${this.buildCreateColumnSql(nonGeneratedColumn, true)}`));
// if column changed to generated, we must update it in table
const changedGeneratedColumn = clonedTable.columns.find(column => column.name === newOrExistGeneratedColumn.name);
changedGeneratedColumn!.isGenerated = true;
changedGeneratedColumn!.generationStrategy = "increment";
}
await this.executeQueries(upQueries, downQueries);
this.replaceCachedTable(table, clonedTable);
}
/**
* Drops a primary key.
*/
async dropPrimaryKey(tableOrName: Table|string): Promise<void> {
const table = tableOrName instanceof Table ? tableOrName : await this.getCachedTable(tableOrName);
const up = this.dropPrimaryKeySql(table);
const down = this.createPrimaryKeySql(table, table.primaryColumns.map(column => column.name));
await this.executeQueries(up, down);
table.primaryColumns.forEach(column => {
column.isPrimary = false;
});
}
/**
* Creates a new unique constraint.
*/
async createUniqueConstraint(tableOrName: Table|string, uniqueConstraint: TableUnique): Promise<void> {
throw new Error(`MySql does not support unique constraints. Use unique index instead.`);
}
/**
* Creates a new unique constraints.
*/
async createUniqueConstraints(tableOrName: Table|string, uniqueConstraints: TableUnique[]): Promise<void> {
throw new Error(`MySql does not support unique constraints. Use unique index instead.`);
}
/**
* Drops an unique constraint.
*/
async dropUniqueConstraint(tableOrName: Table|string, uniqueOrName: TableUnique|string): Promise<void> {
throw new Error(`MySql does not support unique constraints. Use unique index instead.`);
}
/**
* Drops an unique constraints.
*/
async dropUniqueConstraints(tableOrName: Table|string, uniqueConstraints: TableUnique[]): Promise<void> {
throw new Error(`MySql does not support unique constraints. Use unique index instead.`);
}
/**
* Creates a new check constraint.
*/
async createCheckConstraint(tableOrName: Table|string, checkConstraint: TableCheck): Promise<void> {
throw new Error(`MySql does not support check constraints.`);
}
/**
* Creates a new check constraints.
*/
async createCheckConstraints(tableOrName: Table|string, checkConstraints: TableCheck[]): Promise<void> {
throw new Error(`MySql does not support check constraints.`);
}
/**
* Drops check constraint.
*/
async dropCheckConstraint(tableOrName: Table|string, checkOrName: TableCheck|string): Promise<void> {
throw new Error(`MySql does not support check constraints.`);
}
/**
* Drops check constraints.
*/
async dropCheckConstraints(tableOrName: Table|string, checkConstraints: TableCheck[]): Promise<void> {
throw new Error(`MySql does not support check constraints.`);
}
/**
* Creates a new exclusion constraint.
*/
async createExclusionConstraint(tableOrName: Table|string, exclusionConstraint: TableExclusion): Promise<void> {
throw new Error(`MySql does not support exclusion constraints.`);
}
/**
* Creates a new exclusion constraints.
*/
async createExclusionConstraints(tableOrName: Table|string, exclusionConstraints: TableExclusion[]): Promise<void> {
throw new Error(`MySql does not support exclusion constraints.`);
}
/**
* Drops exclusion constraint.
*/
async dropExclusionConstraint(tableOrName: Table|string, exclusionOrName: TableExclusion|string): Promise<void> {
throw new Error(`MySql does not support exclusion constraints.`);
}
/**
* Drops exclusion constraints.
*/
async dropExclusionConstraints(tableOrName: Table|string, exclusionConstraints: TableExclusion[]): Promise<void> {