summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/expireat.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/expireat.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/expireat.md')
-rw-r--r--iredis/data/commands/expireat.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/iredis/data/commands/expireat.md b/iredis/data/commands/expireat.md
new file mode 100644
index 0000000..92c4e9a
--- /dev/null
+++ b/iredis/data/commands/expireat.md
@@ -0,0 +1,31 @@
+`EXPIREAT` has the same effect and semantic as `EXPIRE`, but instead of
+specifying the number of seconds representing the TTL (time to live), it takes
+an absolute [Unix timestamp][hewowu] (seconds since January 1, 1970). A
+timestamp in the past will delete the key immediately.
+
+[hewowu]: http://en.wikipedia.org/wiki/Unix_time
+
+Please for the specific semantics of the command refer to the documentation of
+`EXPIRE`.
+
+## Background
+
+`EXPIREAT` was introduced in order to convert relative timeouts to absolute
+timeouts for the AOF persistence mode. Of course, it can be used directly to
+specify that a given key should expire at a given time in the future.
+
+@return
+
+@integer-reply, specifically:
+
+- `1` if the timeout was set.
+- `0` if `key` does not exist.
+
+@examples
+
+```cli
+SET mykey "Hello"
+EXISTS mykey
+EXPIREAT mykey 1293840000
+EXISTS mykey
+```