diff options
Diffstat (limited to 'iredis/data/commands/pexpire.md')
-rw-r--r-- | iredis/data/commands/pexpire.md | 20 |
1 files changed, 18 insertions, 2 deletions
diff --git a/iredis/data/commands/pexpire.md b/iredis/data/commands/pexpire.md index ae5f775..bc2e6f1 100644 --- a/iredis/data/commands/pexpire.md +++ b/iredis/data/commands/pexpire.md @@ -1,12 +1,24 @@ This command works exactly like `EXPIRE` but the time to live of the key is specified in milliseconds instead of seconds. +## Options + +The `PEXPIRE` 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 @@ -15,4 +27,8 @@ SET mykey "Hello" PEXPIRE mykey 1500 TTL mykey PTTL mykey +PEXPIRE mykey 1000 XX +TTL mykey +PEXPIRE mykey 1000 NX +TTL mykey ``` |