BZPOPMAX

Argument	Required	Repeatable	Description
`<key>`	Yes	Yes	Redis key targeted by the command.
`<timeout>`	Yes	No	Seconds to block; `0` blocks indefinitely.

Argument

Required

Repeatable

Description

<key>

Yes

Redis key targeted by the command.

<timeout>

Yes

Seconds to block; 0 blocks indefinitely.

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 three-element key/member/score array
RESP3	Null, or three-element key/member/score array

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

BZPOPMAX my-key 1.5

@upstash/redis

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

upstash_redis

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.bzpopmax("my-key", "1.5");
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.bzPopMax("my-key", 1.5);
console.log(result);

redis-py

import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.bzpopmax(["my-key"], timeout=1.5)
print(result)

go-redis

package main

import (
    "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.BZPopMax(context.Background(), 1500*time.Millisecond, "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.bzpopmax(1.5, "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.bzpopmax("my-key", 1.5)?;
    println!("{result:?}");
    Ok(())
}

Redis

Command Reference

Syntax

Arguments

Important points

Response

Examples

​Syntax

​Arguments

​Important points

​Response

​Examples

Syntax

Arguments

Important points

Response

Examples