summaryrefslogtreecommitdiff
path: root/examples/redis-unstable/src/commands/xackdel.json
diff options
context:
space:
mode:
Diffstat (limited to 'examples/redis-unstable/src/commands/xackdel.json')
-rw-r--r--examples/redis-unstable/src/commands/xackdel.json109
1 files changed, 109 insertions, 0 deletions
diff --git a/examples/redis-unstable/src/commands/xackdel.json b/examples/redis-unstable/src/commands/xackdel.json
new file mode 100644
index 0000000..f33d128
--- /dev/null
+++ b/examples/redis-unstable/src/commands/xackdel.json
@@ -0,0 +1,109 @@
+{
+ "XACKDEL": {
+ "summary": "Acknowledges and deletes one or multiple messages for a stream consumer group.",
+ "complexity": "O(1) for each message ID processed.",
+ "group": "stream",
+ "since": "8.2.0",
+ "arity": -6,
+ "function": "xackdelCommand",
+ "command_flags": [
+ "WRITE",
+ "FAST"
+ ],
+ "acl_categories": [
+ "STREAM"
+ ],
+ "key_specs": [
+ {
+ "flags": [
+ "RW",
+ "UPDATE",
+ "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": "group",
+ "type": "string"
+ },
+ {
+ "name": "condition",
+ "type": "oneof",
+ "optional": true,
+ "arguments": [
+ {
+ "name": "keepref",
+ "type": "pure-token",
+ "token": "KEEPREF"
+ },
+ {
+ "name": "delref",
+ "type": "pure-token",
+ "token": "DELREF"
+ },
+ {
+ "name": "acked",
+ "type": "pure-token",
+ "token": "ACKED"
+ }
+ ]
+ },
+ {
+ "name": "ids",
+ "token": "IDS",
+ "type": "block",
+ "arguments": [
+ {
+ "name": "numids",
+ "type": "integer"
+ },
+ {
+ "name": "id",
+ "type": "string",
+ "multiple": true
+ }
+ ]
+ }
+ ],
+ "reply_schema": {
+ "description": "Array of results. Returns an array with -1 for each requested ID if the key does not exist.",
+ "type": "array",
+ "minItems": 0,
+ "maxItems": 4294967295,
+ "items": {
+ "oneOf": [
+ {
+ "description": "The id does not exist in the provided stream key.",
+ "const": -1
+ },
+ {
+ "description": "Entry was acknowledged and deleted from the stream.",
+ "const": 1
+ },
+ {
+ "description": "Entry was acknowledged but not deleted, there are still dangling references.",
+ "const": 2
+ }
+ ]
+ }
+ }
+ }
+}