httl.3valkey - Man Page

HTTL key FIELDS numfields field [field...]

The HTTL command returns the remaining time to live of hash field(s) with associated expiration time(s). This introspection capability allows a Valkey client to check how many seconds a given hash field will continue to be part of the hash object.

See also the valkey-hpttl(7) HPTTL command that returns the same information with milliseconds resolution.

valkey-protocol(7) Array reply: a list of values associated with the result of getting the remaining time-to-live of the specific fields, in the same order as they are requested.

• -2: Field does not exist in the provided hash key, or the hash key is empty.
• -1: Field exists in the provided hash key, but has no expiration associated with it.
• valkey-protocol(7) Integer: The expiration time associated with the hash key field, in seconds.

O(1) for each field, so O(N) for N items when the command is called with multiple fields.

@fast @hash @read

• Available since: 9.0.0

127.0.0.1:6379> HSET myhash f1 v1 f2 v2 f3 v3
(integer) 3
27.0.0.1:6379> HEXPIRE myhash 10 FIELDS 2 f2 f3
1) (integer) 1
2) (integer) 1
127.0.0.1:6379> HTTL myhash FIELDS 4 f1 f2 f3 non-exist
1) (integer) -1
2) (integer) 8
3) (integer) 8
4) (integer) -2

hdel(3valkey), hexists(3valkey), hexpire(3valkey), hexpireat(3valkey), hexpiretime(3valkey), hget(3valkey), hgetall(3valkey), hgetex(3valkey), hincrby(3valkey), hincrbyfloat(3valkey), hkeys(3valkey), hlen(3valkey), hmget(3valkey), hmset(3valkey), hpersist(3valkey), hpexpire(3valkey), hpexpireat(3valkey), hpexpiretime(3valkey), hpttl(3valkey), hrandfield(3valkey), hscan(3valkey), hset(3valkey), hsetex(3valkey), hsetnx(3valkey), hstrlen(3valkey), hvals(3valkey)