HEXPIRETIME

Syntax text Syntax diagram API methods

HEXPIRETIME key FIELDS numfields field [field ...]

Client:

hexpiretime(
    key: KeyT,  // The hash key.
    *fields: str
) → ResponseT  // Returns a list which contains for each field in the request: - `-2` if the field does not exist, or if the key does not exist. - `-1` if the field exists but has no associated expire time. - A positive integer representing the expiration Unix timestamp in seconds, if the field has an associated expiration time.

HEXPIRETIME(
    key: RedisArgument,
    fields: RedisVariadicArgument
) → Any

hexpireTime(
    key: byte[],
    fields: byte[]...
) → List<Long>

hexpireTime(
    key: String,
    fields: String...
) → List<Long>

hexpiretime(
    key: K,  // the key.
    fields: K...  // one or more fields to get the TTL for.
) → List<Long>  // a list of Long values for each of the fields provided: expiration time as a UNIX timestamp in seconds; -1 indicating the field has no expiry time set; -2 indicating there is no such field @since 6.4

hexpiretime(
    key: K,  // the key.
    fields: K...  // one or more fields to get the TTL for.
) → RedisFuture<List<Long>>  // a list of Long values for each of the fields provided: expiration time as a UNIX timestamp in seconds; -1 indicating the field has no expiry time set; -2 indicating there is no such field @since 6.4

hexpiretime(
    key: K,  // the key.
    fields: K...  // one or more fields to get the TTL for.
) → Flux<Long>  // a list of Long values for each of the fields provided: expiration time as a UNIX timestamp in seconds; -1 indicating the field has no expiry time set; -2 indicating there is no such field @since 6.4

HExpireTime(
    ctx: context.Context,
    key: string,
    fields: ...string
) → *IntSliceCmd

HashFieldGetExpireDateTime(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to get expire time.
    flags: CommandFlags  // The flags to use for this operation.
) → long[]  // Empty array if the key does not exist. Otherwise, returns the result of operation for given fields: <list type="table"> <listheader> <term>Result</term> <description>Description</description> </listheader> <item> <term>&gt; 0</term> <description>Expiration time, as a Unix timestamp in milliseconds.</description> </item> <item> <term>-1</term> <description>Field has no associated expiration time.</description> </item> <item> <term>-2</term> <description>No such field exists.</description> </item> </list>

HashFieldGetExpireDateTime(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to get expire time.
    flags: CommandFlags  // The flags to use for this operation.
) → long[]  // Empty array if the key does not exist. Otherwise, returns the result of operation for given fields: <list type="table"> <listheader> <term>Result</term> <description>Description</description> </listheader> <item> <term>&gt; 0</term> <description>Expiration time, as a Unix timestamp in milliseconds.</description> </item> <item> <term>-1</term> <description>Field has no associated expiration time.</description> </item> <item> <term>-2</term> <description>No such field exists.</description> </item> </list>

HashFieldGetExpireDateTime(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to get expire time.
    flags: CommandFlags  // The flags to use for this operation.
) → long[]  // Empty array if the key does not exist. Otherwise, returns the result of operation for given fields: <list type="table"> <listheader> <term>Result</term> <description>Description</description> </listheader> <item> <term>&gt; 0</term> <description>Expiration time, as a Unix timestamp in milliseconds.</description> </item> <item> <term>-1</term> <description>Field has no associated expiration time.</description> </item> <item> <term>-2</term> <description>No such field exists.</description> </item> </list>

HashFieldGetExpireDateTime(
    key: RedisKey,  // The key of the hash.
    hashFields: RedisValue[],  // The fields in the hash to get expire time.
    flags: CommandFlags  // The flags to use for this operation.
) → long[]  // Empty array if the key does not exist. Otherwise, returns the result of operation for given fields: <list type="table"> <listheader> <term>Result</term> <description>Description</description> </listheader> <item> <term>&gt; 0</term> <description>Expiration time, as a Unix timestamp in milliseconds.</description> </item> <item> <term>-1</term> <description>Field has no associated expiration time.</description> </item> <item> <term>-2</term> <description>No such field exists.</description> </item> </list>

hexpiretime(
    $key: string,
    $fields: array
) → array|null

hexpire_time(
    key: K,
    fields: F
) → (Vec<IntegerReplyOrNoOp>)

hexpire_time(
    key: K,
    fields: F
) → (Vec<IntegerReplyOrNoOp>)

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

Returns the absolute Unix timestamp in seconds since Unix epoch at which the given key's field(s) will expire.

See also the HPEXPIRETIME command, which returns the same information with millisecond resolution.

Required arguments

key

The name of the key that holds the hash.

FIELDS numfields field [field ...]

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

Examples

redis> HSET mykey field1 "hello" field2 "world"
(integer) 2
redis> HEXPIRE mykey 300  FIELDS 2 field1 field2
1) (integer) 1
2) (integer) 1
redis> HEXPIRETIME mykey FIELDS 2 field1 field2
1) (integer) 1715705914
2) (integer) 1715705914

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Array reply. For each field:
- Integer reply: -2 if no such field exists in the provided hash key, or the provided key does not exist.
- Integer reply: -1 if the field exists but has no associated expiration set.
- Integer reply: the expiration (Unix timestamp) in seconds.