summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/zpopmax.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2020-03-21 10:28:17 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-02-07 11:16:53 +0000
commit06cba6ccd165ca8b224797e37fccb9e63f026d77 (patch)
treee82f1bc439997ae296f2e74f8a64d84c5d95f140 /iredis/data/commands/zpopmax.md
parentInitial commit. (diff)
downloadiredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.tar.xz
iredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.zip
Adding upstream version 1.9.1.upstream/1.9.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'iredis/data/commands/zpopmax.md')
-rw-r--r--iredis/data/commands/zpopmax.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/iredis/data/commands/zpopmax.md b/iredis/data/commands/zpopmax.md
new file mode 100644
index 0000000..dea7a16
--- /dev/null
+++ b/iredis/data/commands/zpopmax.md
@@ -0,0 +1,20 @@
+Removes and returns up to `count` members with the highest scores in the sorted
+set stored at `key`.
+
+When left unspecified, the default value for `count` is 1. Specifying a `count`
+value that is higher than the sorted set's cardinality will not produce an
+error. When returning multiple elements, the one with the highest score will be
+the first, followed by the elements with lower scores.
+
+@return
+
+@array-reply: list of popped elements and scores.
+
+@examples
+
+```cli
+ZADD myzset 1 "one"
+ZADD myzset 2 "two"
+ZADD myzset 3 "three"
+ZPOPMAX myzset
+```