pttl.3valkey - Man Page
Returns the expiration time in milliseconds of a key.
Synopsis
PTTL
key
Description
Like TTL
this command returns the remaining time to live of a key that has an expire set, with the sole difference that TTL
returns the amount of remaining time in seconds while PTTL
returns it in milliseconds.
The command returns the following values in case of errors:
- The command returns
-2
if the key does not exist. - The command returns
-1
if the key exists but has no associated expire.
Reply
One of the following:
- valkey-protocol(7) Integer reply: TTL in milliseconds.
- valkey-protocol(7) Integer reply:
-1
if the key exists but has no associated expiration. - valkey-protocol(7) Integer reply:
-2
if the key does not exist.
Complexity
O(1)
Acl Categories
@fast @keyspace @read
History
- Available since: 2.6.0
- Changed in 2.8.0: Added the -2 reply.
Examples
127.0.0.1:6379> SET mykey "Hello" OK 127.0.0.1:6379> EXPIRE mykey 1 (integer) 1 127.0.0.1:6379> PTTL mykey (integer) 989
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), randomkey(3valkey), rename(3valkey), renamenx(3valkey), restore(3valkey), scan(3valkey), sort(3valkey), sort_ro(3valkey), touch(3valkey), ttl(3valkey), type(3valkey), unlink(3valkey), wait(3valkey), waitaof(3valkey)