LREM

Syntax text Syntax diagram API methods

LREM key count element

Client:

lrem(
    name: KeyT,
    count: int,
    value: str
) → Union[Awaitable[int], int]

lrem(
    key: byte[],
    count: long,
    value: byte[]
) → long  // The number of removed elements if the operation succeeded

lrem(
    key: String,
    count: long,
    value: String
) → long  // The number of removed elements if the operation succeeded

lrem(
    key: String,
    count: long,
    value: String
) → long  // The number of removed elements if the operation succeeded

lrem(
    key: K,  // the key.
    count: long,  // the count type: long.
    value: V  // the value.
) → Long  // Long integer-reply the number of removed elements.

lrem(
    key: K,  // the key.
    count: long,  // the count type: long.
    value: V  // the value.
) → RedisFuture<Long>  // Long integer-reply the number of removed elements.

lrem(
    key: K,  // the key.
    count: long,  // the count type: long.
    value: V  // the value.
) → Mono<Long>  // Long integer-reply the number of removed elements.

LRem(
    ctx: context.Context,
    key: string,
    count: int64,
    value: interface{}
) → *IntCmd

ListRemove(
    key: RedisKey,  // The key of the list.
    value: RedisValue,  // The value to remove from the list.
    count: long,  // The count behavior (see method summary).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of removed elements.

ListRemove(
    key: RedisKey,  // The key of the list.
    value: RedisValue,  // The value to remove from the list.
    count: long,  // The count behavior (see method summary).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of removed elements.

ListRemove(
    key: RedisKey,  // The key of the list.
    value: RedisValue,  // The value to remove from the list.
    count: long,  // The count behavior (see method summary).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of removed elements.

ListRemove(
    key: RedisKey,  // The key of the list.
    value: RedisValue,  // The value to remove from the list.
    count: long,  // The count behavior (see method summary).
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of removed elements.

lrem(
    $key: string,
    $count: int,
    $value: string
) → int

lrem(
    key: K,
    count: isize,
    value: V
) → (usize)

lrem(
    key: K,
    count: isize,
    value: V
) → (usize)

Available since:: Redis Open Source 1.0.0
Time complexity:: O(N+M) where N is the length of the list and M is the number of elements removed.
ACL categories:: @write, @list, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Removes the first count occurrences of elements equal to element from the list stored at key. The count argument influences the operation in the following ways:

count > 0: Remove elements equal to element moving from head to tail.
count < 0: Remove elements equal to element moving from tail to head.
count = 0: Remove all elements equal to element.

For example, LREM list -2 "hello" will remove the last two occurrences of "hello" in the list stored at key.

Note that non-existing keys are treated like empty lists, so when key does not exist, the command will always return 0.

Required arguments

key

The name of the key that holds the list.

count

The number of matching elements to remove and the direction: a positive value removes from the head, a negative value from the tail, and 0 removes all matches.

element

The value to remove.

Examples

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Integer reply: the number of removed elements.