ZPOPMIN

Syntax text Syntax diagram API methods

ZPOPMIN key [count]

Client:

zpopmin(
    name: KeyT,
    count: Optional[int] = None
) → ResponseT

ZPOPMIN(
    key: RedisArgument
) → Any

zpopmin(
    key: byte[]
) → Tuple  // The scores

zpopmin(
    key: byte[],
    count: int
) → List<Tuple>  // The scores

zpopmin(
    key: String
) → Tuple  // The scores

zpopmin(
    key: String,
    count: int
) → List<Tuple>  // The scores

zpopmin(
    key: K  // the key.
) → ScoredValue<V>  // List&lt;ScoredValue&lt;V&gt;&gt; array-reply list of popped scores and elements. @since 5.1

zpopmin(
    key: K,  // the key.
    count: long  // the number of elements to return.
) → List<ScoredValue<V>>  // List&lt;ScoredValue&lt;V&gt;&gt; array-reply list of popped scores and elements. @since 5.1

zpopmin(
    key: K  // the key.
) → RedisFuture<ScoredValue<V>>  // List&lt;ScoredValue&lt;V&gt;&gt; array-reply list of popped scores and elements. @since 5.1

zpopmin(
    key: K,  // the key.
    count: long  // the number of elements to return.
) → RedisFuture<List<ScoredValue<V>>>  // List&lt;ScoredValue&lt;V&gt;&gt; array-reply list of popped scores and elements. @since 5.1

zpopmin(
    key: K  // the key.
) → Mono<ScoredValue<V>>  // ScoredValue&lt;V&gt; array-reply list of popped scores and elements. @since 5.1

zpopmin(
    key: K,  // the key.
    count: long  // the number of elements to return.
) → Flux<ScoredValue<V>>  // ScoredValue&lt;V&gt; array-reply list of popped scores and elements. @since 5.1

ZPopMin(
    ctx: context.Context,
    key: string,
    count: ...int64
) → *ZSliceCmd

SortedSetPop(
    key: RedisKey,
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetEntry?  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    key: RedisKey,
    count: long,  // The maximum number of records to pop out of the sorted set.
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetEntry[]  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    keys: RedisKey[],  // The keys to check.
    count: long,  // The maximum number of records to pop out of the sorted set.
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetPopResult  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    key: RedisKey,
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetEntry?  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    key: RedisKey,
    count: long,  // The maximum number of records to pop out of the sorted set.
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetEntry[]  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    key: RedisKey,
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetEntry?  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    key: RedisKey,
    count: long,  // The maximum number of records to pop out of the sorted set.
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetEntry[]  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    keys: RedisKey[],  // The keys to check.
    count: long,  // The maximum number of records to pop out of the sorted set.
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetPopResult  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    key: RedisKey,
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetEntry?  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

SortedSetPop(
    key: RedisKey,
    count: long,  // The maximum number of records to pop out of the sorted set.
    order: Order,  // The order to sort by when popping items out of the set.
    flags: CommandFlags  // The flags to use for the operation.
) → SortedSetEntry[]  // A contiguous collection of sorted set entries with the key they were popped from, or Null if no non-empty sorted sets are found.

zpopmin(
    $key: string,
    int $count = 1: Any
) → array

zpopmin(
    key: K,
    count: isize
) → (Vec<String>)

zpopmin(
    key: K,
    count: isize
) → (Vec<String>)

Available since:: Redis Open Source 5.0.0
Time complexity:: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.
ACL categories:: @write, @sortedset, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Removes and returns up to count members with the lowest scores in the sorted set stored at key.

When left unspecified, the default value for count is 1. Specifying a count value that is higher than the sorted set's cardinality will not produce an error. When returning multiple elements, the one with the lowest score will be the first, followed by the elements with greater scores.

Required arguments

key

The name of the key that holds the sorted set.

Optional arguments

count

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

Examples

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Array reply: a list of popped elements and scores.