diff options
Diffstat (limited to 'iredis/data/commands/expireat.md')
-rw-r--r-- | iredis/data/commands/expireat.md | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/iredis/data/commands/expireat.md b/iredis/data/commands/expireat.md index 92c4e9a..cbc10c6 100644 --- a/iredis/data/commands/expireat.md +++ b/iredis/data/commands/expireat.md @@ -11,15 +11,28 @@ Please for the specific semantics of the command refer to the documentation of ## 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. +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. + +## Options + +The `EXPIREAT` command supports a set of options: + +* `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 |