.::Undergrounds v3.3 Webshells::.

: / opt / redis-7 / src / commands /
Filename : blpop.json
back
{
    "BLPOP": {
        "summary": "Removes and returns the first element in a list. Blocks until an element is available otherwise. Deletes the list if the last element was popped.",
        "complexity": "O(N) where N is the number of provided keys.",
        "group": "list",
        "since": "2.0.0",
        "arity": -3,
        "function": "blpopCommand",
        "history": [
            [
                "6.0.0",
                "`timeout` is interpreted as a double instead of an integer."
            ]
        ],
        "command_flags": [
            "WRITE",
            "BLOCKING"
        ],
        "acl_categories": [
            "LIST"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "ACCESS",
                    "DELETE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": -2,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "type": "null",
                    "description": "No element could be popped and timeout expired"
                },
                {
                    "description": "The key from which the element was popped and the value of the popped element",
                    "type": "array",
                    "minItems": 2,
                    "maxItems": 2,
                    "items": [
                        {
                            "description": "List key from which the element was popped.",
                            "type": "string"
                        },
                        {
                            "description": "Value of the popped element.",
                            "type": "string"
                        }
                    ]
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0,
                "multiple": true
            },
            {
                "name": "timeout",
                "type": "double"
            }
        ]
    }
}