summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/blmove.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/blmove.md')
-rw-r--r--iredis/data/commands/blmove.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/iredis/data/commands/blmove.md b/iredis/data/commands/blmove.md
new file mode 100644
index 0000000..3edf4e5
--- /dev/null
+++ b/iredis/data/commands/blmove.md
@@ -0,0 +1,23 @@
+`BLMOVE` is the blocking variant of `LMOVE`. When `source` contains elements,
+this command behaves exactly like `LMOVE`. When used inside a `MULTI`/`EXEC`
+block, this command behaves exactly like `LMOVE`. When `source` is empty, Redis
+will block the connection until another client pushes to it or until `timeout`
+is reached. A `timeout` of zero can be used to block indefinitely.
+
+This command comes in place of the now deprecated `BRPOPLPUSH`. Doing
+`BLMOVE RIGHT LEFT` is equivalent.
+
+See `LMOVE` for more information.
+
+@return
+
+@bulk-string-reply: the element being popped from `source` and pushed to
+`destination`. If `timeout` is reached, a @nil-reply is returned.
+
+## Pattern: Reliable queue
+
+Please see the pattern description in the `LMOVE` documentation.
+
+## Pattern: Circular list
+
+Please see the pattern description in the `LMOVE` documentation.