examples/redis-unstable/src/commands/xreadgroup.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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180

{
    "XREADGROUP": {
        "summary": "Returns new or historical messages from a stream for a consumer in a group. Blocks until a message is available otherwise.",
        "complexity": "For each stream mentioned: O(M) with M being the number of elements returned. If M is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the O(N) time in order to serve the N clients blocked on the stream getting new data.",
        "group": "stream",
        "since": "5.0.0",
        "arity": -7,
        "function": "xreadCommand",
        "get_keys_function": "xreadGetKeys",
        "command_flags": [
            "BLOCKING",
            "WRITE"
        ],
        "acl_categories": [
            "STREAM"
        ],
        "key_specs": [
            {
                "flags": [
                    "RO",
                    "ACCESS"
                ],
                "begin_search": {
                    "keyword": {
                        "keyword": "STREAMS",
                        "startfrom": 4
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": -1,
                        "step": 1,
                        "limit": 2
                    }
                }
            }
        ],
        "arguments": [
            {
                "token": "GROUP",
                "name": "group-block",
                "type": "block",
                "arguments": [
                    {
                        "name": "group",
                        "type": "string"
                    },
                    {
                        "name": "consumer",
                        "type": "string"
                    }
                ]
            },
            {
                "token": "COUNT",
                "name": "count",
                "type": "integer",
                "optional": true
            },
            {
                "token": "BLOCK",
                "name": "milliseconds",
                "type": "integer",
                "optional": true
            },
            {
                "token": "CLAIM",
                "name": "min-idle-time",
                "type": "integer",
                "optional": true
            },
            {
                "name": "noack",
                "token": "NOACK",
                "type": "pure-token",
                "optional": true
            },
            {
                "name": "streams",
                "token": "STREAMS",
                "type": "block",
                "arguments": [
                    {
                        "name": "key",
                        "type": "key",
                        "key_spec_index": 0,
                        "multiple": true
                    },
                    {
                        "name": "ID",
                        "type": "string",
                        "multiple": true
                    }
                ]
            }
        ],
        "reply_schema": {
            "oneOf": [
                {
                    "description": "If BLOCK option is specified and the timeout expired",
                    "type": "null"
                },
                {
                    "description": "A map of key-value elements when each element composed of key name and the entries reported for that key",
                    "type": "object",
                    "additionalProperties": {
                        "description": "The entries reported for that key",
                        "type": "array",
                        "items": {
                            "oneOf": [
                                {
                                    "description": "Entry without CLAIM option",
                                    "type": "array",
                                    "minItems": 2,
                                    "maxItems": 2,
                                    "items": [
                                        {
                                            "description": "Stream id",
                                            "type": "string",
                                            "pattern": "[0-9]+-[0-9]+"
                                        },
                                        {
                                            "oneOf": [
                                                {
                                                    "description": "Array of field-value pairs",
                                                    "type": "array",
                                                    "items": {
                                                        "type": "string"
                                                    }
                                                },
                                                {
                                                    "type": "null"
                                                }
                                            ]
                                        }
                                    ]
                                },
                                {
                                    "description": "Entry with CLAIM option - includes elapsed milliseconds and delivery count",
                                    "type": "array",
                                    "minItems": 4,
                                    "maxItems": 4,
                                    "items": [
                                        {
                                            "description": "Stream id",
                                            "type": "string",
                                            "pattern": "[0-9]+-[0-9]+"
                                        },
                                        {
                                            "oneOf": [
                                                {
                                                    "description": "Array of field-value pairs",
                                                    "type": "array",
                                                    "items": {
                                                        "type": "string"
                                                    }
                                                },
                                                {
                                                    "type": "null"
                                                }
                                            ]
                                        },
                                        {
                                            "description": "Milliseconds elapsed since last delivery",
                                            "type": "integer"
                                        },
                                        {
                                            "description": "Delivery count (0 for new messages, 1+ for claimed messages)",
                                            "type": "integer"
                                        }
                                    ]
                                }
                            ]
                        }
                    }
                }
            ]
        }
    }
}