ttl.3valkey - Man Page

Returns the expiration time in seconds of a key.

Synopsis

TTL key

Description

Returns the remaining time to live of a key that has a timeout. This introspection capability allows a Valkey client to check how many seconds a given key will continue to be part of the dataset.

The command returns the following values in case of errors:

See also the PTTL command that returns the same information with milliseconds resolution.

Reply

One of the following:

Complexity

O(1)

Acl Categories

@fast @keyspace @read

History

Examples

127.0.0.1:6379> SET mykey "Hello"
OK
127.0.0.1:6379> EXPIRE mykey 10
(integer) 1
127.0.0.1:6379> TTL mykey
(integer) 10

See Also

copy(3valkey), del(3valkey), dump(3valkey), exists(3valkey), expire(3valkey), expireat(3valkey), expiretime(3valkey), keys(3valkey), migrate(3valkey), move(3valkey), object(3valkey), object-encoding(3valkey), object-freq(3valkey), object-help(3valkey), object-idletime(3valkey), object-refcount(3valkey), persist(3valkey), pexpire(3valkey), pexpireat(3valkey), pexpiretime(3valkey), pttl(3valkey), randomkey(3valkey), rename(3valkey), renamenx(3valkey), restore(3valkey), scan(3valkey), sort(3valkey), sort_ro(3valkey), touch(3valkey), type(3valkey), unlink(3valkey), wait(3valkey), waitaof(3valkey)

Info

2024-09-23 8.0.0 Valkey Command Manual