HTTL

Syntax text Syntax diagram API methods

HTTL key FIELDS numfields field [field ...]

Client:

httl(
    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 TTL in seconds if the field has an associated expiration time.

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

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

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

httl(
    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: the time to live in seconds; or a negative value in order to signal an error. The command returns -1 if the key exists but has no associated expiration time. The command returns -2 if the key does not exist. @since 6.4

httl(
    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: the time to live in seconds; or a negative value in order to signal an error. The command returns -1 if the key exists but has no associated expiration time. The command returns -2 if the key does not exist. @since 6.4

httl(
    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: the time to live in seconds; or a negative value in order to signal an error. The command returns -1 if the key exists but has no associated expiration time. The command returns -2 if the key does not exist. @since 6.4

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

HashFieldGetTimeToLive(
    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>Time to live, 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>

HashFieldGetTimeToLive(
    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>Time to live, 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>

HashFieldGetTimeToLive(
    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>Time to live, 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>

HashFieldGetTimeToLive(
    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>Time to live, 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>

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

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

httl(
    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 remaining TTL (time to live) of a hash key's field(s) that have a set expiration. This introspection capability allows you to check how many seconds a given hash field will continue to be part of the hash key.

See also the HPTTL command that 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 remaining time to live for. numfields is the number of fields, followed by that many field names.

Examples

redis> HTTL no-key FIELDS 3 field1 field2 field3
(nil)
redis> HSET mykey field1 "hello" field2 "world"
(integer) 2
redis> HEXPIRE mykey 300 FIELDS 2 field1 field3
1) (integer) 1
2) (integer) -2
redis> HTTL mykey FIELDS 3 field1 field2 field3
1) (integer) 283
2) (integer) -1
3) (integer) -2

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 TTL in seconds.