BZMPOP - Upstash Documentation

Use BZMPOP to pop members from the first non-empty sorted set among several, blocking until one has members or the timeout expires.

It is the blocking form of ZMPOP: keys are examined in the order given, so earlier keys act as higher priority queues, MIN or MAX chooses whether the lowest or highest scoring members are taken, and COUNT sets how many. The reply names the key that was popped from along with the members and their scores.

The timeout is in seconds, may be fractional, and 0 waits indefinitely; when it expires the reply is null. This is what a worker uses to wait on several priority queues at once without polling.

Syntax#

BZMPOP <timeout> <numkeys> <key> [<key> ...] (MIN | MAX) [COUNT <count>]

Arguments#

Argument	Required	Repeatable	Description
`<timeout>`	Yes	No	Seconds to block; `0` blocks indefinitely.
`<numkeys>`	Yes	No	Number of key arguments that follow.
`<key>`	Yes	Yes	Redis key targeted by the command.
`(MIN \| MAX)`	Yes	No	Which members to pop: `MIN` (lowest scores first) or `MAX` (highest scores first).
`COUNT <count>`	No	No	Maximum number of members to pop.

Important points#

A blocking form holds the request until data arrives or its timeout expires. Set the client/network timeout longer than the command timeout.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Null bulk string or null array, or two-element array: key and array of member/score pairs
RESP3	Null, or two-element array: key and array of member/score pairs

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

BZMPOP 1.5 1 my-key MIN

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

Note

This command is not supported yet in upstash_redis.

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.bzmpop("1.5", "1", "my-key", "MIN");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.bzmPop(1.5, "my-key", "MIN");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.bzmpop(1.5, 1, ["my-key"], min=True)print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "time"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    _, result, err := client.BZMPop(context.Background(), 1500*time.Millisecond, "min", 0, "my-key").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.bzmpop(1.5, redis.clients.jedis.args.SortedSetOption.MIN, "my-key");  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.bzmpop_min(1.5, "my-key", 1)?;    println!("{result:?}");    Ok(())}