forked from typeorm/typeorm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
QueryBuilder.ts
912 lines (774 loc) · 38 KB
/
QueryBuilder.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
import {ObjectLiteral} from "../common/ObjectLiteral";
import {QueryRunner} from "../query-runner/QueryRunner";
import {Connection} from "../connection/Connection";
import {QueryExpressionMap} from "./QueryExpressionMap";
import {SelectQueryBuilder} from "./SelectQueryBuilder";
import {UpdateQueryBuilder} from "./UpdateQueryBuilder";
import {DeleteQueryBuilder} from "./DeleteQueryBuilder";
import {SoftDeleteQueryBuilder} from "./SoftDeleteQueryBuilder";
import {InsertQueryBuilder} from "./InsertQueryBuilder";
import {RelationQueryBuilder} from "./RelationQueryBuilder";
import {EntityTarget} from "../common/EntityTarget";
import {Alias} from "./Alias";
import {Brackets} from "./Brackets";
import {QueryDeepPartialEntity} from "./QueryPartialEntity";
import {EntityMetadata} from "../metadata/EntityMetadata";
import {ColumnMetadata} from "../metadata/ColumnMetadata";
import {SqljsDriver} from "../driver/sqljs/SqljsDriver";
import {SqlServerDriver} from "../driver/sqlserver/SqlServerDriver";
import {OracleDriver} from "../driver/oracle/OracleDriver";
import {MysqlDriver} from "../driver/mysql/MysqlDriver";
import {EntitySchema} from "../";
import {FindOperator} from "../find-options/FindOperator";
import {In} from "../find-options/operator/In";
import {EntityColumnNotFound} from "../error/EntityColumnNotFound";
// todo: completely cover query builder with tests
// todo: entityOrProperty can be target name. implement proper behaviour if it is.
// todo: check in persistment if id exist on object and throw exception (can be in partial selection?)
// todo: fix problem with long aliases eg getMaxIdentifierLength
// todo: fix replacing in .select("COUNT(post.id) AS cnt") statement
// todo: implement joinAlways in relations and relationId
// todo: finish partial selection
// todo: sugar methods like: .addCount and .selectCount, selectCountAndMap, selectSum, selectSumAndMap, ...
// todo: implement @Select decorator
// todo: add select and map functions
// todo: implement relation/entity loading and setting them into properties within a separate query
// .loadAndMap("post.categories", "post.categories", qb => ...)
// .loadAndMap("post.categories", Category, qb => ...)
/**
* Allows to build complex sql queries in a fashion way and execute those queries.
*/
export abstract class QueryBuilder<Entity> {
// -------------------------------------------------------------------------
// Public Properties
// -------------------------------------------------------------------------
/**
* Connection on which QueryBuilder was created.
*/
readonly connection: Connection;
/**
* Contains all properties of the QueryBuilder that needs to be build a final query.
*/
readonly expressionMap: QueryExpressionMap;
// -------------------------------------------------------------------------
// Protected Properties
// -------------------------------------------------------------------------
/**
* Query runner used to execute query builder query.
*/
protected queryRunner?: QueryRunner;
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
/**
* QueryBuilder can be initialized from given Connection and QueryRunner objects or from given other QueryBuilder.
*/
constructor(queryBuilder: QueryBuilder<any>);
/**
* QueryBuilder can be initialized from given Connection and QueryRunner objects or from given other QueryBuilder.
*/
constructor(connection: Connection, queryRunner?: QueryRunner);
/**
* QueryBuilder can be initialized from given Connection and QueryRunner objects or from given other QueryBuilder.
*/
constructor(connectionOrQueryBuilder: Connection|QueryBuilder<any>, queryRunner?: QueryRunner) {
if (connectionOrQueryBuilder instanceof QueryBuilder) {
this.connection = connectionOrQueryBuilder.connection;
this.queryRunner = connectionOrQueryBuilder.queryRunner;
this.expressionMap = connectionOrQueryBuilder.expressionMap.clone();
} else {
this.connection = connectionOrQueryBuilder;
this.queryRunner = queryRunner;
this.expressionMap = new QueryExpressionMap(this.connection);
}
}
// -------------------------------------------------------------------------
// Abstract Methods
// -------------------------------------------------------------------------
/**
* Gets generated sql query without parameters being replaced.
*/
abstract getQuery(): string;
// -------------------------------------------------------------------------
// Accessors
// -------------------------------------------------------------------------
/**
* Gets the main alias string used in this query builder.
*/
get alias(): string {
if (!this.expressionMap.mainAlias)
throw new Error(`Main alias is not set`); // todo: better exception
return this.expressionMap.mainAlias.name;
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Creates SELECT query.
* Replaces all previous selections if they exist.
*/
select(): SelectQueryBuilder<Entity>;
/**
* Creates SELECT query and selects given data.
* Replaces all previous selections if they exist.
*/
select(selection: string, selectionAliasName?: string): SelectQueryBuilder<Entity>;
/**
* Creates SELECT query and selects given data.
* Replaces all previous selections if they exist.
*/
select(selection: string[]): SelectQueryBuilder<Entity>;
/**
* Creates SELECT query and selects given data.
* Replaces all previous selections if they exist.
*/
select(selection?: string|string[], selectionAliasName?: string): SelectQueryBuilder<Entity> {
this.expressionMap.queryType = "select";
if (Array.isArray(selection)) {
this.expressionMap.selects = selection.map(selection => ({ selection: selection }));
} else if (selection) {
this.expressionMap.selects = [{ selection: selection, aliasName: selectionAliasName }];
}
// loading it dynamically because of circular issue
const SelectQueryBuilderCls = require("./SelectQueryBuilder").SelectQueryBuilder;
if (this instanceof SelectQueryBuilderCls)
return this as any;
return new SelectQueryBuilderCls(this);
}
/**
* Creates INSERT query.
*/
insert(): InsertQueryBuilder<Entity> {
this.expressionMap.queryType = "insert";
// loading it dynamically because of circular issue
const InsertQueryBuilderCls = require("./InsertQueryBuilder").InsertQueryBuilder;
if (this instanceof InsertQueryBuilderCls)
return this as any;
return new InsertQueryBuilderCls(this);
}
/**
* Creates UPDATE query and applies given update values.
*/
update(): UpdateQueryBuilder<Entity>;
/**
* Creates UPDATE query and applies given update values.
*/
update(updateSet: QueryDeepPartialEntity<Entity>): UpdateQueryBuilder<Entity>;
/**
* Creates UPDATE query for the given entity and applies given update values.
*/
update<Entity>(entity: EntityTarget<Entity>, updateSet?: QueryDeepPartialEntity<Entity>): UpdateQueryBuilder<Entity>;
/**
* Creates UPDATE query for the given table name and applies given update values.
*/
update(tableName: string, updateSet?: QueryDeepPartialEntity<Entity>): UpdateQueryBuilder<Entity>;
/**
* Creates UPDATE query and applies given update values.
*/
update(entityOrTableNameUpdateSet?: EntityTarget<any>|ObjectLiteral, maybeUpdateSet?: ObjectLiteral): UpdateQueryBuilder<any> {
const updateSet = maybeUpdateSet ? maybeUpdateSet : entityOrTableNameUpdateSet as ObjectLiteral|undefined;
entityOrTableNameUpdateSet = entityOrTableNameUpdateSet instanceof EntitySchema ? entityOrTableNameUpdateSet.options.name : entityOrTableNameUpdateSet;
if (entityOrTableNameUpdateSet instanceof Function || typeof entityOrTableNameUpdateSet === "string") {
const mainAlias = this.createFromAlias(entityOrTableNameUpdateSet);
this.expressionMap.setMainAlias(mainAlias);
}
this.expressionMap.queryType = "update";
this.expressionMap.valuesSet = updateSet;
// loading it dynamically because of circular issue
const UpdateQueryBuilderCls = require("./UpdateQueryBuilder").UpdateQueryBuilder;
if (this instanceof UpdateQueryBuilderCls)
return this as any;
return new UpdateQueryBuilderCls(this);
}
/**
* Creates DELETE query.
*/
delete(): DeleteQueryBuilder<Entity> {
this.expressionMap.queryType = "delete";
// loading it dynamically because of circular issue
const DeleteQueryBuilderCls = require("./DeleteQueryBuilder").DeleteQueryBuilder;
if (this instanceof DeleteQueryBuilderCls)
return this as any;
return new DeleteQueryBuilderCls(this);
}
softDelete(): SoftDeleteQueryBuilder<any> {
this.expressionMap.queryType = "soft-delete";
// loading it dynamically because of circular issue
const SoftDeleteQueryBuilderCls = require("./SoftDeleteQueryBuilder").SoftDeleteQueryBuilder;
if (this instanceof SoftDeleteQueryBuilderCls)
return this as any;
return new SoftDeleteQueryBuilderCls(this);
}
restore(): SoftDeleteQueryBuilder<any> {
this.expressionMap.queryType = "restore";
// loading it dynamically because of circular issue
const SoftDeleteQueryBuilderCls = require("./SoftDeleteQueryBuilder").SoftDeleteQueryBuilder;
if (this instanceof SoftDeleteQueryBuilderCls)
return this as any;
return new SoftDeleteQueryBuilderCls(this);
}
/**
* Sets entity's relation with which this query builder gonna work.
*/
relation(propertyPath: string): RelationQueryBuilder<Entity>;
/**
* Sets entity's relation with which this query builder gonna work.
*/
relation<T>(entityTarget: EntityTarget<T>, propertyPath: string): RelationQueryBuilder<T>;
/**
* Sets entity's relation with which this query builder gonna work.
*/
relation(entityTargetOrPropertyPath: Function|string, maybePropertyPath?: string): RelationQueryBuilder<Entity> {
const entityTarget = arguments.length === 2 ? entityTargetOrPropertyPath : undefined;
const propertyPath = arguments.length === 2 ? maybePropertyPath as string : entityTargetOrPropertyPath as string;
this.expressionMap.queryType = "relation";
this.expressionMap.relationPropertyPath = propertyPath;
if (entityTarget) {
const mainAlias = this.createFromAlias(entityTarget);
this.expressionMap.setMainAlias(mainAlias);
}
// loading it dynamically because of circular issue
const RelationQueryBuilderCls = require("./RelationQueryBuilder").RelationQueryBuilder;
if (this instanceof RelationQueryBuilderCls)
return this as any;
return new RelationQueryBuilderCls(this);
}
/**
* Checks if given relation exists in the entity.
* Returns true if relation exists, false otherwise.
*
* todo: move this method to manager? or create a shortcut?
*/
hasRelation<T>(target: EntityTarget<T>, relation: string): boolean;
/**
* Checks if given relations exist in the entity.
* Returns true if relation exists, false otherwise.
*
* todo: move this method to manager? or create a shortcut?
*/
hasRelation<T>(target: EntityTarget<T>, relation: string[]): boolean;
/**
* Checks if given relation or relations exist in the entity.
* Returns true if relation exists, false otherwise.
*
* todo: move this method to manager? or create a shortcut?
*/
hasRelation<T>(target: EntityTarget<T>, relation: string|string[]): boolean {
const entityMetadata = this.connection.getMetadata(target);
const relations = Array.isArray(relation) ? relation : [relation];
return relations.every(relation => {
return !!entityMetadata.findRelationWithPropertyPath(relation);
});
}
/**
* Sets parameter name and its value.
*/
setParameter(key: string, value: any): this {
this.expressionMap.parameters[key] = value;
return this;
}
/**
* Adds all parameters from the given object.
*/
setParameters(parameters: ObjectLiteral): this {
// remove function parameters
Object.keys(parameters).forEach(key => {
if (parameters[key] instanceof Function) {
throw new Error(`Function parameter isn't supported in the parameters. Please check "${key}" parameter.`);
}
});
// set parent query builder parameters as well in sub-query mode
if (this.expressionMap.parentQueryBuilder)
this.expressionMap.parentQueryBuilder.setParameters(parameters);
Object.keys(parameters).forEach(key => this.setParameter(key, parameters[key]));
return this;
}
/**
* Adds native parameters from the given object.
*/
setNativeParameters(parameters: ObjectLiteral): this {
// set parent query builder parameters as well in sub-query mode
if (this.expressionMap.parentQueryBuilder)
this.expressionMap.parentQueryBuilder.setNativeParameters(parameters);
Object.keys(parameters).forEach(key => {
this.expressionMap.nativeParameters[key] = parameters[key];
});
return this;
}
/**
* Gets all parameters.
*/
getParameters(): ObjectLiteral {
const parameters: ObjectLiteral = Object.assign({}, this.expressionMap.parameters);
// add discriminator column parameter if it exist
if (this.expressionMap.mainAlias && this.expressionMap.mainAlias.hasMetadata) {
const metadata = this.expressionMap.mainAlias!.metadata;
if (metadata.discriminatorColumn && metadata.parentEntityMetadata) {
const values = metadata.childEntityMetadatas
.filter(childMetadata => childMetadata.discriminatorColumn)
.map(childMetadata => childMetadata.discriminatorValue);
values.push(metadata.discriminatorValue);
parameters["discriminatorColumnValues"] = values;
}
}
return parameters;
}
/**
* Prints sql to stdout using console.log.
*/
printSql(): this { // TODO rename to logSql()
const [query, parameters] = this.getQueryAndParameters();
this.connection.logger.logQuery(query, parameters);
return this;
}
/**
* Gets generated sql that will be executed.
* Parameters in the query are escaped for the currently used driver.
*/
getSql(): string {
return this.getQueryAndParameters()[0];
}
/**
* Gets query to be executed with all parameters used in it.
*/
getQueryAndParameters(): [string, any[]] {
// this execution order is important because getQuery method generates this.expressionMap.nativeParameters values
const query = this.getQuery();
const parameters = this.getParameters();
return this.connection.driver.escapeQueryWithParameters(query, parameters, this.expressionMap.nativeParameters);
}
/**
* Executes sql generated by query builder and returns raw database results.
*/
async execute(): Promise<any> {
const [sql, parameters] = this.getQueryAndParameters();
const queryRunner = this.obtainQueryRunner();
try {
return await queryRunner.query(sql, parameters); // await is needed here because we are using finally
} finally {
if (queryRunner !== this.queryRunner) { // means we created our own query runner
await queryRunner.release();
}
if (this.connection.driver instanceof SqljsDriver) {
await this.connection.driver.autoSave();
}
}
}
/**
* Creates a completely new query builder.
* Uses same query runner as current QueryBuilder.
*/
createQueryBuilder(): this {
return new (this.constructor as any)(this.connection, this.queryRunner);
}
/**
* Clones query builder as it is.
* Note: it uses new query runner, if you want query builder that uses exactly same query runner,
* you can create query builder using its constructor, for example new SelectQueryBuilder(queryBuilder)
* where queryBuilder is cloned QueryBuilder.
*/
clone(): this {
return new (this.constructor as any)(this);
}
/**
* Disables escaping.
*/
disableEscaping(): this {
this.expressionMap.disableEscaping = false;
return this;
}
/**
* Escapes table name, column name or alias name using current database's escaping character.
*/
escape(name: string): string {
if (!this.expressionMap.disableEscaping)
return name;
return this.connection.driver.escape(name);
}
/**
* Sets or overrides query builder's QueryRunner.
*/
setQueryRunner(queryRunner: QueryRunner): this {
this.queryRunner = queryRunner;
return this;
}
/**
* Indicates if listeners and subscribers must be called before and after query execution.
* Enabled by default.
*/
callListeners(enabled: boolean): this {
this.expressionMap.callListeners = enabled;
return this;
}
/**
* If set to true the query will be wrapped into a transaction.
*/
useTransaction(enabled: boolean): this {
this.expressionMap.useTransaction = enabled;
return this;
}
// -------------------------------------------------------------------------
// Protected Methods
// -------------------------------------------------------------------------
/**
* Gets escaped table name with schema name if SqlServer driver used with custom
* schema name, otherwise returns escaped table name.
*/
protected getTableName(tablePath: string): string {
return tablePath.split(".")
.map(i => {
// this condition need because in SQL Server driver when custom database name was specified and schema name was not, we got `dbName..tableName` string, and doesn't need to escape middle empty string
if (i === "")
return i;
return this.escape(i);
}).join(".");
}
/**
* Gets name of the table where insert should be performed.
*/
protected getMainTableName(): string {
if (!this.expressionMap.mainAlias)
throw new Error(`Entity where values should be inserted is not specified. Call "qb.into(entity)" method to specify it.`);
if (this.expressionMap.mainAlias.hasMetadata)
return this.expressionMap.mainAlias.metadata.tablePath;
return this.expressionMap.mainAlias.tablePath!;
}
/**
* Specifies FROM which entity's table select/update/delete will be executed.
* Also sets a main string alias of the selection data.
*/
protected createFromAlias(entityTarget: EntityTarget<any>|((qb: SelectQueryBuilder<any>) => SelectQueryBuilder<any>), aliasName?: string): Alias {
// if table has a metadata then find it to properly escape its properties
// const metadata = this.connection.entityMetadatas.find(metadata => metadata.tableName === tableName);
if (this.connection.hasMetadata(entityTarget)) {
const metadata = this.connection.getMetadata(entityTarget);
return this.expressionMap.createAlias({
type: "from",
name: aliasName,
metadata: this.connection.getMetadata(entityTarget),
tablePath: metadata.tablePath
});
} else {
if (typeof entityTarget === "string") {
const isSubquery = entityTarget.substr(0, 1) === "(" && entityTarget.substr(-1) === ")";
return this.expressionMap.createAlias({
type: "from",
name: aliasName,
tablePath: !isSubquery ? entityTarget as string : undefined,
subQuery: isSubquery ? entityTarget : undefined,
});
}
const subQueryBuilder: SelectQueryBuilder<any> = (entityTarget as any)(((this as any) as SelectQueryBuilder<any>).subQuery());
this.setParameters(subQueryBuilder.getParameters());
const subquery = subQueryBuilder.getQuery();
return this.expressionMap.createAlias({
type: "from",
name: aliasName,
subQuery: subquery
});
}
}
/**
* Replaces all entity's propertyName to name in the given statement.
*/
protected replacePropertyNames(statement: string) {
this.expressionMap.aliases.forEach(alias => {
if (!alias.hasMetadata) return;
const replaceAliasNamePrefix = this.expressionMap.aliasNamePrefixingEnabled ? alias.name + "\\." : "";
const replacementAliasNamePrefix = this.expressionMap.aliasNamePrefixingEnabled ? this.escape(alias.name) + "." : "";
alias.metadata.columns.forEach(column => {
const expression = "([ =\(]|^.{0})" + replaceAliasNamePrefix + column.propertyPath + "([ =\)\,]|.{0}$)";
statement = statement.replace(new RegExp(expression, "gm"), "$1" + replacementAliasNamePrefix + this.escape(column.databaseName) + "$2");
const expression2 = "([ =\(]|^.{0})" + replaceAliasNamePrefix + column.propertyName + "([ =\)\,]|.{0}$)";
statement = statement.replace(new RegExp(expression2, "gm"), "$1" + replacementAliasNamePrefix + this.escape(column.databaseName) + "$2");
});
alias.metadata.relations.forEach(relation => {
[...relation.joinColumns, ...relation.inverseJoinColumns].forEach(joinColumn => {
const expression = "([ =\(]|^.{0})" + replaceAliasNamePrefix + relation.propertyPath + "\\." + joinColumn.referencedColumn!.propertyPath + "([ =\)\,]|.{0}$)";
statement = statement.replace(new RegExp(expression, "gm"), "$1" + replacementAliasNamePrefix + this.escape(joinColumn.databaseName) + "$2"); // todo: fix relation.joinColumns[0], what if multiple columns
});
if (relation.joinColumns.length > 0) {
const expression = "([ =\(]|^.{0})" + replaceAliasNamePrefix + relation.propertyPath + "([ =\)\,]|.{0}$)";
statement = statement.replace(new RegExp(expression, "gm"), "$1" + replacementAliasNamePrefix + this.escape(relation.joinColumns[0].databaseName) + "$2"); // todo: fix relation.joinColumns[0], what if multiple columns
}
});
});
return statement;
}
/**
* Creates "WHERE" expression.
*/
protected createWhereExpression() {
const conditionsArray = [];
const whereExpression = this.createWhereExpressionString();
whereExpression.trim() && conditionsArray.push(this.createWhereExpressionString());
if (this.expressionMap.mainAlias!.hasMetadata) {
const metadata = this.expressionMap.mainAlias!.metadata;
// Adds the global condition of "non-deleted" for the entity with delete date columns in select query.
if (this.expressionMap.queryType === "select" && !this.expressionMap.withDeleted && metadata.deleteDateColumn) {
const column = this.expressionMap.aliasNamePrefixingEnabled
? this.expressionMap.mainAlias!.name + "." + metadata.deleteDateColumn.propertyName
: metadata.deleteDateColumn.propertyName;
const condition = `${this.replacePropertyNames(column)} IS NULL`;
conditionsArray.push(condition);
}
if (metadata.discriminatorColumn && metadata.parentEntityMetadata) {
const column = this.expressionMap.aliasNamePrefixingEnabled
? this.expressionMap.mainAlias!.name + "." + metadata.discriminatorColumn.databaseName
: metadata.discriminatorColumn.databaseName;
const condition = `${this.replacePropertyNames(column)} IN (:...discriminatorColumnValues)`;
conditionsArray.push(condition);
}
}
if (this.expressionMap.extraAppendedAndWhereCondition) {
const condition = this.replacePropertyNames(this.expressionMap.extraAppendedAndWhereCondition);
conditionsArray.push(condition);
}
if (!conditionsArray.length) {
return " ";
} else if (conditionsArray.length === 1) {
return ` WHERE ${conditionsArray[0]}`;
} else {
return ` WHERE ( ${conditionsArray.join(" ) AND ( ")} )`;
}
}
/**
* Creates "RETURNING" / "OUTPUT" expression.
*/
protected createReturningExpression(): string {
const columns = this.getReturningColumns();
const driver = this.connection.driver;
// also add columns we must auto-return to perform entity updation
// if user gave his own returning
if (typeof this.expressionMap.returning !== "string" &&
this.expressionMap.extraReturningColumns.length > 0 &&
driver.isReturningSqlSupported()) {
columns.push(...this.expressionMap.extraReturningColumns.filter(column => {
return columns.indexOf(column) === -1;
}));
}
if (columns.length) {
let columnsExpression = columns.map(column => {
const name = this.escape(column.databaseName);
if (driver instanceof SqlServerDriver) {
if (this.expressionMap.queryType === "insert" || this.expressionMap.queryType === "update" || this.expressionMap.queryType === "soft-delete" || this.expressionMap.queryType === "restore") {
return "INSERTED." + name;
} else {
return this.escape(this.getMainTableName()) + "." + name;
}
} else {
return name;
}
}).join(", ");
if (driver instanceof OracleDriver) {
columnsExpression += " INTO " + columns.map(column => {
const parameterName = "output_" + column.databaseName;
this.expressionMap.nativeParameters[parameterName] = { type: driver.columnTypeToNativeParameter(column.type), dir: driver.oracle.BIND_OUT };
return this.connection.driver.createParameter(parameterName, Object.keys(this.expressionMap.nativeParameters).length);
}).join(", ");
}
if (driver instanceof SqlServerDriver) {
if (this.expressionMap.queryType === "insert" || this.expressionMap.queryType === "update") {
columnsExpression += " INTO @OutputTable";
}
}
return columnsExpression;
} else if (typeof this.expressionMap.returning === "string") {
return this.expressionMap.returning;
}
return "";
}
/**
* If returning / output cause is set to array of column names,
* then this method will return all column metadatas of those column names.
*/
protected getReturningColumns(): ColumnMetadata[] {
const columns: ColumnMetadata[] = [];
if (Array.isArray(this.expressionMap.returning)) {
(this.expressionMap.returning as string[]).forEach(columnName => {
if (this.expressionMap.mainAlias!.hasMetadata) {
columns.push(...this.expressionMap.mainAlias!.metadata.findColumnsWithPropertyPath(columnName));
}
});
}
return columns;
}
/**
* Concatenates all added where expressions into one string.
*/
protected createWhereExpressionString(): string {
return this.expressionMap.wheres.map((where, index) => {
switch (where.type) {
case "and":
return (index > 0 ? "AND " : "") + this.replacePropertyNames(where.condition);
case "or":
return (index > 0 ? "OR " : "") + this.replacePropertyNames(where.condition);
default:
return this.replacePropertyNames(where.condition);
}
}).join(" ");
}
/**
* Creates "WHERE" expression and variables for the given "ids".
*/
protected createWhereIdsExpression(ids: any|any[]): string {
const metadata = this.expressionMap.mainAlias!.metadata;
const normalized = (Array.isArray(ids) ? ids : [ids]).map(id => metadata.ensureEntityIdMap(id));
// using in(...ids) for single primary key entities
if (!metadata.hasMultiplePrimaryKeys
&& metadata.embeddeds.length === 0
) {
const primaryColumn = metadata.primaryColumns[0];
// getEntityValue will try to transform `In`, it is a bug
// todo: remove this transformer check after #2390 is fixed
if (!primaryColumn.transformer) {
return this.computeWhereParameter({
[primaryColumn.propertyName]: In(
normalized.map(id => primaryColumn.getEntityValue(id, false))
)
});
}
}
// create shortcuts for better readability
const alias = this.expressionMap.aliasNamePrefixingEnabled ? this.escape(this.expressionMap.mainAlias!.name) + "." : "";
let parameterIndex = Object.keys(this.expressionMap.nativeParameters).length;
const whereStrings = normalized.map((id, index) => {
const whereSubStrings: string[] = [];
metadata.primaryColumns.forEach((primaryColumn, secondIndex) => {
const parameterName = "id_" + index + "_" + secondIndex;
// whereSubStrings.push(alias + this.escape(primaryColumn.databaseName) + "=:id_" + index + "_" + secondIndex);
whereSubStrings.push(alias + this.escape(primaryColumn.databaseName) + " = " + this.connection.driver.createParameter(parameterName, parameterIndex));
this.expressionMap.nativeParameters[parameterName] = primaryColumn.getEntityValue(id, true);
parameterIndex++;
});
return whereSubStrings.join(" AND ");
});
return whereStrings.length > 1
? "(" + whereStrings.map(whereString => "(" + whereString + ")").join(" OR ") + ")"
: whereStrings[0];
}
/**
* Computes given where argument - transforms to a where string all forms it can take.
*/
protected computeWhereParameter(where: string|((qb: this) => string)|Brackets|ObjectLiteral|ObjectLiteral[]) {
if (typeof where === "string")
return where;
if (where instanceof Brackets) {
const whereQueryBuilder = this.createQueryBuilder();
where.whereFactory(whereQueryBuilder as any);
const whereString = whereQueryBuilder.createWhereExpressionString();
this.setParameters(whereQueryBuilder.getParameters());
return whereString ? "(" + whereString + ")" : "";
} else if (where instanceof Function) {
return where(this);
} else if (where instanceof Object) {
const wheres: ObjectLiteral[] = Array.isArray(where) ? where : [where];
let andConditions: string[];
let parameterIndex = Object.keys(this.expressionMap.nativeParameters).length;
if (this.expressionMap.mainAlias!.hasMetadata) {
andConditions = wheres.map((where, whereIndex) => {
const propertyPaths = EntityMetadata.createPropertyPath(this.expressionMap.mainAlias!.metadata, where);
return propertyPaths.map((propertyPath, propertyIndex) => {
const columns = this.expressionMap.mainAlias!.metadata.findColumnsWithPropertyPath(propertyPath);
if (!columns.length) {
throw new EntityColumnNotFound(propertyPath);
}
return columns.map((column, columnIndex) => {
const aliasPath = this.expressionMap.aliasNamePrefixingEnabled ? `${this.alias}.${propertyPath}` : column.propertyPath;
let parameterValue = column.getEntityValue(where, true);
const parameterName = "where_" + whereIndex + "_" + propertyIndex + "_" + columnIndex;
const parameterBaseCount = Object.keys(this.expressionMap.nativeParameters).filter(x => x.startsWith(parameterName)).length;
if (parameterValue === null) {
return `${aliasPath} IS NULL`;
} else if (parameterValue instanceof FindOperator) {
let parameters: any[] = [];
if (parameterValue.useParameter) {
const realParameterValues: any[] = parameterValue.multipleParameters ? parameterValue.value : [parameterValue.value];
realParameterValues.forEach((realParameterValue, realParameterValueIndex) => {
this.expressionMap.nativeParameters[parameterName + (parameterBaseCount + realParameterValueIndex)] = realParameterValue;
parameterIndex++;
parameters.push(this.connection.driver.createParameter(parameterName + (parameterBaseCount + realParameterValueIndex), parameterIndex - 1));
});
}
return this.computeFindOperatorExpression(parameterValue, aliasPath, parameters);
} else {
this.expressionMap.nativeParameters[parameterName] = parameterValue;
parameterIndex++;
const parameter = this.connection.driver.createParameter(parameterName, parameterIndex - 1);
return `${aliasPath} = ${parameter}`;
}
}).filter(expression => !!expression).join(" AND ");
}).filter(expression => !!expression).join(" AND ");
});
} else {
andConditions = wheres.map((where, whereIndex) => {
return Object.keys(where).map((key, parameterIndex) => {
const parameterValue = where[key];
const aliasPath = this.expressionMap.aliasNamePrefixingEnabled ? `${this.alias}.${key}` : key;
if (parameterValue === null) {
return `${aliasPath} IS NULL`;
} else {
const parameterName = "where_" + whereIndex + "_" + parameterIndex;
this.expressionMap.nativeParameters[parameterName] = parameterValue;
parameterIndex++;
return `${aliasPath} = ${this.connection.driver.createParameter(parameterName, parameterIndex - 1)}`;
}
}).join(" AND ");
});
}
if (andConditions.length > 1)
return andConditions.map(where => "(" + where + ")").join(" OR ");
return andConditions.join("");
}
return "";
}
/**
* Gets SQL needs to be inserted into final query.
*/
protected computeFindOperatorExpression(operator: FindOperator<any>, aliasPath: string, parameters: any[]): string {
switch (operator.type) {
case "not":
if (operator.child) {
return `NOT(${this.computeFindOperatorExpression(operator.child, aliasPath, parameters)})`;
} else {
return `${aliasPath} != ${parameters[0]}`;
}
case "lessThan":
return `${aliasPath} < ${parameters[0]}`;
case "lessThanOrEqual":
return `${aliasPath} <= ${parameters[0]}`;
case "moreThan":
return `${aliasPath} > ${parameters[0]}`;
case "moreThanOrEqual":
return `${aliasPath} >= ${parameters[0]}`;
case "equal":
return `${aliasPath} = ${parameters[0]}`;
case "like":
return `${aliasPath} LIKE ${parameters[0]}`;
case "between":
return `${aliasPath} BETWEEN ${parameters[0]} AND ${parameters[1]}`;
case "in":
if ((this.connection.driver instanceof OracleDriver || this.connection.driver instanceof MysqlDriver) && parameters.length === 0) {
return `${aliasPath} IN (null)`;
}
return `${aliasPath} IN (${parameters.join(", ")})`;
case "any":
return `${aliasPath} = ANY(${parameters[0]})`;
case "isNull":
return `${aliasPath} IS NULL`;
case "raw":
if (typeof operator.value === "function") {
return operator.value(aliasPath);
} else {
return `${aliasPath} = ${operator.value}`;
}
}
throw new TypeError(`Unsupported FindOperator ${FindOperator.constructor.name}`);
}
/**
* Creates a query builder used to execute sql queries inside this query builder.
*/
protected obtainQueryRunner() {
return this.queryRunner || this.connection.createQueryRunner();
}
}