summaryrefslogtreecommitdiffstats
path: root/src/commands/xinfo-groups.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/commands/xinfo-groups.json')
-rw-r--r--src/commands/xinfo-groups.json92
1 files changed, 92 insertions, 0 deletions
diff --git a/src/commands/xinfo-groups.json b/src/commands/xinfo-groups.json
new file mode 100644
index 0000000..a9cbe8e
--- /dev/null
+++ b/src/commands/xinfo-groups.json
@@ -0,0 +1,92 @@
+{
+ "GROUPS": {
+ "summary": "Returns a list of the consumer groups of a stream.",
+ "complexity": "O(1)",
+ "group": "stream",
+ "since": "5.0.0",
+ "arity": 3,
+ "container": "XINFO",
+ "history": [
+ [
+ "7.0.0",
+ "Added the `entries-read` and `lag` fields"
+ ]
+ ],
+ "function": "xinfoCommand",
+ "command_flags": [
+ "READONLY"
+ ],
+ "acl_categories": [
+ "STREAM"
+ ],
+ "key_specs": [
+ {
+ "flags": [
+ "RO",
+ "ACCESS"
+ ],
+ "begin_search": {
+ "index": {
+ "pos": 2
+ }
+ },
+ "find_keys": {
+ "range": {
+ "lastkey": 0,
+ "step": 1,
+ "limit": 0
+ }
+ }
+ }
+ ],
+ "reply_schema": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "consumers": {
+ "type": "integer"
+ },
+ "pending": {
+ "type": "integer"
+ },
+ "last-delivered-id": {
+ "type": "string",
+ "pattern": "[0-9]+-[0-9]+"
+ },
+ "entries-read": {
+ "oneOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "integer"
+ }
+ ]
+ },
+ "lag": {
+ "oneOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "integer"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "arguments": [
+ {
+ "name": "key",
+ "type": "key",
+ "key_spec_index": 0
+ }
+ ]
+ }
+}