HPEXPIRETIME

Syntax text Syntax diagram API methods

HPEXPIRETIME key FIELDS numfields field [field ...]

Client:

hpexpiretime(
    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 milliseconds, if the field has an associated expiration time.

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

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

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

hpexpiretime(
    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 milliseconds; -1 indicating the field has no expiry time set; -2 indicating there is no such field @since 6.4

hpexpiretime(
    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 milliseconds; -1 indicating the field has no expiry time set; -2 indicating there is no such field @since 6.4

hpexpiretime(
    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 milliseconds; -1 indicating the field has no expiry time set; -2 indicating there is no such field @since 6.4

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

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

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

hpexpire_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

HPEXPIRETIME has the same semantics as HEXPIRETIME, but returns the absolute Unix expiration timestamp in milliseconds since Unix epoch instead of seconds.

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> HPEXPIRETIME mykey FIELDS 2 field1 field2
1) (integer) 1715705913659
2) (integer) 1715705913659

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 milliseconds.