summaryrefslogtreecommitdiffstats
path: root/src/commands/zpopmax.json
diff options
context:
space:
mode:
Diffstat (limited to 'src/commands/zpopmax.json')
-rw-r--r--src/commands/zpopmax.json89
1 files changed, 89 insertions, 0 deletions
diff --git a/src/commands/zpopmax.json b/src/commands/zpopmax.json
new file mode 100644
index 0000000..56d86bf
--- /dev/null
+++ b/src/commands/zpopmax.json
@@ -0,0 +1,89 @@
+{
+ "ZPOPMAX": {
+ "summary": "Returns the highest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.",
+ "complexity": "O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.",
+ "group": "sorted_set",
+ "since": "5.0.0",
+ "arity": -2,
+ "function": "zpopmaxCommand",
+ "command_flags": [
+ "WRITE",
+ "FAST"
+ ],
+ "acl_categories": [
+ "SORTEDSET"
+ ],
+ "key_specs": [
+ {
+ "flags": [
+ "RW",
+ "ACCESS",
+ "DELETE"
+ ],
+ "begin_search": {
+ "index": {
+ "pos": 1
+ }
+ },
+ "find_keys": {
+ "range": {
+ "lastkey": 0,
+ "step": 1,
+ "limit": 0
+ }
+ }
+ }
+ ],
+ "reply_schema": {
+ "anyOf": [
+ {
+ "type": "array",
+ "description": "List of popped elements and scores when 'COUNT' isn't specified.",
+ "minItems": 2,
+ "maxItems": 2,
+ "items": [
+ {
+ "type": "string",
+ "description": "Popped element."
+ },
+ {
+ "type": "number",
+ "description": "Score."
+ }
+ ]
+ },
+ {
+ "type": "array",
+ "description": "List of popped elements and scores when 'COUNT' is specified.",
+ "items": {
+ "type": "array",
+ "minItems": 2,
+ "maxItems": 2,
+ "items": [
+ {
+ "type": "string",
+ "description": "Popped element."
+ },
+ {
+ "type": "number",
+ "description": "Score."
+ }
+ ]
+ }
+ }
+ ]
+ },
+ "arguments": [
+ {
+ "name": "key",
+ "type": "key",
+ "key_spec_index": 0
+ },
+ {
+ "name": "count",
+ "type": "integer",
+ "optional": true
+ }
+ ]
+ }
+}