src/commands/blmpop.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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

{
    "BLMPOP": {
        "summary": "Pops the first element from one of multiple lists. Blocks until an element is available otherwise. Deletes the list if the last element was popped.",
        "complexity": "O(N+M) where N is the number of provided keys and M is the number of elements returned.",
        "group": "list",
        "since": "7.0.0",
        "arity": -5,
        "function": "blmpopCommand",
        "get_keys_function": "blmpopGetKeys",
        "command_flags": [
            "WRITE",
            "BLOCKING"
        ],
        "acl_categories": [
            "LIST"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "ACCESS",
                    "DELETE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 2
                    }
                },
                "find_keys": {
                    "keynum": {
                        "keynumidx": 0,
                        "firstkey": 1,
                        "step": 1
                    }
                }
            }
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "description": "Operation timed-out",
                    "type": "null"
                },
                {
                    "description": "The key from which elements were popped and the popped elements",
                    "type": "array",
                    "minItems": 2,
                    "maxItems": 2,
                    "items": [
                        {
                            "description": "List key from which elements were popped.",
                            "type": "string"
                        },
                        {
                            "description": "Array of popped elements.",
                            "type": "array",
                            "minItems": 1,
                            "items": {
                                "type": "string"
                            }
                        }
                    ]
                }
            ]
        },
        "arguments": [
            {
                "name": "timeout",
                "type": "double"
            },
            {
                "name": "numkeys",
                "type": "integer"
            },
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0,
                "multiple": true
            },
            {
                "name": "where",
                "type": "oneof",
                "arguments": [
                    {
                        "name": "left",
                        "type": "pure-token",
                        "token": "LEFT"
                    },
                    {
                        "name": "right",
                        "type": "pure-token",
                        "token": "RIGHT"
                    }
                ]
            },
            {
                "token": "COUNT",
                "name": "count",
                "type": "integer",
                "optional": true
            }
        ]
    }
}