Redis Iris

Redis install Data types

Tools Community Docs

Login Sign up

Develop with Redis Libraries and tools Redis products

Commands

Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

SPOP

Syntax text Syntax diagram API methods

SPOP key [count]

Client:

spop(
    name: KeyT,
    count: Optional[int] = None
) → Union[Awaitable[Union[str, List, None]], str, List, None]

Possible errors

ERR syntax error: ResponseError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

sPop(
    key: RedisArgument
) → BlobStringReply | NullReply

Possible errors

ERR syntax error: SimpleError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    key: RedisKey,
    callback?: Callback<string | null>
) → Result<string | null, Context>

spop(
    key: RedisKey,
    count: number | string,
    callback?: Callback<string[]>
) → Result<string[], Context>

Possible errors

ERR syntax error: ReplyError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    key: String
) → String  // Bulk reply

spop(
    key: String,
    count: long
) → Set<String>  // Bulk reply

Possible errors

ERR syntax error: JedisDataException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    key: K  // the key.
) → V  // V bulk-string-reply the removed element, or null when key does not exist.

spop(
    key: K,  // the key.
    count: long  // number of members to pop.
) → Set<V>  // V bulk-string-reply the removed element, or null when key does not exist.

Possible errors

ERR syntax error: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    key: K  // the key.
) → RedisFuture<V>  // V bulk-string-reply the removed element, or null when key does not exist.

spop(
    key: K,  // the key.
    count: long  // number of members to pop.
) → RedisFuture<Set<V>>  // V bulk-string-reply the removed element, or null when key does not exist.

Possible errors

ERR syntax error: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    key: K  // the key.
) → Mono<V>  // V bulk-string-reply the removed element, or null when key does not exist.

spop(
    key: K,  // the key.
    count: long  // number of members to pop.
) → Flux<V>  // V bulk-string-reply the removed element, or null when key does not exist.

Possible errors

ERR syntax error: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

SPop(
    ctx: context.Context,
    key: string
) → *StringCmd

Possible errors

ERR syntax error: redis.Error

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

SetPop(
    key: RedisKey,  // The key of the set.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // An array of elements, or an empty array when key does not exist.

SetPop(
    key: RedisKey,  // The key of the set.
    count: long,  // The number of elements to return.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // An array of elements, or an empty array when key does not exist.

SetPop(
    key: RedisKey,  // The key of the set.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // An array of elements, or an empty array when key does not exist.

SetPop(
    key: RedisKey,  // The key of the set.
    count: long,  // The number of elements to return.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // An array of elements, or an empty array when key does not exist.

Possible errors

ERR syntax error: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

SetPopAsync(
    key: RedisKey,  // The key of the set.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<RedisValue>  // An array of elements, or an empty array when key does not exist.

SetPopAsync(
    key: RedisKey,  // The key of the set.
    count: long,  // The number of elements to return.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<RedisValue[]>  // An array of elements, or an empty array when key does not exist.

SetPopAsync(
    key: RedisKey,  // The key of the set.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<RedisValue>  // An array of elements, or an empty array when key does not exist.

SetPopAsync(
    key: RedisKey,  // The key of the set.
    count: long,  // The number of elements to return.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<RedisValue[]>  // An array of elements, or an empty array when key does not exist.

Possible errors

ERR syntax error: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    $key: string,
    ?int $count = null: Any
) → string|array|null

Possible errors

ERR syntax error: Predis\Response\ServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    key: String,
    count: Integer
) → String

Possible errors

ERR syntax error: Redis::CommandError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    key: K
) → Generic

Possible errors

ERR syntax error: ErrorKind::Server(ServerErrorKind::ResponseError)

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

spop(
    key: K
) → Generic

Possible errors

ERR syntax error: ErrorKind::Server(ServerErrorKind::ResponseError)

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

Available since:: Redis Open Source 1.0.0
Time complexity:: Without the count argument O(1), otherwise O(N) where N is the value of the passed count.
ACL categories:: @write, @set, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Removes and returns one or more random members from the set value store at key.

This operation is similar to SRANDMEMBER, that returns one or more random elements from a set but does not remove it.

By default, the command pops a single member from the set. When provided with the optional count argument, the reply will consist of up to count members, depending on the set's cardinality.

Required arguments

key

The name of the key that holds the set.

Optional arguments

count

The number of members to pop. Without it, a single member is popped.

Examples

redis> SADD myset "one"
(integer) 1
redis> SADD myset "two"
(integer) 1
redis> SADD myset "three"
(integer) 1
redis> SPOP myset
redis> SMEMBERS myset
1) "one"
2) "three"
redis> SADD myset "four"
(integer) 1
redis> SADD myset "five"
(integer) 1
redis> SPOP myset 3
redis> SMEMBERS myset
1) "three"

Details

Distribution of returned elements

Note that this command is not suitable when you need a guaranteed uniform distribution of the returned elements. For more information about the algorithms used for SPOP, look up both the Knuth sampling and Floyd sampling algorithms.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

One of the following:

Nil reply: if the key does not exist.
Bulk string reply: when called without the count argument, the removed member.
Array reply: when called with the count argument, a list of the removed members.

History

Starting with Redis version 3.2.0: Added the count argument.