summaryrefslogtreecommitdiffstats
path: root/src/commands/zscan.json
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/commands/zscan.json81
1 files changed, 81 insertions, 0 deletions
diff --git a/src/commands/zscan.json b/src/commands/zscan.json
new file mode 100644
index 0000000..7c69ccf
--- /dev/null
+++ b/src/commands/zscan.json
@@ -0,0 +1,81 @@
+{
+ "ZSCAN": {
+ "summary": "Iterates over members and scores of a sorted set.",
+ "complexity": "O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.",
+ "group": "sorted_set",
+ "since": "2.8.0",
+ "arity": -3,
+ "function": "zscanCommand",
+ "command_flags": [
+ "READONLY"
+ ],
+ "acl_categories": [
+ "SORTEDSET"
+ ],
+ "command_tips": [
+ "NONDETERMINISTIC_OUTPUT"
+ ],
+ "key_specs": [
+ {
+ "flags": [
+ "RO",
+ "ACCESS"
+ ],
+ "begin_search": {
+ "index": {
+ "pos": 1
+ }
+ },
+ "find_keys": {
+ "range": {
+ "lastkey": 0,
+ "step": 1,
+ "limit": 0
+ }
+ }
+ }
+ ],
+ "arguments": [
+ {
+ "name": "key",
+ "type": "key",
+ "key_spec_index": 0
+ },
+ {
+ "name": "cursor",
+ "type": "integer"
+ },
+ {
+ "token": "MATCH",
+ "name": "pattern",
+ "type": "pattern",
+ "optional": true
+ },
+ {
+ "token": "COUNT",
+ "name": "count",
+ "type": "integer",
+ "optional": true
+ }
+ ],
+ "reply_schema": {
+ "description": "cursor and scan response in array form",
+ "type": "array",
+ "minItems": 2,
+ "maxItems": 2,
+ "items": [
+ {
+ "description": "cursor",
+ "type": "string"
+ },
+ {
+ "description": "list of elements of the sorted set, where each even element is the member, and each odd value is its associated score",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ }
+ }
+}