Skip to content

Commit 31d996f

Browse files
author
Mikhail Koviazin
committed
commands: specify cluster mode in scan docstring
In ValkeyCluster, the cursors are returned as a dict of primaries with names as keys and cursors as values. Mention that in help to avoid confusion. Fixes #191 Signed-off-by: Mikhail Koviazin <[email protected]>
1 parent 02ec4b0 commit 31d996f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

valkey/commands/core.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2997,7 +2997,9 @@ def scan(
29972997
) -> ResponseT:
29982998
"""
29992999
Incrementally return lists of key names. Also return a cursor
3000-
indicating the scan position.
3000+
indicating the scan position. In ValkeyCluster, the cursors are returned
3001+
as a dictionary with the primary node name as the key and the cursor as
3002+
the value.
30013003
30023004
``match`` allows for filtering the keys by pattern
30033005

0 commit comments

Comments
 (0)