add lock method to SelectQueryBuilder

typeorm#2037
loyaltylion · Nov 18, 2020 · a2f76b3 · a2f76b3
1 parent d60305e
commit a2f76b3
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/src/query-builder/QueryExpressionMap.ts b/src/query-builder/QueryExpressionMap.ts
@@ -162,6 +162,12 @@ export class QueryExpressionMap {
      * By default the soft-deleted rows are not included.
      */
     withDeleted: boolean = false;
+
+    /** 
+     * Locking clause.
+     * 
+     */
+    lockClause?: string;
 
     /**
      * Parameters used to be escaped in final query.

diff --git a/src/query-builder/SelectQueryBuilder.ts b/src/query-builder/SelectQueryBuilder.ts
@@ -1012,13 +1012,21 @@ export class SelectQueryBuilder<Entity> extends QueryBuilder<Entity> implements
     }
 
     /**
-     * Disables the global condition of "non-deleted" for the entity with delete date columns.
      */
     withDeleted(): this {
         this.expressionMap.withDeleted = true;
         return this;
     }
 
+    /**
+     * Set a lock clause, passed directly into the query.
+     * If set, will override `lockMode`.
+     */
+    lock(clause: string): this {
+        this.expressionMap.lockClause = clause;
+        return this;
+    }
+
     /**
      * Gets first raw result returned by execution of generated query builder sql.
      */
@@ -1690,6 +1698,11 @@ export class SelectQueryBuilder<Entity> extends QueryBuilder<Entity> implements
      */
     protected createLockExpression(): string {
         const driver = this.connection.driver;
+
+        if (this.expressionMap.lockClause) {
+            return ` ${this.expressionMap.lockClause}`;
+        }
+
         switch (this.expressionMap.lockMode) {
             case "pessimistic_read":
                 if (driver instanceof MysqlDriver || driver instanceof AuroraDataApiDriver) {