typeorm 0.3.29-dev.a46eb0a → 0.3.29

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 };
         }
@@ -542,48 +532,36 @@ export class SelectQueryBuilder extends QueryBuilder {
     }
     /**
      * Sets LIMIT - maximum number of rows to be selected.
-     * NOTE that it may not work as you expect if you are using joins.
-     * If you want to implement pagination, and you are having join in your query,
-     * then use the take method instead.
+     * When joins are present, a two-query distinct-id strategy is used
+     * so that LIMIT applies to root entities rather than raw joined rows.
+     * @param limit
      */
     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;
     }
     /**
      * Sets OFFSET - selection offset.
-     * NOTE that it may not work as you expect if you are using joins.
-     * If you want to implement pagination, and you are having join in your query,
-     * then use the skip method instead.
+     * When joins are present, a two-query distinct-id strategy is used
+     * so that OFFSET applies to root entities rather than raw joined rows.
+     * @param offset
      */
     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);
@@ -1993,7 +1982,10 @@ export class SelectQueryBuilder extends QueryBuilder {
         // where we make two queries to find the data we need
         // first query find ids in skip and take range
         // and second query loads the actual data in given ids range
-        if ((this.expressionMap.skip || this.expressionMap.take) &&
+        if ((this.expressionMap.skip ||
+            this.expressionMap.take ||
+            this.expressionMap.offset ||
+            this.expressionMap.limit) &&
             this.expressionMap.joinAttributes.length > 0) {
             // we are skipping order by here because its not working in subqueries anyway
             // to make order by working we need to apply it on a distinct query
@@ -2010,6 +2002,9 @@ export class SelectQueryBuilder extends QueryBuilder {
                 return `${distinctAlias}.${columnAlias} AS ${this.escape(alias)}`;
             });
             const originalQuery = this.clone();
+            // clear limit/offset from the inner query since pagination is handled by the outer distinct query
+            originalQuery.expressionMap.limit = undefined;
+            originalQuery.expressionMap.offset = undefined;
             // preserve original timeTravel value since we set it to "false" in subquery
             const originalQueryTimeTravel = originalQuery.expressionMap.timeTravel;
             rawResults = await new SelectQueryBuilder(this.connection, queryRunner)
@@ -2020,8 +2015,8 @@ export class SelectQueryBuilder extends QueryBuilder {
                 .timeTravelQuery(false) // set it to "false" since time travel clause must appear at the very end and applies to the entire SELECT clause.
                 .getQuery()})`, "distinctAlias")
                 .timeTravelQuery(originalQueryTimeTravel)
-                .offset(this.expressionMap.skip)
-                .limit(this.expressionMap.take)
+                .offset(this.expressionMap.skip ?? this.expressionMap.offset)
+                .limit(this.expressionMap.take ?? this.expressionMap.limit)
                 .orderBy(orderBys)
                 .cache(this.expressionMap.cache && this.expressionMap.cacheId
                 ? `${this.expressionMap.cacheId}-pagination`
@@ -2064,12 +2059,14 @@ export class SelectQueryBuilder extends QueryBuilder {
                                 " IN (:...orm_distinct_ids)";
                     }
                 }
-                rawResults = await this.clone()
+                const secondQuery = this.clone()
                     .mergeExpressionMap({
                     extraAppendedAndWhereCondition: condition,
                 })
-                    .setParameters(parameters)
-                    .loadRawResults(queryRunner);
+                    .setParameters(parameters);
+                secondQuery.expressionMap.limit = undefined;
+                secondQuery.expressionMap.offset = undefined;
+                rawResults = await secondQuery.loadRawResults(queryRunner);
             }
         }
         else {
@@ -2255,14 +2252,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.
      */