GETSET Deprecated

As of Redis version 6.2.0, this command is regarded as deprecated.

It can be replaced by SET with the GET argument when migrating or writing new code.

Syntax text Syntax diagram API methods

GETSET key value

Client:

getset(
    name: KeyT,
    value: EncodableT
) → ResponseT

GETSET(
    key: RedisArgument,
    value: RedisArgument
) → Any

getSet(
    key: String,
    value: String
) → String  // Bulk reply @deprecated Use Jedis#setGet(java.lang.String, java.lang.String).

getset(
    key: K,  // the key.
    value: V  // the value.
) → V  // V bulk-string-reply the old value stored at key, or null when key did not exist.

getset(
    key: K,  // the key.
    value: V  // the value.
) → RedisFuture<V>  // V bulk-string-reply the old value stored at key, or null when key did not exist.

getset(
    key: K,  // the key.
    value: V  // the value.
) → Mono<V>  // V bulk-string-reply the old value stored at key, or null when key did not exist.

GetSet(
    ctx: context.Context,
    key: string,
    value: interface{}
) → *StringCmd

StringGetSet(
    key: RedisKey,  // The key of the string.
    value: RedisValue,  // The value to replace the existing value with.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The old value stored at key, or Null when key did not exist.

StringGetSet(
    key: RedisKey,  // The key of the string.
    value: RedisValue,  // The value to replace the existing value with.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The old value stored at key, or Null when key did not exist.

StringGetSet(
    key: RedisKey,  // The key of the string.
    value: RedisValue,  // The value to replace the existing value with.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The old value stored at key, or Null when key did not exist.

StringGetSet(
    key: RedisKey,  // The key of the string.
    value: RedisValue,  // The value to replace the existing value with.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The old value stored at key, or Null when key did not exist.

getset(
    $key: string,
    $value: Any
) → string|null

getset(
    key: K,
    value: V
) → (Option<String>)

getset(
    key: K,
    value: V
) → (Option<String>)

Available since:: Redis Open Source 1.0.0
Time complexity:: O(1)
ACL categories:: @write, @string, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Atomically sets key to value and returns the old value stored at key. Returns an error when key exists but does not hold a string value. Any previous time to live associated with the key is discarded on successful SET operation.

Required arguments

key

The name of the key.

value

The new value to set.

Examples

Details

Design pattern

You can use GETSET with INCR to count events and reset the counter atomically. For example, you can call INCR on the key mycounter each time an event occurs. When you need to read the counter value and reset it to zero atomically, call GETSET. This can be done using GETSET mycounter "0":

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active	Deprecated as of Redis v6.2.0.

Return information

RESP2 RESP3

One of the following:

Bulk string reply: the old value stored at the key.
Nil reply: if the key does not exist.