summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/pttl.md
blob: 4e0807971b22c29e078019a46baea593a4b011dd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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.

In Redis 2.6 or older the command returns `-1` if the key does not exist or if the key exist but has no associated expire.

Starting with Redis 2.8 the return value in case of error changed:

* The command returns `-2` if the key does not exist.
* The command returns `-1` if the key exists but has no associated expire.

@return

@integer-reply: TTL in milliseconds, or a negative value in order to signal an error (see the description above).

@examples

```cli
SET mykey "Hello"
EXPIRE mykey 1
PTTL mykey
```