GET_LOCK

説明

この関数は、特定の名前（str）を持つロックを取得しようとするために使用されます。あるセッションが特定の名前のロックを正常に取得すると、他のどのセッションも同名のロックを取得しようとした場合、元のロック保持セッションがロックを解放するまでブロックされ（つまり待機させられます）。

GET_LOCK() 関数を使用して取得したロックは、RELEASE_LOCK() を実行することで明示的に解放できます。また、セッションが終了すると、正常終了または異常終了にかかわらず、そのセッションが保持しているロックは暗黙的に解放されます。

構文

GET_LOCK('str', timeout)

説明

パラメータの説明

• str: ロックの名前を指定します。文字列型です。

• timeout: ロックの解放を待機するタイムアウト時間（秒単位）を指定します。値は以下のとおりです：

  • 値は0または正の数にすることができます。
  • 負の値を指定すると、待機時間は無限になり、セッションはロックを取得するまで待続します。

戻り値

• 1を返す：ロックが正常に取得されたことを示します。この時点で GET_LOCK を呼び出したセッションがロックを所有し、他の同名のロックを取得しようとする操作は、ロックが解放されない限り失敗します。
• 0を返す：ロックの取得試行がタイムアウトにより失敗したことを示します。これは通常、ロックが別のセッションによって取得され、タイムアウト期間中に解放されなかったことを意味します。
• NULL を返す：ロックの取得試行中にエラーが発生したことを示します。これは、メモリ不足、またはロックを取得しようとしたスレッドが強制終了されたことが原因である可能性があります。

例

1. セッション1で以下のコマンドを実行し、my_lock という名前のロックを最大10秒待機して取得しようとします。

   obclient [(none)]> SELECT GET_LOCK('my_lock', 10);
   

   実行結果は次のとおりです：

   +-------------------------+
   | GET_LOCK('my_lock', 10) |
   +-------------------------+
   |                       1 |
   +-------------------------+
   1 row in set
   

   実行結果が1である場合、ロック my_lock が正常に取得されたことを示します。

2. セッション2で以下のコマンドを実行し、my_lock という名前のロックを最大10秒待機して取得しようとします。

   obclient [(none)]> SELECT GET_LOCK('my_lock', 10);
   

   実行結果は次のとおりです：

   +-------------------------+
   | GET_LOCK('my_lock', 10) |
   +-------------------------+
   |                       0 |
   +-------------------------+
   1 row in set
   

   実行結果が0である場合、ロック my_lock の取得試行がタイムアウトにより失敗したことを示します。

関連ドキュメント

RELEASE_LOCK