HPTTL - Upstash Documentation

Use HPTTL to read how much longer hash fields will live, in milliseconds.

The reply holds one value per requested field, in order: the remaining lifetime, -1 when the field exists but has no expiration, and -2 when the field or the key does not exist. It is the millisecond form of HTTL, and the extra precision matters for fields that live for less than a second.

Syntax#

HPTTL <key> FIELDS <numfields> <field> [<field> ...]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`FIELDS <numfields> <field> [<field> ...]`	Yes	No	Fields to target. Give the field count first, then that many field names.

Important points#

Negative integer replies are sentinel values, not durations or timestamps; see the response description for missing or persistent data.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Array of TTL values or negative integer status codes, one per field
RESP3	Array of TTL values or negative integer status codes, one per field

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

HPTTL my-key FIELDS 1 field

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.hset("my-key", "my-field", "my-value");await redis.hpexpire("my-key", "my-field", 1000);const ttl = await redis.hpttl("my-key", "my-field");console.log(ttl); // e.g., [950]

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.hpttl("my-key", "field")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.hpttl("my-key", "FIELDS", "1", "field");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.hpTTL("my-key", "field");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.hpttl("my-key", "field")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.HPTTL(context.Background(), "my-key", "1", "field").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.hpttl("my-key", "1", "field");  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.hpttl("my-key", &["field"])?;    println!("{result:?}");    Ok(())}