lockForNoKeyUpdate を使います。これはLaravel 13.xのQuery Builderに追加されたメソッドで、PostgreSQLでは FOR NO KEY UPDATE を生成します。
このページは Laravel Framework 13.xの実装 を元にしています。
13.x ブランチに追加された機能が、利用中のリリースに含まれていることを確認してください。lockForUpdateとの違い
Laravelの公式ドキュメントでは、sharedLock と lockForUpdate を使った悲観的ロックが説明されています。lockForNoKeyUpdate は、その中間にある別のロックモードを、Query Builderの共通APIから選択するためのメソッドです。
FOR NO KEY UPDATE は、すべての操作を妨げないロックという意味ではありません。通常の FOR UPDATE から変更する必要がある処理だけで使い、トランザクションの境界と、実際に利用するデータベースのロック仕様を確認してください。
トランザクション内で使う
悲観的ロックは、ロックの取得と更新を同じトランザクションに含めます。次の例では、ユーザー行を取得してから残高を更新するまで、対象行の競合を制御します。DB::transaction のcallbackが正常に終わるとcommitされ、例外が投げられるとrollbackされます。公式ドキュメントが lockForUpdate について説明している通り、トランザクションで囲むことで、取得したデータが処理の完了まで変更されないようにします。
lockForNoKeyUpdate は select にロック句を追加するだけです。更新を自動的に実行したり、外部キー制約を無効にしたりするメソッドではありません。
データベースごとの生成結果
Query Builderは、接続のGrammarにロック値を問い合わせてSQLを組み立てます。Laravel Framework 13.xの実装では、PostgreSQL専用Grammarだけがfor no key update を返します。
たとえばPostgreSQL接続では、次のようなSQLになります。
? のbindingは通常のQuery Builderと同じです。
lockForNoKeyUpdate を呼び出しても、メソッド呼び出し自体がエラーになるわけではありません。ただし、PostgreSQLの FOR NO KEY UPDATE と同じ意味にはなりません。MySQLやSQL Serverでは通常の更新ロック相当へ変換され、SQLiteではロック句が出力されません。
Framework内部の処理
このメソッドはデータベースごとにQuery Builderを分岐させるのではなく、Grammarへロック値の解決を委譲します。Builder::lockForNoKeyUpdate()がgrammar->getNoKeyUpdateLock()を呼び出す。- 共通の
Grammarはtrueを返す。これは通常の更新ロックへのフォールバックを表す。 PostgresGrammarは文字列for no key updateを返す。- Grammarの
compileLockが文字列をそのまま扱い、booleanのフォールバックを各Grammarの実装に委譲する。
既存の悲観的ロックから移行する
既存のlockForUpdate を置き換える場合は、メソッド名だけを変更せず、次の点を確認します。
- 本当に外部キー検査を妨げないロックが必要か
- 本番環境の接続ドライバーがPostgreSQLか
- MySQLやSQL Serverでは通常の更新ロックへのフォールバックで問題ないか
- ロックの取得から更新・commitまでが同じトランザクションに含まれているか
- 既存の複数行ロックと取得順序が変わらないか
method_exists だけで切り替えると、利用者がPostgreSQL固有の動作を期待しているのに、別のドライバーで通常の FOR UPDATE が実行される可能性があります。