.::Undergrounds v3.3 Webshells::.

: / opt / redis-8 / src / commands /
Filename : lpop.json
back
{
    "LPOP": {
        "summary": "Returns the first elements in a list after removing it. Deletes the list if the last element was popped.",
        "complexity": "O(N) where N is the number of elements returned",
        "group": "list",
        "since": "1.0.0",
        "arity": -2,
        "function": "lpopCommand",
        "history": [
            [
                "6.2.0",
                "Added the `count` argument."
            ]
        ],
        "command_flags": [
            "WRITE",
            "FAST"
        ],
        "acl_categories": [
            "LIST"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "ACCESS",
                    "DELETE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "description": "Key does not exist.",
                    "type": "null"
                },
                {
                    "description": "In case `count` argument was not given, the value of the first element.",
                    "type": "string"
                },
                {
                    "description": "In case `count` argument was given, a list of popped elements",
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            ]
        },

        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "count",
                "type": "integer",
                "optional": true,
                "since": "6.2.0"
            }
        ]
    }
}