src/commands/sscan.json


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

{
    "SSCAN": {
        "summary": "Iterates over members of a 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": "set",
        "since": "2.8.0",
        "arity": -3,
        "function": "sscanCommand",
        "command_flags": [
            "READONLY"
        ],
        "acl_categories": [
            "SET"
        ],
        "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 set members",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            ]
        }
    }
}