SPOP - Upstash Documentation

Use SPOP to remove and return random members of a set.

Without a count one member is returned, or null when the key does not exist. With a count, up to that many distinct members are removed at once, capped at the size of the set, and the key is deleted when the last member is taken.

Since the read and the removal are atomic, no two callers can get the same member, which makes a set usable as a pool of unique items to hand out, such as invitation codes or shard assignments. Use SRANDMEMBER when the members should stay in the set.

Syntax#

SPOP <key> [<count>]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<count>`	No	No	Number of members to pop.

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, or array of bulk-string members
RESP3	Null, Bulk string, or set 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

SPOP my-key

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.sadd("set", "a", "b", "c");const popped = await redis.spop("set");console.log(popped); // "a"

upstash_redis

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

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.spop("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.SPop(context.Background(), "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.spop("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.spop("my-key")?;    println!("{result:?}");    Ok(())}