src/commands/xpending.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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

{
    "XPENDING": {
        "summary": "Returns the information and entries from a stream consumer group's pending entries list.",
        "complexity": "O(N) with N being the number of elements returned, so asking for a small fixed number of entries per call is O(1). O(M), where M is the total number of entries scanned when used with the IDLE filter. When the command returns just the summary and the list of consumers is small, it runs in O(1) time; otherwise, an additional O(N) time for iterating every consumer.",
        "group": "stream",
        "since": "5.0.0",
        "arity": -3,
        "function": "xpendingCommand",
        "history": [
            [
                "6.2.0",
                "Added the `IDLE` option and exclusive range intervals."
            ]
        ],
        "command_flags": [
            "READONLY"
        ],
        "acl_categories": [
            "STREAM"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT"
        ],
        "key_specs": [
            {
                "flags": [
                    "RO",
                    "ACCESS"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "description": "Extended form, in case `start` was given.",
                    "type": "array",
                    "items": {
                        "type": "array",
                        "minItems": 4,
                        "maxItems": 4,
                        "items": [
                            {
                                "description": "Entry ID",
                                "type": "string",
                                "pattern": "[0-9]+-[0-9]+"
                            },
                            {
                                "description": "Consumer name",
                                "type": "string"
                            },
                            {
                                "description": "Idle time",
                                "type": "integer"
                            },
                            {
                                "description": "Delivery count",
                                "type": "integer"
                            }
                        ]
                    }
                },
                {
                    "description": "Summary form, in case `start` was not given.",
                    "type": "array",
                    "minItems": 4,
                    "maxItems": 4,
                    "items": [
                        {
                            "description": "Total number of pending messages",
                            "type": "integer"
                        },
                        {
                            "description": "Minimal pending entry ID",
                            "type": "string",
                            "pattern": "[0-9]+-[0-9]+"
                        },
                        {
                            "description": "Maximal pending entry ID",
                            "type": "string",
                            "pattern": "[0-9]+-[0-9]+"
                        },
                        {
                            "description": "Consumers with pending messages",
                            "type": "array",
                            "items": {
                                "type": "array",
                                "minItems": 2,
                                "maxItems": 2,
                                "items": [
                                    {
                                        "description": "Consumer name",
                                        "type": "string"
                                    },
                                    {
                                        "description": "Number of pending messages",
                                        "type": "string"
                                    }
                                ]
                            }
                        }
                    ]
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "group",
                "type": "string"
            },
            {
                "name": "filters",
                "type": "block",
                "optional": true,
                "arguments": [
                    {
                        "token": "IDLE",
                        "name": "min-idle-time",
                        "type": "integer",
                        "optional": true,
                        "since": "6.2.0"
                    },
                    {
                        "name": "start",
                        "type": "string"
                    },
                    {
                        "name": "end",
                        "type": "string"
                    },
                    {
                        "name": "count",
                        "type": "integer"
                    },
                    {
                        "name": "consumer",
                        "type": "string",
                        "optional": true
                    }
                ]
            }
        ]
    }
}