feat: Added 'FOR UPDATE SKIP LOCKED' and 'FOR UPDATE NOWAIT' to SelectQuery

bbldn · bbldn · commit 41ff6b0fb947 · 2026-03-02T03:27:50.000+03:00
diff --git a/src/Driver/Compiler.php b/src/Driver/Compiler.php
@@ -16,6 +16,7 @@
 use Cycle\Database\Injection\Parameter;
 use Cycle\Database\Injection\ParameterInterface;
 use Cycle\Database\Query\QueryParameters;
+use Cycle\Database\Query\SelectQuery;
 
 abstract class Compiler implements CompilerInterface
 {
@@ -183,6 +184,13 @@ protected function selectQuery(QueryParameters $params, Quoter $q, array $tokens
             $this->nameWithAlias(new QueryParameters(), $q, $join['outer'], $join['alias'], true);
         }
 
+        $forUpdate = match ($tokens['forUpdate']) {
+            SelectQuery::FOR_UPDATE => 'FOR UPDATE',
+            SelectQuery::FOR_UPDATE_NOWAIT => 'FOR UPDATE NOWAIT',
+            SelectQuery::FOR_UPDATE_SKIP_LOCKED => 'FOR UPDATE SKIP LOCKED',
+            default => '',
+        };
+
         return \sprintf(
             "SELECT%s %s\nFROM %s%s%s%s%s%s%s%s%s%s%s",
             $this->optional(' ', $this->distinct($params, $q, $tokens['distinct'])),
@@ -197,7 +205,7 @@ protected function selectQuery(QueryParameters $params, Quoter $q, array $tokens
             $this->optional("\n", $this->excepts($params, $q, $tokens['except'])),
             $this->optional("\nORDER BY", $this->orderBy($params, $q, $tokens['orderBy'])),
             $this->optional("\n", $this->limit($params, $q, $tokens['limit'], $tokens['offset'])),
-            $this->optional(' ', $tokens['forUpdate'] ? 'FOR UPDATE' : ''),
+            $this->optional(' ', $forUpdate),
         );
     }
 
diff --git a/src/Driver/SQLServer/SQLServerCompiler.php b/src/Driver/SQLServer/SQLServerCompiler.php
@@ -13,6 +13,7 @@
 
 use Cycle\Database\Driver\Compiler;
 use Cycle\Database\Driver\Quoter;
+use Cycle\Database\Query\SelectQuery;
 use Cycle\Database\Driver\SQLServer\Injection\CompileJson;
 use Cycle\Database\Injection\Fragment;
 use Cycle\Database\Injection\FragmentInterface;
@@ -175,12 +176,19 @@ private function baseSelect(QueryParameters $params, Quoter $q, array $tokens):
             $this->nameWithAlias(new QueryParameters(), $q, $join['outer'], $join['alias'], true);
         }
 
+        $forUpdate = match ($tokens['forUpdate']) {
+            SelectQuery::FOR_UPDATE => 'WITH(UPDLOCK,ROWLOCK)',
+            SelectQuery::FOR_UPDATE_SKIP_LOCKED => 'WITH(UPDLOCK,READPAST)',
+            SelectQuery::FOR_UPDATE_NOWAIT => 'WITH(UPDLOCK,ROWLOCK,NOWAIT)',
+            default => '',
+        };
+
         return \sprintf(
             "SELECT%s %s\nFROM %s%s%s%s%s%s%s%s%s%s%s",
             $this->optional(' ', $this->distinct($params, $q, $tokens['distinct'])),
             $this->columns($params, $q, $tokens['columns']),
             \implode(', ', $tables),
-            $this->optional(' ', $tokens['forUpdate'] ? 'WITH (UPDLOCK,ROWLOCK)' : '', ' '),
+            $this->optional(' ', $forUpdate, ' '),
             $this->optional(' ', $this->joins($params, $q, $tokens['join']), ' '),
             $this->optional("\nWHERE", $this->where($params, $q, $tokens['where'])),
             $this->optional("\nGROUP BY", $this->groupBy($params, $q, $tokens['groupBy']), ' '),
diff --git a/src/Driver/SQLite/SQLiteCompiler.php b/src/Driver/SQLite/SQLiteCompiler.php
@@ -52,7 +52,7 @@ protected function limit(QueryParameters $params, Quoter $q, ?int $limit = null,
     protected function selectQuery(QueryParameters $params, Quoter $q, array $tokens): string
     {
         // FOR UPDATE is not available
-        $tokens['forUpdate'] = false;
+        $tokens['forUpdate'] = null;
 
         return parent::selectQuery($params, $q, $tokens);
     }
diff --git a/src/Query/SelectQuery.php b/src/Query/SelectQuery.php
@@ -42,6 +42,11 @@ class SelectQuery extends ActiveQuery implements
     public const SORT_ASC = 'ASC';
     public const SORT_DESC = 'DESC';
 
+    // for update values
+    public const FOR_UPDATE = 'FOR_UPDATE';
+    public const FOR_UPDATE_NOWAIT = 'FOR_UPDATE_NOWAIT';
+    public const FOR_UPDATE_SKIP_LOCKED = 'FOR_UPDATE_SKIP_LOCKED';
+
     protected array $tables = [];
     protected array $unionTokens = [];
     protected array $exceptTokens = [];
@@ -53,7 +58,7 @@ class SelectQuery extends ActiveQuery implements
     protected array $orderBy = [];
 
     protected array $groupBy = [];
-    protected bool $forUpdate = false;
+    protected ?string $forUpdate = null;
     private ?int $limit = null;
     private ?int $offset = null;
 
@@ -126,10 +131,12 @@ public function getColumns(): array
 
     /**
      * Select entities for the following update.
+     *
+     * @param self::FOR_UPDATE|self::FOR_UPDATE_NOWAIT|self::FOR_UPDATE_SKIP_LOCKED|null $forUpdate
      */
-    public function forUpdate(): self
+    public function forUpdate(?string $forUpdate = self::FOR_UPDATE): self
     {
-        $this->forUpdate = true;
+        $this->forUpdate = $forUpdate;
 
         return $this;
     }
diff --git a/tests/Database/Functional/Driver/Common/Query/SelectQueryTest.php b/tests/Database/Functional/Driver/Common/Query/SelectQueryTest.php
@@ -2167,6 +2167,32 @@ public function testSelectForUpdate(): void
         );
     }
 
+    public function testSelectForUpdateNoWait(): void
+    {
+        $select = $this->database->select()
+            ->from(['users'])
+            ->where('name', 'Antony')
+            ->forUpdate(SelectQuery::FOR_UPDATE_NOWAIT);
+
+        $this->assertSameQuery(
+            'SELECT * FROM {users} WHERE {name} = ? FOR UPDATE NOWAIT',
+            $select,
+        );
+    }
+
+    public function testSelectForUpdateSkipLocked(): void
+    {
+        $select = $this->database->select()
+            ->from(['users'])
+            ->where('name', 'Antony')
+            ->forUpdate(SelectQuery::FOR_UPDATE_SKIP_LOCKED);
+
+        $this->assertSameQuery(
+            'SELECT * FROM {users} WHERE {name} = ? FOR UPDATE SKIP LOCKED',
+            $select,
+        );
+    }
+
     public function testSelectWithParametricExpression(): void
     {
         $select = $this->database->select()
diff --git a/tests/Database/Functional/Driver/SQLServer/Query/SelectQueryTest.php b/tests/Database/Functional/Driver/SQLServer/Query/SelectQueryTest.php
@@ -5,6 +5,7 @@
 namespace Cycle\Database\Tests\Functional\Driver\SQLServer\Query;
 
 // phpcs:ignore
+use Cycle\Database\Query\SelectQuery;
 use Cycle\Database\Tests\Functional\Driver\Common\Query\SelectQueryTest as CommonClass;
 
 /**
@@ -113,6 +114,32 @@ public function testSelectForUpdate(): void
         );
     }
 
+    public function testSelectForUpdateNoWait(): void
+    {
+        $select = $this->database->select()
+            ->from(['users'])
+            ->where('name', 'Antony')
+            ->forUpdate(SelectQuery::FOR_UPDATE_NOWAIT);
+
+        $this->assertSameQuery(
+            'SELECT * FROM {users} WITH(UPDLOCK,ROWLOCK,NOWAIT) WHERE {name} = ?',
+            $select,
+        );
+    }
+
+    public function testSelectForUpdateSkipLocked(): void
+    {
+        $select = $this->database->select()
+            ->from(['users'])
+            ->where('name', 'Antony')
+            ->forUpdate(SelectQuery::FOR_UPDATE_SKIP_LOCKED);
+
+        $this->assertSameQuery(
+            'SELECT * FROM {users} WITH(UPDLOCK,READPAST) WHERE {name} = ?',
+            $select,
+        );
+    }
+
     public function testSelectWithWhereJson(): void
     {
         $select = $this->database
diff --git a/tests/Database/Functional/Driver/SQLite/Query/SelectQueryTest.php b/tests/Database/Functional/Driver/SQLite/Query/SelectQueryTest.php
@@ -5,6 +5,7 @@
 namespace Cycle\Database\Tests\Functional\Driver\SQLite\Query;
 
 // phpcs:ignore
+use Cycle\Database\Query\SelectQuery;
 use Cycle\Database\Tests\Functional\Driver\Common\Query\SelectQueryTest as CommonClass;
 
 /**
@@ -45,6 +46,32 @@ public function testSelectForUpdate(): void
         );
     }
 
+    public function testSelectForUpdateNoWait(): void
+    {
+        $select = $this->database->select()
+            ->from(['users'])
+            ->where('name', 'Antony')
+            ->forUpdate(SelectQuery::FOR_UPDATE_NOWAIT);
+
+        $this->assertSameQuery(
+            'SELECT * FROM {users} WHERE {name} = ?',
+            $select,
+        );
+    }
+
+    public function testSelectForUpdateSkipLocked(): void
+    {
+        $select = $this->database->select()
+            ->from(['users'])
+            ->where('name', 'Antony')
+            ->forUpdate(SelectQuery::FOR_UPDATE_SKIP_LOCKED);
+
+        $this->assertSameQuery(
+            'SELECT * FROM {users} WHERE {name} = ?',
+            $select,
+        );
+    }
+
     public function testSelectWithWhereJson(): void
     {
         $select = $this->database
diff --git a/tests/Database/Unit/Query/Tokens/SelectQueryTest.php b/tests/Database/Unit/Query/Tokens/SelectQueryTest.php
@@ -17,6 +17,7 @@ public function testBuildQuery(): void
         $select
             ->from('table')
             ->columns('name', 'value')
+            ->forUpdate(SelectQuery::FOR_UPDATE_SKIP_LOCKED)
             ->where(['name' => 'Antony'])
             ->orWhere('id', '>', 1)
             ->orderBy('name', 'ASC')
@@ -34,7 +35,7 @@ public function testBuildQuery(): void
 
         $this->assertEquals(
             [
-                'forUpdate' => false,
+                'forUpdate' => 'FOR_UPDATE_SKIP_LOCKED',
                 'from' => ['table'],
                 'join' => [],
                 'columns' => ['name', 'value'],

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ protected function limit(QueryParameters $params, Quoter $q, ?int $limit = null,`
`52`	`52`	`protected function selectQuery(QueryParameters $params, Quoter $q, array $tokens): string`
`53`	`53`	`{`
`54`	`54`	`// FOR UPDATE is not available`
`55`		`- $tokens['forUpdate'] = false;`
	`55`	`+ $tokens['forUpdate'] = null;`
`56`	`56`
`57`	`57`	`return parent::selectQuery($params, $q, $tokens);`
`58`	`58`	`}`