ZRANDMEMBER - Upstash Documentation

Use ZRANDMEMBER to get random members of a sorted set without removing them.

Without a count one member is returned, or null when the key does not exist. A positive count returns up to that many distinct members, capped at the size of the set, while a negative count returns exactly that many members chosen independently, so repeats are possible. WITHSCORES returns each member together with its score.

Use it for sampling and random selection, and ZPOPMIN or ZPOPMAX when members should be consumed.

Syntax#

ZRANDMEMBER <key> [<count> [WITHSCORES]]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<count> [WITHSCORES]`	No	No	Number of members to return; a negative count may repeat members. `WITHSCORES` also returns each member's score.

Important points#

RESP2 represents floating-point reply values as bulk strings; RESP3 may use native double replies. Client libraries commonly decode either form to a language number.

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, Bulk string, array of members, or flat member/score array
RESP3	Null, Bulk string, array of members, or 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

ZRANDMEMBER my-key

@upstash/redis

Note

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

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.zrandmember("my-key")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.zrandmember("my-key");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.zRandMember("my-key");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.zrandmember("my-key")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "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.ZRandMember(context.Background(), "my-key", 1).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.zrandmember("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: Option<String> = connection.zrandmember("my-key", None)?;    println!("{result:?}");    Ok(())}