From 06cba6ccd165ca8b224797e37fccb9e63f026d77 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 21 Mar 2020 11:28:17 +0100 Subject: Adding upstream version 1.9.1. Signed-off-by: Daniel Baumann --- iredis/data/commands/bzpopmax.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 iredis/data/commands/bzpopmax.md (limited to 'iredis/data/commands/bzpopmax.md') diff --git a/iredis/data/commands/bzpopmax.md b/iredis/data/commands/bzpopmax.md new file mode 100644 index 0000000..a061b0e --- /dev/null +++ b/iredis/data/commands/bzpopmax.md @@ -0,0 +1,37 @@ +`BZPOPMAX` is the blocking variant of the sorted set `ZPOPMAX` primitive. + +It is the blocking version because it blocks the connection when there are no +members to pop from any of the given sorted sets. A member with the highest +score is popped from first sorted set that is non-empty, with the given keys +being checked in the order that they are given. + +The `timeout` argument is interpreted as an integer value specifying the maximum +number of seconds to block. A timeout of zero can be used to block indefinitely. + +See the [BZPOPMIN documentation][cb] for the exact semantics, since `BZPOPMAX` +is identical to `BZPOPMIN` with the only difference being that it pops members +with the highest scores instead of popping the ones with the lowest scores. + +[cb]: /commands/bzpopmin + +@return + +@array-reply: specifically: + +- A `nil` multi-bulk when no element could be popped and the timeout expired. +- A three-element multi-bulk with the first element being the name of the key + where a member was popped, the second element is the popped member itself, and + the third element is the score of the popped element. + +@examples + +``` +redis> DEL zset1 zset2 +(integer) 0 +redis> ZADD zset1 0 a 1 b 2 c +(integer) 3 +redis> BZPOPMAX zset1 zset2 0 +1) "zset1" +2) "c" +3) "2" +``` -- cgit v1.2.3