LSET

Syntax text Syntax diagram API methods

LSET key index element

Client:

lset(
    name: KeyT,
    index: int,
    value: str
) → Union[Awaitable[str], str]

lset(
    key: byte[],
    index: long,
    value: byte[]
) → String  // OK

lset(
    key: String,
    index: long,
    value: String
) → String  // OK

lset(
    key: String,
    index: long,
    value: String
) → String  // OK

lset(
    key: K,  // the key.
    index: long,  // the index type: long.
    value: V  // the value.
) → String  // String simple-string-reply.

lset(
    key: K,  // the key.
    index: long,  // the index type: long.
    value: V  // the value.
) → RedisFuture<String>  // String simple-string-reply.

lset(
    key: K,  // the key.
    index: long,  // the index type: long.
    value: V  // the value.
) → Mono<String>  // String simple-string-reply.

LSet(
    ctx: context.Context,
    key: string,
    index: int64,
    value: interface{}
) → *StatusCmd

ListSetByIndex(
    key: RedisKey,  // The key of the list.
    index: long,  // The index to set the value at.
    value: RedisValue,  // The values to add to the list.
    flags: CommandFlags  // The flags to use for this operation.
) → void

ListSetByIndex(
    key: RedisKey,  // The key of the list.
    index: long,  // The index to set the value at.
    value: RedisValue,  // The values to add to the list.
    flags: CommandFlags  // The flags to use for this operation.
) → void

ListSetByIndex(
    key: RedisKey,  // The key of the list.
    index: long,  // The index to set the value at.
    value: RedisValue,  // The values to add to the list.
    flags: CommandFlags  // The flags to use for this operation.
) → void

ListSetByIndex(
    key: RedisKey,  // The key of the list.
    index: long,  // The index to set the value at.
    value: RedisValue,  // The values to add to the list.
    flags: CommandFlags  // The flags to use for this operation.
) → void

lset(
    $key: string,
    $index: int,
    $value: string
) → mixed

lset(
    key: K,
    index: isize,
    value: V
) → (())

lset(
    key: K,
    index: isize,
    value: V
) → (())

Available since:: Redis Open Source 1.0.0
Time complexity:: O(N) where N is the length of the list. Setting either the first or the last element of the list is O(1).
ACL categories:: @write, @list, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Sets the list element at index to element. For more information on the index argument, see LINDEX.

An error is returned for out of range indexes.

Required arguments

key

The name of the key that holds the list.

index

The zero-based index of the element to set. Negative indexes count from the tail.

element

The new value.

Examples

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Simple string reply: OK.