HGETEX

Syntax text Syntax diagram API methods

HGETEX key [EX seconds | PX milliseconds | EXAT unix-time-seconds |
  PXAT unix-time-milliseconds | PERSIST] FIELDS numfields field
  [field ...]

Client:

hgetex(
    name: KeyT,
    *keys: str,
    ex: Optional[ExpiryT] = None,
    px: Optional[ExpiryT] = None,
    exat: Optional[AbsExpiryT] = None,
    pxat: Optional[AbsExpiryT] = None,
    persist: bool = False
) → Union[

hgetex(
    key: String,
    params: HGetExParams,
    fields: String...
) → List<String>  // Bulk reply

hgetex(
    key: K,  // the key.
    fields: K...  // fields to retrieve.
) → List<KeyValue<K, V>>  // Long the number of fields that were removed from the hash.

hgetex(
    key: K,  // the key.
    hGetExArgs: HGetExArgs,  // hgetex arguments.
    fields: K...  // fields to retrieve.
) → List<KeyValue<K, V>>  // Long the number of fields that were removed from the hash.

hgetex(
    channel: KeyValueStreamingChannel<K, V>,  // the channel.
    key: K,  // the key.
    hGetExArgs: HGetExArgs,  // hgetex arguments.
    fields: K...  // fields to retrieve.
) → Long  // Long the number of fields that were removed from the hash.

hgetex(
    key: K,  // the key.
    fields: K...  // fields to retrieve.
) → RedisFuture<List<KeyValue<K, V>>>  // Long the number of fields that were removed from the hash.

hgetex(
    key: K,  // the key.
    hGetExArgs: HGetExArgs,  // hgetex arguments.
    fields: K...  // fields to retrieve.
) → RedisFuture<List<KeyValue<K, V>>>  // Long the number of fields that were removed from the hash.

hgetex(
    channel: KeyValueStreamingChannel<K, V>,  // the channel.
    key: K,  // the key.
    hGetExArgs: HGetExArgs,  // hgetex arguments.
    fields: K...  // fields to retrieve.
) → RedisFuture<Long>  // Long the number of fields that were removed from the hash.

hgetex(
    key: K,  // the key.
    fields: K...  // fields to retrieve.
) → Flux<KeyValue<K, V>>  // Long the number of fields that were removed from the hash.

hgetex(
    key: K,  // the key.
    hGetExArgs: HGetExArgs,  // hgetex arguments.
    fields: K...  // fields to retrieve.
) → Flux<KeyValue<K, V>>  // Long the number of fields that were removed from the hash.

hgetex(
    channel: KeyValueStreamingChannel<K, V>,  // the channel.
    key: K,  // the key.
    hGetExArgs: HGetExArgs,  // hgetex arguments.
    fields: K...  // fields to retrieve.
) → Mono<Long>  // Long the number of fields that were removed from the hash.

HGetEX(
    ctx: context.Context,
    key: string,
    fields: ...string
) → *StringSliceCmd

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,
    expiry: TimeSpan?,  // The exact date and time to set the expiration to.
    persist: bool,
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,
    expiry: DateTime,  // The exact date and time to set the expiration to.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to get and set the expiration for.
    expiry: TimeSpan?,  // The exact date and time to set the expiration to.
    persist: bool,
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to get and set the expiration for.
    expiry: DateTime,  // The exact date and time to set the expiration to.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,
    expiry: TimeSpan?,  // The exact date and time to set the expiration to.
    persist: bool,
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,
    expiry: TimeSpan?,  // The exact date and time to set the expiration to.
    persist: bool,
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,
    expiry: DateTime,  // The exact date and time to set the expiration to.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to get and set the expiration for.
    expiry: TimeSpan?,  // The exact date and time to set the expiration to.
    persist: bool,
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to get and set the expiration for.
    expiry: DateTime,  // The exact date and time to set the expiration to.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue[]  // The values of the specified hash fields.

HashFieldGetAndSetExpiry(
    key: RedisKey,  // The key of the hash.
    hashField: RedisValue,
    expiry: TimeSpan?,  // The exact date and time to set the expiration to.
    persist: bool,
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The values of the specified hash fields.

hgetex(
    $key: string,
    $fields: array,
    string $modifier = HGETEX::NULL: Any,
    int|bool $modifierValue = false: Any
) → array|null

hget_ex(
    key: K,
    fields: F,
    expire_at: Expiry
) → (Vec<String>)

hget_ex(
    key: K,
    fields: F,
    expire_at: Expiry
) → (Vec<String>)

Available since:: Redis Open Source 8.0.0
Time complexity:: O(N) where N is the number of specified fields
ACL categories:: @write, @hash, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

Get the value of one or more fields of a given hash key and optionally set their expiration time or time-to-live (TTL).

Required arguments

key

The name of the key that holds the hash.

FIELDS numfields field [field ...]

The hash fields to retrieve. numfields is the number of fields, followed by that many field names.

Optional arguments

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

EX seconds

Set the specified expiration time, in seconds.

PX milliseconds

Set the specified expiration time, in milliseconds.

EXAT unix-time-seconds

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

PXAT unix-time-milliseconds

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

PERSIST

Remove the TTL associated with the fields.

Examples

redis> HSET mykey field1 "Hello" field2 "World"
(integer) 2
redis> HGETEX mykey EX 120 FIELDS 1 field1
1) "Hello"
redis> HGETEX mykey EX 100 FIELDS 1 field2
1) "World"
redis> HTTL mykey FIELDS 2 field1 field2
1) (integer) 91
2) (integer) 85
redis> HTTL mykey FIELDS 3 field1 field2 field3 
1) (integer) 75
2) (integer) 68
3) (integer) -2
...
redis> HTTL mykey FIELDS 3 field1 field2 
1) (integer) -2
2) (integer) -2
redis> HGETALL mykey
(empty array)

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 values associated with the given fields, in the same order as they are requested.