githubmirror/redis

src/commands/xrange.json
87 строк2 KB
Itamar Haber
Overhauls command summaries and man pages. (#11942)
29 мар 2023, 20:48
29 мар 2023, 20:480c3b8b7
{
    "XRANGE": {
        "summary": "Returns the messages from a stream within a range of IDs.",
        "complexity": "O(N) with N being the number of elements being returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).",
        "group": "stream",
        "since": "5.0.0",
        "arity": -4,
        "function": "xrangeCommand",
        "history": [
            [
                "6.2.0",
                "Added exclusive ranges."
            ]
        ],
        "command_flags": [
            "READONLY"
        ],
        "acl_categories": [
            "STREAM"
        ],
        "key_specs": [
            {
                "flags": [
                    "RO",
                    "ACCESS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "description": "Stream entries with IDs matching the specified range.",
            "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"
                        }
                    }
                ]
            }
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "start",
                "type": "string"
            },
            {
                "name": "end",
                "type": "string"
            },
            {
                "token": "COUNT",
                "name": "count",
                "type": "integer",
                "optional": true
            }
        ]
    }
}