GETEX

Syntax text Syntax diagram API methods

GETEX key [EX seconds | PX milliseconds | EXAT unix-time-seconds |
  PXAT unix-time-milliseconds | PERSIST]

Client:

getex(
    name: KeyT,
    ex: Optional[ExpiryT] = None,
    px: Optional[ExpiryT] = None,
    exat: Optional[AbsExpiryT] = None,
    pxat: Optional[AbsExpiryT] = None,
    persist: bool = False
) → ResponseT

GETEX(
    key: RedisArgument,
    options: GetExOptions
) → Any

getEx(
    key: String,
    params: GetExParams
) → String  // The value of key

getex(
    key: K,  // the key.
    args: GetExArgs  // the arguments for GETEX.
) → V  // V bulk-string-reply the value of key, or null when key does not exist. @since 6.1

getex(
    key: K,  // the key.
    args: GetExArgs  // the arguments for GETEX.
) → RedisFuture<V>  // V bulk-string-reply the value of key, or null when key does not exist. @since 6.1

getex(
    key: K,  // the key.
    args: GetExArgs  // the arguments for GETEX.
) → Mono<V>  // V bulk-string-reply the value of key, or null when key does not exist. @since 6.1

GetEx(
    ctx: context.Context,
    key: string,
    expiration: time.Duration
) → *StringCmd

StringGetSetExpiry(
    key: RedisKey,  // The key of the string.
    expiry: TimeSpan?,  // The exact date and time to expire at. MaxValue will remove expiry.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The value of key, or Null when key does not exist.

StringGetSetExpiry(
    key: RedisKey,  // The key of the string.
    expiry: DateTime,  // The exact date and time to expire at. MaxValue will remove expiry.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The value of key, or Null when key does not exist.

StringGetSetExpiry(
    key: RedisKey,  // The key of the string.
    expiry: TimeSpan?,  // The exact date and time to expire at. MaxValue will remove expiry.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The value of key, or Null when key does not exist.

StringGetSetExpiry(
    key: RedisKey,  // The key of the string.
    expiry: DateTime,  // The exact date and time to expire at. MaxValue will remove expiry.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The value of key, or Null when key does not exist.

StringGetSetExpiry(
    key: RedisKey,  // The key of the string.
    expiry: TimeSpan?,  // The exact date and time to expire at. MaxValue will remove expiry.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The value of key, or Null when key does not exist.

StringGetSetExpiry(
    key: RedisKey,  // The key of the string.
    expiry: DateTime,  // The exact date and time to expire at. MaxValue will remove expiry.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The value of key, or Null when key does not exist.

StringGetSetExpiry(
    key: RedisKey,  // The key of the string.
    expiry: TimeSpan?,  // The exact date and time to expire at. MaxValue will remove expiry.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The value of key, or Null when key does not exist.

StringGetSetExpiry(
    key: RedisKey,  // The key of the string.
    expiry: DateTime,  // The exact date and time to expire at. MaxValue will remove expiry.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The value of key, or Null when key does not exist.

getex(
    $key: string,
    $modifier = '': Any,
    $value = false: Any
) → int|null

get_ex(
    key: K,
    expire_at: Expiry
) → (Option<String>)

get_ex(
    key: K,
    expire_at: Expiry
) → (Option<String>)

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

Get the value of key and optionally set its expiration. GETEX is similar to GET, but is a write command with additional options.

Required arguments

key

The name of the key to retrieve.

Optional arguments

The following options modify the command's behavior. They are mutually exclusive.

EX seconds

Set the specified expire time, in seconds.

PX milliseconds

Set the specified expire time, in milliseconds.

EXAT unix-time-seconds

Set the specified Unix time at which the key will expire, in seconds.

PXAT unix-time-milliseconds

Set the specified Unix time at which the key will expire, in milliseconds.

PERSIST

Remove the time to live associated with the key. See PERSIST.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active*	✅ Standard ✅ Active-Active*	*Not supported for HyperLogLog.

Return information

RESP2 RESP3

Bulk string reply: the value of key Nil reply: if key does not exist.

Bulk string reply: the value of key Null reply: if key does not exist.