summaryrefslogtreecommitdiffstats
path: root/src/commands/spop.json
blob: c3954bef5ea9641e818693add6b6d6a67d39e213 (plain)
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
{
    "SPOP": {
        "summary": "Returns one or more random members from a set after removing them. Deletes the set if the last member was popped.",
        "complexity": "Without the count argument O(1), otherwise O(N) where N is the value of the passed count.",
        "group": "set",
        "since": "1.0.0",
        "arity": -2,
        "function": "spopCommand",
        "history": [
            [
                "3.2.0",
                "Added the `count` argument."
            ]
        ],
        "command_flags": [
            "WRITE",
            "FAST"
        ],
        "acl_categories": [
            "SET"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "ACCESS",
                    "DELETE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "type": "null",
                    "description": "The key does not exist."
                },
                {
                    "type": "string",
                    "description": "The removed member when 'COUNT' is not given."
                },
                {
                    "type": "array",
                    "description": "List to the removed members when 'COUNT' is given.",
                    "uniqueItems": true,
                    "items": {
                        "type": "string"
                    }
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "count",
                "type": "integer",
                "optional": true,
                "since": "3.2.0"
            }
        ]
    }
}