typeorm 0.2.25 → 0.2.29

package/browser/query-builder/SelectQueryBuilder.js

@@ -1,4 +1,4 @@
-import * as tslib_1 from "tslib";
+import { __awaiter, __extends, __generator, __read, __spread } from "tslib";
 import { SapDriver } from "../driver/sap/SapDriver";
 import { RawSqlResultsToEntityTransformer } from "./transformer/RawSqlResultsToEntityTransformer";
 import { SqlServerDriver } from "../driver/sqlserver/SqlServerDriver";
@@ -24,11 +24,13 @@ import { BroadcasterResult } from "../subscriber/BroadcasterResult";
 import { ObjectUtils } from "../util/ObjectUtils";
 import { DriverUtils } from "../driver/DriverUtils";
 import { AuroraDataApiDriver } from "../driver/aurora-data-api/AuroraDataApiDriver";
+import { CockroachDriver } from "../driver/cockroachdb/CockroachDriver";
+import { EntityNotFoundError } from "../error/EntityNotFoundError";
 /**
  * Allows to build complex sql queries in a fashion way and execute those queries.
  */
 var SelectQueryBuilder = /** @class */ (function (_super) {
-    tslib_1.__extends(SelectQueryBuilder, _super);
+    __extends(SelectQueryBuilder, _super);
     function SelectQueryBuilder() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
@@ -39,7 +41,8 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Gets generated sql query without parameters being replaced.
      */
     SelectQueryBuilder.prototype.getQuery = function () {
-        var sql = this.createSelectExpression();
+        var sql = this.createComment();
+        sql += this.createSelectExpression();
         sql += this.createJoinExpression();
         sql += this.createWhereExpression();
         sql += this.createGroupByExpression();
@@ -419,8 +422,8 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * calling this function will override previously set ORDER BY conditions.
      */
     SelectQueryBuilder.prototype.orderBy = function (sort, order, nulls) {
-        if (order === void 0) { order = "ASC"; }
         var _a, _b;
+        if (order === void 0) { order = "ASC"; }
         if (order !== undefined && order !== "ASC" && order !== "DESC")
             throw new Error("SelectQueryBuilder.addOrderBy \"order\" can accept only \"ASC\" and \"DESC\" values.");
         if (nulls !== undefined && nulls !== "NULLS FIRST" && nulls !== "NULLS LAST")
@@ -521,8 +524,8 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Gets first raw result returned by execution of generated query builder sql.
      */
     SelectQueryBuilder.prototype.getRawOne = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, this.getRawMany()];
                     case 1: return [2 /*return*/, (_a.sent())[0]];
@@ -534,9 +537,9 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Gets all raw results returned by execution of generated query builder sql.
      */
     SelectQueryBuilder.prototype.getRawMany = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return __awaiter(this, void 0, void 0, function () {
             var queryRunner, transactionStartedByUs, results, error_1, rollbackError_1;
-            return tslib_1.__generator(this, function (_a) {
+            return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (this.expressionMap.lockMode === "optimistic")
@@ -592,9 +595,9 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Executes sql generated by query builder and returns object with raw results and entities created from them.
      */
     SelectQueryBuilder.prototype.getRawAndEntities = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return __awaiter(this, void 0, void 0, function () {
             var queryRunner, transactionStartedByUs, results, error_2, rollbackError_2;
-            return tslib_1.__generator(this, function (_a) {
+            return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         queryRunner = this.obtainQueryRunner();
@@ -649,9 +652,9 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Gets single entity returned by execution of generated query builder sql.
      */
     SelectQueryBuilder.prototype.getOne = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return __awaiter(this, void 0, void 0, function () {
             var results, result, metadata, actualVersion, actualVersion;
-            return tslib_1.__generator(this, function (_a) {
+            return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, this.getRawAndEntities()];
                     case 1:
@@ -675,13 +678,32 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Gets the first entity returned by execution of generated query builder sql or rejects the returned promise on error.
+     */
+    SelectQueryBuilder.prototype.getOneOrFail = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var entity;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getOne()];
+                    case 1:
+                        entity = _a.sent();
+                        if (!entity) {
+                            throw new EntityNotFoundError(this.expressionMap.mainAlias.target, this);
+                        }
+                        return [2 /*return*/, entity];
+                }
+            });
+        });
+    };
     /**
      * Gets entities returned by execution of generated query builder sql.
      */
     SelectQueryBuilder.prototype.getMany = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return __awaiter(this, void 0, void 0, function () {
             var results;
-            return tslib_1.__generator(this, function (_a) {
+            return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (this.expressionMap.lockMode === "optimistic")
@@ -699,9 +721,9 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Count excludes all limitations set by setFirstResult and setMaxResults methods call.
      */
     SelectQueryBuilder.prototype.getCount = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return __awaiter(this, void 0, void 0, function () {
             var queryRunner, transactionStartedByUs, results, error_3, rollbackError_3;
-            return tslib_1.__generator(this, function (_a) {
+            return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (this.expressionMap.lockMode === "optimistic")
@@ -759,9 +781,9 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * This method is useful to build pagination.
      */
     SelectQueryBuilder.prototype.getManyAndCount = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return __awaiter(this, void 0, void 0, function () {
             var queryRunner, transactionStartedByUs, entitiesAndRaw, count, results, error_4, rollbackError_4;
-            return tslib_1.__generator(this, function (_a) {
+            return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         if (this.expressionMap.lockMode === "optimistic")
@@ -823,14 +845,14 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Executes built SQL query and returns raw data stream.
      */
     SelectQueryBuilder.prototype.stream = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return __awaiter(this, void 0, void 0, function () {
             var _a, sql, parameters, queryRunner, transactionStartedByUs, releaseFn, results, error_5, rollbackError_5;
             var _this = this;
-            return tslib_1.__generator(this, function (_b) {
+            return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         this.expressionMap.queryEntity = false;
-                        _a = tslib_1.__read(this.getQueryAndParameters(), 2), sql = _a[0], parameters = _a[1];
+                        _a = __read(this.getQueryAndParameters(), 2), sql = _a[0], parameters = _a[1];
                         queryRunner = this.obtainQueryRunner();
                         transactionStartedByUs = false;
                         _b.label = 1;
@@ -967,15 +989,15 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
         var excludedSelects = [];
         if (this.expressionMap.mainAlias.hasMetadata) {
             var metadata = this.expressionMap.mainAlias.metadata;
-            allSelects.push.apply(allSelects, tslib_1.__spread(this.buildEscapedEntityColumnSelects(this.expressionMap.mainAlias.name, metadata)));
-            excludedSelects.push.apply(excludedSelects, tslib_1.__spread(this.findEntityColumnSelects(this.expressionMap.mainAlias.name, metadata)));
+            allSelects.push.apply(allSelects, __spread(this.buildEscapedEntityColumnSelects(this.expressionMap.mainAlias.name, metadata)));
+            excludedSelects.push.apply(excludedSelects, __spread(this.findEntityColumnSelects(this.expressionMap.mainAlias.name, metadata)));
         }
         // add selects from joins
         this.expressionMap.joinAttributes
             .forEach(function (join) {
             if (join.metadata) {
-                allSelects.push.apply(allSelects, tslib_1.__spread(_this.buildEscapedEntityColumnSelects(join.alias.name, join.metadata)));
-                excludedSelects.push.apply(excludedSelects, tslib_1.__spread(_this.findEntityColumnSelects(join.alias.name, join.metadata)));
+                allSelects.push.apply(allSelects, __spread(_this.buildEscapedEntityColumnSelects(join.alias.name, join.metadata)));
+                excludedSelects.push.apply(excludedSelects, __spread(_this.findEntityColumnSelects(join.alias.name, join.metadata)));
             }
             else {
                 var hasMainAlias = _this.expressionMap.selects.some(function (select) { return select.selection === join.alias.name; });
@@ -1280,9 +1302,9 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
         var hasMainAlias = this.expressionMap.selects.some(function (select) { return select.selection === aliasName; });
         var columns = [];
         if (hasMainAlias) {
-            columns.push.apply(columns, tslib_1.__spread(metadata.columns.filter(function (column) { return column.isSelect === true; })));
+            columns.push.apply(columns, __spread(metadata.columns.filter(function (column) { return column.isSelect === true; })));
         }
-        columns.push.apply(columns, tslib_1.__spread(metadata.columns.filter(function (column) {
+        columns.push.apply(columns, __spread(metadata.columns.filter(function (column) {
             return _this.expressionMap.selects.some(function (select) { return select.selection === aliasName + "." + column.propertyPath; });
         })));
         // if user used partial selection and did not select some primary columns which are required to be selected
@@ -1291,7 +1313,7 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
         if (columns.length === 0) // however not in the case when nothing (even partial) was selected from this target (for example joins without selection)
             return [];
         var nonSelectedPrimaryColumns = this.expressionMap.queryEntity ? metadata.primaryColumns.filter(function (primaryColumn) { return columns.indexOf(primaryColumn) === -1; }) : [];
-        var allColumns = tslib_1.__spread(columns, nonSelectedPrimaryColumns);
+        var allColumns = __spread(columns, nonSelectedPrimaryColumns);
         return allColumns.map(function (column) {
             var selection = _this.expressionMap.selects.find(function (select) { return select.selection === aliasName + "." + column.propertyPath; });
             var selectionPath = _this.escape(aliasName) + "." + _this.escape(column.databaseName);
@@ -1323,37 +1345,61 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
             return metadata.columns.some(function (column) { return select.selection === aliasName + "." + column.propertyPath; });
         });
     };
+    SelectQueryBuilder.prototype.computeCountExpression = function () {
+        var _this = this;
+        var mainAlias = this.expressionMap.mainAlias.name; // todo: will this work with "fromTableName"?
+        var metadata = this.expressionMap.mainAlias.metadata;
+        var primaryColumns = metadata.primaryColumns;
+        var distinctAlias = this.escape(mainAlias);
+        // If we aren't doing anything that will create a join, we can use a simpler `COUNT` instead
+        // so we prevent poor query patterns in the most likely cases
+        if (this.expressionMap.joinAttributes.length === 0 &&
+            this.expressionMap.relationIdAttributes.length === 0 &&
+            this.expressionMap.relationCountAttributes.length === 0) {
+            return "COUNT(1)";
+        }
+        // For everything else, we'll need to do some hackery to get the correct count values.
+        if (this.connection.driver instanceof CockroachDriver || this.connection.driver instanceof PostgresDriver) {
+            // Postgres and CockroachDB can pass multiple parameters to the `DISTINCT` function
+            // https://www.postgresql.org/docs/9.5/sql-select.html#SQL-DISTINCT
+            return "COUNT(DISTINCT(" +
+                primaryColumns.map(function (c) { return distinctAlias + "." + _this.escape(c.databaseName); }).join(", ") +
+                "))";
+        }
+        if (this.connection.driver instanceof MysqlDriver) {
+            // MySQL & MariaDB can pass multiple parameters to the `DISTINCT` language construct
+            // https://mariadb.com/kb/en/count-distinct/
+            return "COUNT(DISTINCT " +
+                primaryColumns.map(function (c) { return distinctAlias + "." + _this.escape(c.databaseName); }).join(", ") +
+                ")";
+        }
+        if (this.connection.driver instanceof SqlServerDriver) {
+            // SQL Server has gotta be different from everyone else.  They don't support
+            // distinct counting multiple columns & they don't have the same operator
+            // characteristic for concatenating, so we gotta use the `CONCAT` function.
+            // However, If it's exactly 1 column we can omit the `CONCAT` for better performance.
+            var columnsExpression = primaryColumns.map(function (primaryColumn) { return distinctAlias + "." + _this.escape(primaryColumn.databaseName); }).join(", '|;|', ");
+            if (primaryColumns.length === 1) {
+                return "COUNT(DISTINCT(" + columnsExpression + "))";
+            }
+            return "COUNT(DISTINCT(CONCAT(" + columnsExpression + ")))";
+        }
+        // If all else fails, fall back to a `COUNT` and `DISTINCT` across all the primary columns concatenated.
+        // Per the SQL spec, this is the canonical string concatenation mechanism which is most
+        // likely to work across servers implementing the SQL standard.
+        // Please note, if there is only one primary column that the concatenation does not occur in this
+        // query and the query is a standard `COUNT DISTINCT` in that case.
+        return "COUNT(DISTINCT(" +
+            primaryColumns.map(function (c) { return distinctAlias + "." + _this.escape(c.databaseName); }).join(" || '|;|' || ") +
+            "))";
+    };
     SelectQueryBuilder.prototype.executeCountQuery = function (queryRunner) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var mainAlias, metadata, distinctAlias, countSql, results;
-            var _this = this;
-            return tslib_1.__generator(this, function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var countSql, results;
+            return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        mainAlias = this.expressionMap.mainAlias.name;
-                        metadata = this.expressionMap.mainAlias.metadata;
-                        distinctAlias = this.escape(mainAlias);
-                        countSql = "";
-                        if (metadata.hasMultiplePrimaryKeys) {
-                            if (this.connection.driver instanceof AbstractSqliteDriver) {
-                                countSql = "COUNT(DISTINCT(" + metadata.primaryColumns.map(function (primaryColumn, index) {
-                                    var propertyName = _this.escape(primaryColumn.databaseName);
-                                    return distinctAlias + "." + propertyName;
-                                }).join(" || ") + ")) as \"cnt\"";
-                            }
-                            else {
-                                countSql = "COUNT(DISTINCT(CONCAT(" + metadata.primaryColumns.map(function (primaryColumn, index) {
-                                    var propertyName = _this.escape(primaryColumn.databaseName);
-                                    return distinctAlias + "." + propertyName;
-                                }).join(", ") + "))) as \"cnt\"";
-                            }
-                        }
-                        else {
-                            countSql = "COUNT(DISTINCT(" + metadata.primaryColumns.map(function (primaryColumn, index) {
-                                var propertyName = _this.escape(primaryColumn.databaseName);
-                                return distinctAlias + "." + propertyName;
-                            }).join(", ") + ")) as \"cnt\"";
-                        }
+                        countSql = this.computeCountExpression();
                         return [4 /*yield*/, this.clone()
                                 .orderBy()
                                 .groupBy()
@@ -1361,7 +1407,7 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
                                 .limit(undefined)
                                 .skip(undefined)
                                 .take(undefined)
-                                .select(countSql)
+                                .select(countSql, "cnt")
                                 .setOption("disable-global-order")
                                 .loadRawResults(queryRunner)];
                     case 1:
@@ -1377,10 +1423,10 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Executes sql generated by query builder and returns object with raw results and entities created from them.
      */
     SelectQueryBuilder.prototype.executeEntitiesAndRawResults = function (queryRunner) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var metadata, relationIdLoader, relationCountLoader, relationIdMetadataTransformer, relationCountMetadataTransformer, rawResults, entities, _a, selects, orderBys_1, metadata_1, mainAliasName_1, querySelects, condition, parameters_1, ids, areAllNumbers, rawRelationIdResults, rawRelationCountResults, transformer, broadcastResult;
+        return __awaiter(this, void 0, void 0, function () {
+            var metadata, relationIdLoader, relationCountLoader, relationIdMetadataTransformer, relationCountMetadataTransformer, rawResults, entities, _a, selects, orderBys_1, metadata_1, mainAliasName_1, querySelects, condition, parameters_1, alias_1, ids, areAllNumbers, rawRelationIdResults, rawRelationCountResults, transformer, broadcastResult;
             var _this = this;
-            return tslib_1.__generator(this, function (_b) {
+            return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
                         if (!this.expressionMap.mainAlias)
@@ -1400,7 +1446,7 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
                         relationCountMetadataTransformer.transform();
                         rawResults = [], entities = [];
                         if (!((this.expressionMap.skip || this.expressionMap.take) && this.expressionMap.joinAttributes.length > 0)) return [3 /*break*/, 4];
-                        _a = tslib_1.__read(this.createOrderByCombinedWithSelectExpression("distinctAlias"), 2), selects = _a[0], orderBys_1 = _a[1];
+                        _a = __read(this.createOrderByCombinedWithSelectExpression("distinctAlias"), 2), selects = _a[0], orderBys_1 = _a[1];
                         metadata_1 = this.expressionMap.mainAlias.metadata;
                         mainAliasName_1 = this.expressionMap.mainAlias.name;
                         querySelects = metadata_1.primaryColumns.map(function (primaryColumn) {
@@ -1408,7 +1454,8 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
                             var columnAlias = _this.escape(DriverUtils.buildColumnAlias(_this.connection.driver, mainAliasName_1, primaryColumn.databaseName));
                             if (!orderBys_1[columnAlias]) // make sure we aren't overriding user-defined order in inverse direction
                                 orderBys_1[columnAlias] = "ASC";
-                            return distinctAlias + "." + columnAlias + " as \"ids_" + DriverUtils.buildColumnAlias(_this.connection.driver, mainAliasName_1, primaryColumn.databaseName) + "\"";
+                            var alias = DriverUtils.buildColumnAlias(_this.connection.driver, "ids_" + mainAliasName_1, primaryColumn.databaseName);
+                            return distinctAlias + "." + columnAlias + " as \"" + alias + "\"";
                         });
                         return [4 /*yield*/, new SelectQueryBuilder(this.connection, queryRunner)
                                 .select("DISTINCT " + querySelects.join(", "))
@@ -1436,7 +1483,8 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
                             }).join(" OR ");
                         }
                         else {
-                            ids = rawResults.map(function (result) { return result["ids_" + DriverUtils.buildColumnAlias(_this.connection.driver, mainAliasName_1, metadata_1.primaryColumns[0].databaseName)]; });
+                            alias_1 = DriverUtils.buildColumnAlias(this.connection.driver, "ids_" + mainAliasName_1, metadata_1.primaryColumns[0].databaseName);
+                            ids = rawResults.map(function (result) { return result[alias_1]; });
                             areAllNumbers = ids.every(function (id) { return typeof id === "number"; });
                             if (areAllNumbers) {
                                 // fixes #190. if all numbers then its safe to perform query without parameter
@@ -1492,7 +1540,7 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
         var selectString = Object.keys(orderBys)
             .map(function (orderCriteria) {
             if (orderCriteria.indexOf(".") !== -1) {
-                var _a = tslib_1.__read(orderCriteria.split("."), 2), aliasName = _a[0], propertyPath = _a[1];
+                var _a = __read(orderCriteria.split("."), 2), aliasName = _a[0], propertyPath = _a[1];
                 var alias = _this.expressionMap.findAliasByName(aliasName);
                 var column = alias.metadata.findColumnWithPropertyName(propertyPath);
                 return _this.escape(parentAlias) + "." + _this.escape(DriverUtils.buildColumnAlias(_this.connection.driver, aliasName, column.databaseName));
@@ -1507,7 +1555,7 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
         var orderByObject = {};
         Object.keys(orderBys).forEach(function (orderCriteria) {
             if (orderCriteria.indexOf(".") !== -1) {
-                var _a = tslib_1.__read(orderCriteria.split("."), 2), aliasName = _a[0], propertyPath = _a[1];
+                var _a = __read(orderCriteria.split("."), 2), aliasName = _a[0], propertyPath = _a[1];
                 var alias = _this.expressionMap.findAliasByName(aliasName);
                 var column = alias.metadata.findColumnWithPropertyName(propertyPath);
                 orderByObject[_this.escape(parentAlias) + "." + _this.escape(DriverUtils.buildColumnAlias(_this.connection.driver, aliasName, column.databaseName))] = orderBys[orderCriteria];
@@ -1527,12 +1575,12 @@ var SelectQueryBuilder = /** @class */ (function (_super) {
      * Loads raw results from the database.
      */
     SelectQueryBuilder.prototype.loadRawResults = function (queryRunner) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
+        return __awaiter(this, void 0, void 0, function () {
             var _a, sql, parameters, queryId, cacheOptions, savedQueryResultCacheOptions, results;
-            return tslib_1.__generator(this, function (_b) {
+            return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
-                        _a = tslib_1.__read(this.getQueryAndParameters(), 2), sql = _a[0], parameters = _a[1];
+                        _a = __read(this.getQueryAndParameters(), 2), sql = _a[0], parameters = _a[1];
                         queryId = sql + " -- PARAMETERS: " + JSON.stringify(parameters);
                         cacheOptions = typeof this.connection.options.cache === "object" ? this.connection.options.cache : {};
                         savedQueryResultCacheOptions = undefined;