.::Undergrounds v3.3 Webshells::.

: / opt / redis-8 / src / commands /
Filename : xautoclaim.json
back
{
    "XAUTOCLAIM": {
        "summary": "Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member.",
        "complexity": "O(1) if COUNT is small.",
        "group": "stream",
        "since": "6.2.0",
        "arity": -6,
        "function": "xautoclaimCommand",
        "history": [
            [
                "7.0.0",
                "Added an element to the reply array, containing deleted entries the command cleared from the PEL"
            ]
        ],
        "command_flags": [
            "WRITE",
            "FAST"
        ],
        "acl_categories": [
            "STREAM"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "DELETE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "anyOf": [
                {
                    "description": "Claimed stream entries (with data, if `JUSTID` was not given).",
                    "type": "array",
                    "minItems": 3,
                    "maxItems": 3,
                    "items": [
                        {
                            "description": "Cursor for next call.",
                            "type": "string",
                            "pattern": "[0-9]+-[0-9]+"
                        },
                        {
                            "type": "array",
                            "uniqueItems": true,
                            "items": {
                                "type": "array",
                                "minItems": 2,
                                "maxItems": 2,
                                "items": [
                                    {
                                        "description": "Entry ID",
                                        "type": "string",
                                        "pattern": "[0-9]+-[0-9]+"
                                    },
                                    {
                                        "description": "Data",
                                        "type": "array",
                                        "items": {
                                            "type": "string"
                                        }
                                    }
                                ]
                            }
                        },
                        {
                            "description": "Entry IDs which no longer exist in the stream, and were deleted from the PEL in which they were found.",
                            "type": "array",
                            "items": {
                                "type": "string",
                                "pattern": "[0-9]+-[0-9]+"
                            }
                        }
                    ]
                },
                {
                    "description": "Claimed stream entries (without data, if `JUSTID` was given).",
                    "type": "array",
                    "minItems": 3,
                    "maxItems": 3,
                    "items": [
                        {
                            "description": "Cursor for next call.",
                            "type": "string",
                            "pattern": "[0-9]+-[0-9]+"
                        },
                        {
                            "type": "array",
                            "uniqueItems": true,
                            "items": {
                                "type": "string",
                                "pattern": "[0-9]+-[0-9]+"
                            }
                        },
                        {
                            "description": "Entry IDs which no longer exist in the stream, and were deleted from the PEL in which they were found.",
                            "type": "array",
                            "items": {
                                "type": "string",
                                "pattern": "[0-9]+-[0-9]+"
                            }
                        }
                    ]
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "group",
                "type": "string"
            },
            {
                "name": "consumer",
                "type": "string"
            },
            {
                "name": "min-idle-time",
                "type": "string"
            },
            {
                "name": "start",
                "type": "string"
            },
            {
                "token": "COUNT",
                "name": "count",
                "type": "integer",
                "optional": true
            },
            {
                "name": "justid",
                "token": "JUSTID",
                "type": "pure-token",
                "optional": true
            }
        ]
    }
}