typeorm 0.3.29-dev.cc07c90 → 0.3.30

package/browser/query-builder/SelectQueryBuilder.js

@@ -496,25 +496,17 @@ export class SelectQueryBuilder extends QueryBuilder {
      * calling this function will override previously set ORDER BY conditions.
      */
     orderBy(sort, order = "ASC", nulls) {
-        if (order !== undefined && order !== "ASC" && order !== "DESC")
-            throw new TypeORMError(`SelectQueryBuilder.addOrderBy "order" can accept only "ASC" and "DESC" values.`);
-        if (nulls !== undefined &&
-            nulls !== "NULLS FIRST" &&
-            nulls !== "NULLS LAST")
-            throw new TypeORMError(`SelectQueryBuilder.addOrderBy "nulls" can accept only "NULLS FIRST" and "NULLS LAST" values.`);
         if (sort) {
             if (typeof sort === "object") {
+                this.validateOrderByCondition(sort);
                 this.expressionMap.orderBys = sort;
             }
             else {
-                if (nulls) {
-                    this.expressionMap.orderBys = {
-                        [sort]: { order, nulls },
-                    };
-                }
-                else {
-                    this.expressionMap.orderBys = { [sort]: order };
-                }
+                const condition = nulls
+                    ? { [sort]: { order, nulls } }
+                    : { [sort]: order };
+                this.validateOrderByCondition(condition);
+                this.expressionMap.orderBys = condition;
             }
         }
         else {
@@ -526,12 +518,10 @@ export class SelectQueryBuilder extends QueryBuilder {
      * Adds ORDER BY condition in the query builder.
      */
     addOrderBy(sort, order = "ASC", nulls) {
-        if (order !== undefined && order !== "ASC" && order !== "DESC")
-            throw new TypeORMError(`SelectQueryBuilder.addOrderBy "order" can accept only "ASC" and "DESC" values.`);
-        if (nulls !== undefined &&
-            nulls !== "NULLS FIRST" &&
-            nulls !== "NULLS LAST")
-            throw new TypeORMError(`SelectQueryBuilder.addOrderBy "nulls" can accept only "NULLS FIRST" and "NULLS LAST" values.`);
+        const condition = nulls
+            ? { [sort]: { order, nulls } }
+            : { [sort]: order };
+        this.validateOrderByCondition(condition);
         if (nulls) {
             this.expressionMap.orderBys[sort] = { order, nulls };
         }
@@ -547,10 +537,7 @@ export class SelectQueryBuilder extends QueryBuilder {
      * then use the take method instead.
      */
     limit(limit) {
-        this.expressionMap.limit = this.normalizeNumber(limit);
-        if (this.expressionMap.limit !== undefined &&
-            isNaN(this.expressionMap.limit))
-            throw new TypeORMError(`Provided "limit" value is not a number. Please provide a numeric value.`);
+        this.expressionMap.limit = this.validateNumericInput("limit", limit);
         return this;
     }
     /**
@@ -560,30 +547,21 @@ export class SelectQueryBuilder extends QueryBuilder {
      * then use the skip method instead.
      */
     offset(offset) {
-        this.expressionMap.offset = this.normalizeNumber(offset);
-        if (this.expressionMap.offset !== undefined &&
-            isNaN(this.expressionMap.offset))
-            throw new TypeORMError(`Provided "offset" value is not a number. Please provide a numeric value.`);
+        this.expressionMap.offset = this.validateNumericInput("offset", offset);
         return this;
     }
     /**
      * Sets maximal number of entities to take.
      */
     take(take) {
-        this.expressionMap.take = this.normalizeNumber(take);
-        if (this.expressionMap.take !== undefined &&
-            isNaN(this.expressionMap.take))
-            throw new TypeORMError(`Provided "take" value is not a number. Please provide a numeric value.`);
+        this.expressionMap.take = this.validateNumericInput("take", take);
         return this;
     }
     /**
      * Sets number of entities to skip.
      */
     skip(skip) {
-        this.expressionMap.skip = this.normalizeNumber(skip);
-        if (this.expressionMap.skip !== undefined &&
-            isNaN(this.expressionMap.skip))
-            throw new TypeORMError(`Provided "skip" value is not a number. Please provide a numeric value.`);
+        this.expressionMap.skip = this.validateNumericInput("skip", skip);
         return this;
     }
     /**
@@ -1472,14 +1450,13 @@ export class SelectQueryBuilder extends QueryBuilder {
         return "";
     }
     /**
-     * Creates "LOCK" part of SQL query.
+     * @returns "LOCK" part of SQL query
      */
     createLockExpression() {
         const driver = this.connection.driver;
         let lockTablesClause = "";
         if (this.expressionMap.lockTables) {
-            if (!(DriverUtils.isPostgresFamily(driver) ||
-                driver.options.type === "cockroachdb")) {
+            if (!DriverUtils.isPostgresFamily(driver)) {
                 throw new TypeORMError("Lock tables not supported in selected driver");
             }
             if (this.expressionMap.lockTables.length < 1) {
@@ -1492,7 +1469,12 @@ export class SelectQueryBuilder extends QueryBuilder {
             onLockExpression = " NOWAIT";
         }
         else if (this.expressionMap.onLocked === "skip_locked") {
-            onLockExpression = " SKIP LOCKED";
+            if (driver.options.type === "sap") {
+                onLockExpression = " IGNORE LOCKED";
+            }
+            else {
+                onLockExpression = " SKIP LOCKED";
+            }
         }
         switch (this.expressionMap.lockMode) {
             case "pessimistic_read":
@@ -1511,6 +1493,9 @@ export class SelectQueryBuilder extends QueryBuilder {
                 else if (DriverUtils.isPostgresFamily(driver)) {
                     return " FOR SHARE" + lockTablesClause + onLockExpression;
                 }
+                else if (driver.options.type === "sap") {
+                    return (" FOR SHARE LOCK" + lockTablesClause + onLockExpression);
+                }
                 else if (driver.options.type === "oracle") {
                     return " FOR UPDATE";
                 }
@@ -1527,7 +1512,7 @@ export class SelectQueryBuilder extends QueryBuilder {
                     return " FOR UPDATE" + onLockExpression;
                 }
                 else if (DriverUtils.isPostgresFamily(driver) ||
-                    driver.options.type === "cockroachdb") {
+                    driver.options.type === "sap") {
                     return " FOR UPDATE" + lockTablesClause + onLockExpression;
                 }
                 else if (driver.options.type === "mssql") {
@@ -1536,19 +1521,24 @@ export class SelectQueryBuilder extends QueryBuilder {
                 else {
                     throw new LockNotSupportedOnGivenDriverError();
                 }
+            // deprecated, use pessimistic_write with onLocked = "skip_locked" instead
             case "pessimistic_partial_write":
                 if (DriverUtils.isPostgresFamily(driver)) {
                     return " FOR UPDATE" + lockTablesClause + " SKIP LOCKED";
                 }
+                else if (driver.options.type === "sap") {
+                    return " FOR UPDATE" + lockTablesClause + " IGNORE LOCKED";
+                }
                 else if (DriverUtils.isMySQLFamily(driver)) {
                     return " FOR UPDATE SKIP LOCKED";
                 }
                 else {
                     throw new LockNotSupportedOnGivenDriverError();
                 }
+            // deprecated, use pessimistic_write with onLocked = "nowait" instead
             case "pessimistic_write_or_fail":
                 if (DriverUtils.isPostgresFamily(driver) ||
-                    driver.options.type === "cockroachdb") {
+                    driver.options.type === "sap") {
                     return " FOR UPDATE" + lockTablesClause + " NOWAIT";
                 }
                 else if (DriverUtils.isMySQLFamily(driver)) {
@@ -1558,8 +1548,7 @@ export class SelectQueryBuilder extends QueryBuilder {
                     throw new LockNotSupportedOnGivenDriverError();
                 }
             case "for_no_key_update":
-                if (DriverUtils.isPostgresFamily(driver) ||
-                    driver.options.type === "cockroachdb") {
+                if (DriverUtils.isPostgresFamily(driver)) {
                     return (" FOR NO KEY UPDATE" +
                         lockTablesClause +
                         onLockExpression);
@@ -2255,14 +2244,6 @@ export class SelectQueryBuilder extends QueryBuilder {
         ObjectUtils.assign(this.expressionMap, expressionMap);
         return this;
     }
-    /**
-     * Normalizes a give number - converts to int if possible.
-     */
-    normalizeNumber(num) {
-        if (typeof num === "number" || num === undefined || num === null)
-            return num;
-        return Number(num);
-    }
     /**
      * Creates a query builder used to execute sql queries inside this query builder.
      */
@@ -2583,8 +2564,21 @@ export class SelectQueryBuilder extends QueryBuilder {
                     // if all properties of where are undefined we don't need to join anything
                     // this can happen when user defines map with conditional queries inside
                     if (typeof where[key] === "object") {
-                        const allAllUndefined = Object.keys(where[key]).every((k) => where[key][k] === undefined);
-                        if (allAllUndefined) {
+                        const whereKeys = Object.keys(where[key]);
+                        // empty object — no predicates to apply, skip the join
+                        if (whereKeys.length === 0) {
+                            continue;
+                        }
+                        const allUndefined = whereKeys.every((k) => where[key][k] === undefined);
+                        if (allUndefined) {
+                            const undefinedBehavior = this.connection.options
+                                .invalidWhereValuesBehavior?.undefined ||
+                                "ignore";
+                            if (undefinedBehavior === "throw") {
+                                throw new TypeORMError(`Undefined value encountered in nested relation '${alias}.${key}' of a where condition. ` +
+                                    `All properties of the nested object are undefined. ` +
+                                    `Set 'invalidWhereValuesBehavior.undefined' to 'ignore' in connection options to skip properties with undefined values.`);
+                            }
                             continue;
                         }
                     }