summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/pttl.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2020-03-21 10:28:17 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-02-07 11:16:53 +0000
commit06cba6ccd165ca8b224797e37fccb9e63f026d77 (patch)
treee82f1bc439997ae296f2e74f8a64d84c5d95f140 /iredis/data/commands/pttl.md
parentInitial commit. (diff)
downloadiredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.tar.xz
iredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.zip
Adding upstream version 1.9.1.upstream/1.9.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'iredis/data/commands/pttl.md')
-rw-r--r--iredis/data/commands/pttl.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/iredis/data/commands/pttl.md b/iredis/data/commands/pttl.md
new file mode 100644
index 0000000..49eea99
--- /dev/null
+++ b/iredis/data/commands/pttl.md
@@ -0,0 +1,24 @@
+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
+```