Upstash Documentation

SRANDMEMBER

Get random members.
2 min read

Use SRANDMEMBER to get random members of a 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 the same member can appear more than once.

This is the command for sampling, random selection, and inspecting an unfamiliar set. Use SPOP when the chosen members must be consumed.

Syntax#

Arguments#

ArgumentRequiredRepeatableDescription
<key>YesNoRedis key targeted by the command.
<count>NoNoNumber of members to return; a negative count may repeat members.

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.

ProtocolReply
RESP2Null bulk string or null array, Bulk string, or array of bulk-string members
RESP3Null, Bulk string, or array of bulk-string members
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
@upstash/redis
upstash_redis
ioredis
node-redis
redis-py
go-redis
jedis
redis-rs