summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/bzmpop.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/bzmpop.md')
-rw-r--r--iredis/data/commands/bzmpop.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/iredis/data/commands/bzmpop.md b/iredis/data/commands/bzmpop.md
new file mode 100644
index 0000000..dc0c077
--- /dev/null
+++ b/iredis/data/commands/bzmpop.md
@@ -0,0 +1,16 @@
+`BZMPOP` is the blocking variant of `ZMPOP`.
+
+When any of the sorted sets contains elements, this command behaves exactly like `ZMPOP`.
+When used inside a `MULTI`/`EXEC` block, this command behaves exactly like `ZMPOP`.
+When all sorted sets are empty, Redis will block the connection until another client adds members to one of the keys or until the `timeout` (a double value specifying the maximum number of seconds to block) elapses.
+A `timeout` of zero can be used to block indefinitely.
+
+See `ZMPOP` for more information.
+
+@return
+
+@array-reply: specifically:
+
+* A `nil` when no element could be popped.
+* A two-element array with the first element being the name of the key from which elements were popped, and the second element is an array of the popped elements. Every entry in the elements array is also an array that contains the member and its score.
+