summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/pexpireat.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/pexpireat.md')
-rw-r--r--iredis/data/commands/pexpireat.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/iredis/data/commands/pexpireat.md b/iredis/data/commands/pexpireat.md
index 4b3ebb7..21e2853 100644
--- a/iredis/data/commands/pexpireat.md
+++ b/iredis/data/commands/pexpireat.md
@@ -1,12 +1,24 @@
`PEXPIREAT` has the same effect and semantic as `EXPIREAT`, but the Unix time at
which the key will expire is specified in milliseconds instead of seconds.
+## Options
+
+The `PEXPIREAT` command supports a set of options since Redis 7.0:
+
+* `NX` -- Set expiry only when the key has no expiry
+* `XX` -- Set expiry only when the key has an existing expiry
+* `GT` -- Set expiry only when the new expiry is greater than current one
+* `LT` -- Set expiry only when the new expiry is less than current one
+
+A non-volatile key is treated as an infinite TTL for the purpose of `GT` and `LT`.
+The `GT`, `LT` and `NX` options are mutually exclusive.
+
@return
@integer-reply, specifically:
-- `1` if the timeout was set.
-- `0` if `key` does not exist.
+* `1` if the timeout was set.
+* `0` if the timeout was not set. e.g. key doesn't exist, or operation skipped due to the provided arguments.
@examples