src/commands/xdel.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

{
    "XDEL": {
        "summary": "Returns the number of messages after removing them from a stream.",
        "complexity": "O(1) for each single item to delete in the stream, regardless of the stream size.",
        "group": "stream",
        "since": "5.0.0",
        "arity": -3,
        "function": "xdelCommand",
        "command_flags": [
            "WRITE",
            "FAST"
        ],
        "acl_categories": [
            "STREAM"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "DELETE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "ID",
                "type": "string",
                "multiple": true
            }
        ],
        "reply_schema": {
            "description": "The number of entries actually deleted",
            "type": "integer",
            "minimum": 0
        }
    }
}