Skip to content

Commit 85955c6

Browse files
committed
docs(lock): document cache flush behavior
Signed-off-by: memleakd <[email protected]>
1 parent ce8502e commit 85955c6

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

user_guide_src/source/libraries/locks.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ support locks.
2727
storage. The File handler is suitable for a single server. For multiple
2828
application servers, use a shared handler such as Redis.
2929

30+
.. important:: Locks are stored in the configured cache handler. Clearing or
31+
flushing that cache storage, for example with ``cache()->clean()`` or a
32+
Redis ``FLUSHDB``, may remove active locks. Avoid clearing shared lock
33+
storage while lock-protected work is running, or use a dedicated cache
34+
store for locks when that separation is important.
35+
3036
*************
3137
Example Usage
3238
*************

0 commit comments

Comments
 (0)