/
InsertQueryBuilder.ts
591 lines (505 loc) · 28 KB
/
InsertQueryBuilder.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
import {CockroachDriver} from "../driver/cockroachdb/CockroachDriver";
import {SapDriver} from "../driver/sap/SapDriver";
import {QueryBuilder} from "./QueryBuilder";
import {ObjectLiteral} from "../common/ObjectLiteral";
import {ObjectType} from "../common/ObjectType";
import {QueryDeepPartialEntity} from "./QueryPartialEntity";
import {SqlServerDriver} from "../driver/sqlserver/SqlServerDriver";
import {PostgresDriver} from "../driver/postgres/PostgresDriver";
import {MysqlDriver} from "../driver/mysql/MysqlDriver";
import {RandomGenerator} from "../util/RandomGenerator";
import {InsertResult} from "./result/InsertResult";
import {ReturningStatementNotSupportedError} from "../error/ReturningStatementNotSupportedError";
import {InsertValuesMissingError} from "../error/InsertValuesMissingError";
import {ColumnMetadata} from "../metadata/ColumnMetadata";
import {ReturningResultsEntityUpdator} from "./ReturningResultsEntityUpdator";
import {AbstractSqliteDriver} from "../driver/sqlite-abstract/AbstractSqliteDriver";
import {SqljsDriver} from "../driver/sqljs/SqljsDriver";
import {BroadcasterResult} from "../subscriber/BroadcasterResult";
import {EntitySchema} from "../entity-schema/EntitySchema";
import {OracleDriver} from "../driver/oracle/OracleDriver";
import {AuroraDataApiDriver} from "../driver/aurora-data-api/AuroraDataApiDriver";
/**
* Allows to build complex sql queries in a fashion way and execute those queries.
*/
export class InsertQueryBuilder<Entity> extends QueryBuilder<Entity> {
// -------------------------------------------------------------------------
// Public Implemented Methods
// -------------------------------------------------------------------------
/**
* Gets generated sql query without parameters being replaced.
*/
getQuery(): string {
let sql = this.createInsertExpression();
return sql.trim();
}
/**
* Executes sql generated by query builder and returns raw database results.
*/
async execute(): Promise<InsertResult> {
// console.time("QueryBuilder.execute");
// console.time(".database stuff");
const queryRunner = this.obtainQueryRunner();
let transactionStartedByUs: boolean = false;
try {
// start transaction if it was enabled
if (this.expressionMap.useTransaction === true && queryRunner.isTransactionActive === false) {
await queryRunner.startTransaction();
transactionStartedByUs = true;
}
// console.timeEnd(".database stuff");
// console.time(".value sets");
const valueSets: ObjectLiteral[] = this.getValueSets();
// console.timeEnd(".value sets");
// call before insertion methods in listeners and subscribers
if (this.expressionMap.callListeners === true && this.expressionMap.mainAlias!.hasMetadata) {
const broadcastResult = new BroadcasterResult();
valueSets.forEach(valueSet => {
queryRunner.broadcaster.broadcastBeforeInsertEvent(broadcastResult, this.expressionMap.mainAlias!.metadata, valueSet);
});
if (broadcastResult.promises.length > 0) await Promise.all(broadcastResult.promises);
}
let declareSql: string | null = null;
let selectOutputSql: string | null = null;
// if update entity mode is enabled we may need extra columns for the returning statement
// console.time(".prepare returning statement");
const returningResultsEntityUpdator = new ReturningResultsEntityUpdator(queryRunner, this.expressionMap);
if (this.expressionMap.updateEntity === true && this.expressionMap.mainAlias!.hasMetadata) {
this.expressionMap.extraReturningColumns = returningResultsEntityUpdator.getInsertionReturningColumns();
if (this.expressionMap.extraReturningColumns.length > 0 && this.connection.driver instanceof SqlServerDriver) {
declareSql = this.connection.driver.buildTableVariableDeclaration("@OutputTable", this.expressionMap.extraReturningColumns);
selectOutputSql = `SELECT * FROM @OutputTable`;
}
}
// console.timeEnd(".prepare returning statement");
// execute query
// console.time(".getting query and parameters");
const [insertSql, parameters] = this.getQueryAndParameters();
// console.timeEnd(".getting query and parameters");
const insertResult = new InsertResult();
// console.time(".query execution by database");
const statements = [declareSql, insertSql, selectOutputSql];
insertResult.raw = await queryRunner.query(
statements.filter(sql => sql != null).join(";\n\n"),
parameters,
);
// console.timeEnd(".query execution by database");
// load returning results and set them to the entity if entity updation is enabled
if (this.expressionMap.updateEntity === true && this.expressionMap.mainAlias!.hasMetadata) {
// console.time(".updating entity");
await returningResultsEntityUpdator.insert(insertResult, valueSets);
// console.timeEnd(".updating entity");
}
// call after insertion methods in listeners and subscribers
if (this.expressionMap.callListeners === true && this.expressionMap.mainAlias!.hasMetadata) {
const broadcastResult = new BroadcasterResult();
valueSets.forEach(valueSet => {
queryRunner.broadcaster.broadcastAfterInsertEvent(broadcastResult, this.expressionMap.mainAlias!.metadata, valueSet);
});
if (broadcastResult.promises.length > 0) await Promise.all(broadcastResult.promises);
}
// close transaction if we started it
// console.time(".commit");
if (transactionStartedByUs) {
await queryRunner.commitTransaction();
}
// console.timeEnd(".commit");
return insertResult;
} catch (error) {
// rollback transaction if we started it
if (transactionStartedByUs) {
try {
await queryRunner.rollbackTransaction();
} catch (rollbackError) { }
}
throw error;
} finally {
// console.time(".releasing connection");
if (queryRunner !== this.queryRunner) { // means we created our own query runner
await queryRunner.release();
}
if (this.connection.driver instanceof SqljsDriver && !queryRunner.isTransactionActive) {
await this.connection.driver.autoSave();
}
// console.timeEnd(".releasing connection");
// console.timeEnd("QueryBuilder.execute");
}
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Specifies INTO which entity's table insertion will be executed.
*/
into<T>(entityTarget: ObjectType<T>|EntitySchema<T>|string, columns?: string[]): InsertQueryBuilder<T> {
entityTarget = entityTarget instanceof EntitySchema ? entityTarget.options.name : entityTarget;
const mainAlias = this.createFromAlias(entityTarget);
this.expressionMap.setMainAlias(mainAlias);
this.expressionMap.insertColumns = columns || [];
return (this as any) as InsertQueryBuilder<T>;
}
/**
* Values needs to be inserted into table.
*/
values(values: QueryDeepPartialEntity<Entity>|QueryDeepPartialEntity<Entity>[]): this {
this.expressionMap.valuesSet = values;
return this;
}
/**
* Optional returning/output clause.
* This will return given column values.
*/
output(columns: string[]): this;
/**
* Optional returning/output clause.
* Returning is a SQL string containing returning statement.
*/
output(output: string): this;
/**
* Optional returning/output clause.
*/
output(output: string|string[]): this;
/**
* Optional returning/output clause.
*/
output(output: string|string[]): this {
return this.returning(output);
}
/**
* Optional returning/output clause.
* This will return given column values.
*/
returning(columns: string[]): this;
/**
* Optional returning/output clause.
* Returning is a SQL string containing returning statement.
*/
returning(returning: string): this;
/**
* Optional returning/output clause.
*/
returning(returning: string|string[]): this;
/**
* Optional returning/output clause.
*/
returning(returning: string|string[]): this {
// not all databases support returning/output cause
if (!this.connection.driver.isReturningSqlSupported())
throw new ReturningStatementNotSupportedError();
this.expressionMap.returning = returning;
return this;
}
/**
* Indicates if entity must be updated after insertion operations.
* This may produce extra query or use RETURNING / OUTPUT statement (depend on database).
* Enabled by default.
*/
updateEntity(enabled: boolean): this {
this.expressionMap.updateEntity = enabled;
return this;
}
/**
* Adds additional ON CONFLICT statement supported in postgres and cockroach.
*/
onConflict(statement: string): this {
this.expressionMap.onConflict = statement;
return this;
}
/**
* Adds additional ignore statement supported in databases.
*/
orIgnore(statement: string | boolean = true): this {
this.expressionMap.onIgnore = statement;
return this;
}
/**
* Adds additional update statement supported in databases.
*/
orUpdate(statement?: { columns?: string[], overwrite?: string[], conflict_target?: string | string[] }): this {
this.expressionMap.onUpdate = {};
if (statement && Array.isArray(statement.conflict_target))
this.expressionMap.onUpdate.conflict = ` ( ${statement.conflict_target.join(", ")} ) `;
if (statement && typeof statement.conflict_target === "string")
this.expressionMap.onUpdate.conflict = ` ON CONSTRAINT ${statement.conflict_target} `;
if (statement && Array.isArray(statement.columns))
this.expressionMap.onUpdate.columns = statement.columns.map(column => `${column} = :${column}`).join(", ");
if (statement && Array.isArray(statement.overwrite)) {
if (this.connection.driver instanceof MysqlDriver || this.connection.driver instanceof AuroraDataApiDriver) {
this.expressionMap.onUpdate.overwrite = statement.overwrite.map(column => `${column} = VALUES(${column})`).join(", ");
} else if (this.connection.driver instanceof PostgresDriver || this.connection.driver instanceof AbstractSqliteDriver || this.connection.driver instanceof CockroachDriver) {
this.expressionMap.onUpdate.overwrite = statement.overwrite.map(column => `${column} = EXCLUDED.${column}`).join(", ");
}
}
return this;
}
// -------------------------------------------------------------------------
// Protected Methods
// -------------------------------------------------------------------------
/**
* Creates INSERT express used to perform insert query.
*/
protected createInsertExpression() {
const tableName = this.getTableName(this.getMainTableName());
const valuesExpression = this.createValuesExpression(); // its important to get values before returning expression because oracle rely on native parameters and ordering of them is important
const returningExpression = this.createReturningExpression();
const columnsExpression = this.createColumnNamesExpression();
let query = "INSERT ";
if (this.connection.driver instanceof MysqlDriver || this.connection.driver instanceof AuroraDataApiDriver) {
query += `${this.expressionMap.onIgnore ? " IGNORE " : ""}`;
}
query += `INTO ${tableName}`;
// add columns expression
if (columnsExpression) {
query += `(${columnsExpression})`;
} else {
if (!valuesExpression && (this.connection.driver instanceof MysqlDriver || this.connection.driver instanceof AuroraDataApiDriver)) // special syntax for mysql DEFAULT VALUES insertion
query += "()";
}
// add OUTPUT expression
if (returningExpression && this.connection.driver instanceof SqlServerDriver) {
query += ` OUTPUT ${returningExpression}`;
}
// add VALUES expression
if (valuesExpression) {
query += ` VALUES ${valuesExpression}`;
} else {
if (this.connection.driver instanceof MysqlDriver || this.connection.driver instanceof AuroraDataApiDriver) { // special syntax for mysql DEFAULT VALUES insertion
query += " VALUES ()";
} else {
query += ` DEFAULT VALUES`;
}
}
if (this.connection.driver instanceof PostgresDriver || this.connection.driver instanceof AbstractSqliteDriver || this.connection.driver instanceof CockroachDriver) {
query += `${this.expressionMap.onIgnore ? " ON CONFLICT DO NOTHING " : ""}`;
query += `${this.expressionMap.onConflict ? " ON CONFLICT " + this.expressionMap.onConflict : ""}`;
if (this.expressionMap.onUpdate) {
const { overwrite, columns, conflict } = this.expressionMap.onUpdate;
query += `${columns ? " ON CONFLICT " + conflict + " DO UPDATE SET " + columns : ""}`;
query += `${overwrite ? " ON CONFLICT " + conflict + " DO UPDATE SET " + overwrite : ""}`;
}
} else if (this.connection.driver instanceof MysqlDriver || this.connection.driver instanceof AuroraDataApiDriver) {
if (this.expressionMap.onUpdate) {
const { overwrite, columns } = this.expressionMap.onUpdate;
query += `${columns ? " ON DUPLICATE KEY UPDATE " + columns : ""}`;
query += `${overwrite ? " ON DUPLICATE KEY UPDATE " + overwrite : ""}`;
}
}
// add RETURNING expression
if (returningExpression && (this.connection.driver instanceof PostgresDriver || this.connection.driver instanceof OracleDriver || this.connection.driver instanceof CockroachDriver)) {
query += ` RETURNING ${returningExpression}`;
}
return query;
}
/**
* Gets list of columns where values must be inserted to.
*/
protected getInsertedColumns(): ColumnMetadata[] {
if (!this.expressionMap.mainAlias!.hasMetadata)
return [];
return this.expressionMap.mainAlias!.metadata.columns.filter(column => {
// if user specified list of columns he wants to insert to, then we filter only them
if (this.expressionMap.insertColumns.length)
return this.expressionMap.insertColumns.indexOf(column.propertyPath) !== -1;
// skip columns the user doesn't want included by default
if (!column.isInsert) { return false; }
// if user did not specified such list then return all columns except auto-increment one
// for Oracle we return auto-increment column as well because Oracle does not support DEFAULT VALUES expression
if (column.isGenerated && column.generationStrategy === "increment"
&& !(this.connection.driver instanceof OracleDriver)
&& !(this.connection.driver instanceof AbstractSqliteDriver)
&& !(this.connection.driver instanceof MysqlDriver)
&& !(this.connection.driver instanceof AuroraDataApiDriver))
return false;
return true;
});
}
/**
* Creates a columns string where values must be inserted to for INSERT INTO expression.
*/
protected createColumnNamesExpression(): string {
const columns = this.getInsertedColumns();
if (columns.length > 0)
return columns.map(column => this.escape(column.databaseName)).join(", ");
// in the case if there are no insert columns specified and table without metadata used
// we get columns from the inserted value map, in the case if only one inserted map is specified
if (!this.expressionMap.mainAlias!.hasMetadata && !this.expressionMap.insertColumns.length) {
const valueSets = this.getValueSets();
if (valueSets.length === 1)
return Object.keys(valueSets[0]).map(columnName => this.escape(columnName)).join(", ");
}
// get a table name and all column database names
return this.expressionMap.insertColumns.map(columnName => this.escape(columnName)).join(", ");
}
/**
* Creates list of values needs to be inserted in the VALUES expression.
*/
protected createValuesExpression(): string {
const valueSets = this.getValueSets();
const columns = this.getInsertedColumns();
// if column metadatas are given then apply all necessary operations with values
if (columns.length > 0) {
let expression = "";
let parametersCount = Object.keys(this.expressionMap.nativeParameters).length;
valueSets.forEach((valueSet, valueSetIndex) => {
columns.forEach((column, columnIndex) => {
if (columnIndex === 0) {
expression += "(";
}
const paramName = "i" + valueSetIndex + "_" + column.databaseName;
// extract real value from the entity
let value = column.getEntityValue(valueSet);
// if column is relational and value is an object then get real referenced column value from this object
// for example column value is { question: { id: 1 } }, value will be equal to { id: 1 }
// and we extract "1" from this object
/*if (column.referencedColumn && value instanceof Object && !(value instanceof Function)) { // todo: check if we still need it since getEntityValue already has similar code
value = column.referencedColumn.getEntityValue(value);
}*/
if (!(value instanceof Function)) {
// make sure our value is normalized by a driver
value = this.connection.driver.preparePersistentValue(value, column);
}
// newly inserted entities always have a version equal to 1 (first version)
// also, user-specified version must be empty
if (column.isVersion && value === undefined) {
expression += "1";
// } else if (column.isNestedSetLeft) {
// const tableName = this.connection.driver.escape(column.entityMetadata.tablePath);
// const rightColumnName = this.connection.driver.escape(column.entityMetadata.nestedSetRightColumn!.databaseName);
// const subQuery = `(SELECT c.max + 1 FROM (SELECT MAX(${rightColumnName}) as max from ${tableName}) c)`;
// expression += subQuery;
//
// } else if (column.isNestedSetRight) {
// const tableName = this.connection.driver.escape(column.entityMetadata.tablePath);
// const rightColumnName = this.connection.driver.escape(column.entityMetadata.nestedSetRightColumn!.databaseName);
// const subQuery = `(SELECT c.max + 2 FROM (SELECT MAX(${rightColumnName}) as max from ${tableName}) c)`;
// expression += subQuery;
} else if (column.isDiscriminator) {
this.expressionMap.nativeParameters["discriminator_value_" + parametersCount] = this.expressionMap.mainAlias!.metadata.discriminatorValue;
expression += this.connection.driver.createParameter("discriminator_value_" + parametersCount, parametersCount);
parametersCount++;
// return "1";
// for create and update dates we insert current date
// no, we don't do it because this constant is already in "default" value of the column
// with extended timestamp functionality, like CURRENT_TIMESTAMP(6) for example
// } else if (column.isCreateDate || column.isUpdateDate) {
// return "CURRENT_TIMESTAMP";
// if column is generated uuid and database does not support its generation and custom generated value was not provided by a user - we generate a new uuid value for insertion
} else if (column.isGenerated && column.generationStrategy === "uuid" && !this.connection.driver.isUUIDGenerationSupported() && value === undefined) {
const paramName = "uuid_" + column.databaseName + valueSetIndex;
value = RandomGenerator.uuid4();
this.expressionMap.nativeParameters[paramName] = value;
expression += this.connection.driver.createParameter(paramName, parametersCount);
parametersCount++;
// if value for this column was not provided then insert default value
} else if (value === undefined) {
if (this.connection.driver instanceof AbstractSqliteDriver || this.connection.driver instanceof SapDriver) { // unfortunately sqlite does not support DEFAULT expression in INSERT queries
if (column.default !== undefined) { // try to use default defined in the column
expression += this.connection.driver.normalizeDefault(column);
} else {
expression += "NULL"; // otherwise simply use NULL and pray if column is nullable
}
} else {
expression += "DEFAULT";
}
// support for SQL expressions in queries
} else if (value instanceof Function) {
expression += value();
// just any other regular value
} else {
if (this.connection.driver instanceof SqlServerDriver)
value = this.connection.driver.parametrizeValue(column, value);
// we need to store array values in a special class to make sure parameter replacement will work correctly
// if (value instanceof Array)
// value = new ArrayParameter(value);
this.expressionMap.nativeParameters[paramName] = value;
if ((this.connection.driver instanceof MysqlDriver || this.connection.driver instanceof AuroraDataApiDriver) && this.connection.driver.spatialTypes.indexOf(column.type) !== -1) {
const useLegacy = this.connection.driver.options.legacySpatialSupport;
const geomFromText = useLegacy ? "GeomFromText" : "ST_GeomFromText";
if (column.srid != null) {
expression += `${geomFromText}(${this.connection.driver.createParameter(paramName, parametersCount)}, ${column.srid})`;
} else {
expression += `${geomFromText}(${this.connection.driver.createParameter(paramName, parametersCount)})`;
}
} else if (this.connection.driver instanceof PostgresDriver && this.connection.driver.spatialTypes.indexOf(column.type) !== -1) {
if (column.srid != null) {
expression += `ST_SetSRID(ST_GeomFromGeoJSON(${this.connection.driver.createParameter(paramName, parametersCount)}), ${column.srid})::${column.type}`;
} else {
expression += `ST_GeomFromGeoJSON(${this.connection.driver.createParameter(paramName, parametersCount)})::${column.type}`;
}
} else if (this.connection.driver instanceof SqlServerDriver && this.connection.driver.spatialTypes.indexOf(column.type) !== -1) {
expression += column.type + "::STGeomFromText(" + this.connection.driver.createParameter(paramName, parametersCount) + ", " + (column.srid || "0") + ")";
} else {
expression += this.connection.driver.createParameter(paramName, parametersCount);
}
parametersCount++;
}
if (columnIndex === columns.length - 1) {
if (valueSetIndex === valueSets.length - 1) {
expression += ")";
} else {
expression += "), ";
}
} else {
expression += ", ";
}
});
});
if (expression === "()")
return "";
return expression;
} else { // for tables without metadata
// get values needs to be inserted
let expression = "";
let parametersCount = Object.keys(this.expressionMap.nativeParameters).length;
valueSets.forEach((valueSet, insertionIndex) => {
const columns = Object.keys(valueSet);
columns.forEach((columnName, columnIndex) => {
if (columnIndex === 0) {
expression += "(";
}
const paramName = "i" + insertionIndex + "_" + columnName;
const value = valueSet[columnName];
// support for SQL expressions in queries
if (value instanceof Function) {
expression += value();
// if value for this column was not provided then insert default value
} else if (value === undefined) {
if (this.connection.driver instanceof AbstractSqliteDriver || this.connection.driver instanceof SapDriver) {
expression += "NULL";
} else {
expression += "DEFAULT";
}
// just any other regular value
} else {
this.expressionMap.nativeParameters[paramName] = value;
expression += this.connection.driver.createParameter(paramName, parametersCount);
parametersCount++;
}
if (columnIndex === Object.keys(valueSet).length - 1) {
if (insertionIndex === valueSets.length - 1) {
expression += ")";
} else {
expression += "), ";
}
}
else {
expression += ", ";
}
});
});
if (expression === "()")
return "";
return expression;
}
}
/**
* Gets array of values need to be inserted into the target table.
*/
protected getValueSets(): ObjectLiteral[] {
if (Array.isArray(this.expressionMap.valuesSet) && this.expressionMap.valuesSet.length > 0)
return this.expressionMap.valuesSet;
if (this.expressionMap.valuesSet instanceof Object)
return [this.expressionMap.valuesSet];
throw new InsertValuesMissingError();
}
}