PTTL - Upstash Documentation

Use PTTL to read how much longer a key will live, in milliseconds.

The reply is -1 when the key exists but has no expiration and -2 when the key does not exist, so a missing key and a permanent one are easy to tell apart. It is the millisecond form of TTL, and the extra precision matters for short-lived keys such as locks, where rounding to whole seconds hides most of the remaining lifetime.

Syntax#

PTTL <key>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.

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	Integer: remaining lifetime in milliseconds, `-1` if the key has no expiration, `-2` if the key does not exist
RESP3	Integer: remaining lifetime in milliseconds, `-1` if the key has no expiration, `-2` if the key does not exist

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

PTTL my-key

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const millis = await redis.pttl(key);

upstash_redis

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

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.pttl("my-key");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.pTTL("my-key");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.pttl("my-key")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.PTTL(context.Background(), "my-key").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.pttl("my-key");  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.pttl("my-key")?;    println!("{result:?}");    Ok(())}