diff options
Diffstat (limited to 'iredis/data/commands/set.md')
| -rw-r--r-- | iredis/data/commands/set.md | 27 |
1 files changed, 22 insertions, 5 deletions
diff --git a/iredis/data/commands/set.md b/iredis/data/commands/set.md index 2cf4afa..8f5c302 100644 --- a/iredis/data/commands/set.md +++ b/iredis/data/commands/set.md @@ -8,24 +8,41 @@ The `SET` command supports a set of options that modify its behavior: - `EX` _seconds_ -- Set the specified expire time, in seconds. - `PX` _milliseconds_ -- Set the specified expire time, in milliseconds. +- `EXAT` _timestamp-seconds_ -- Set the specified Unix time at which the key + will expire, in seconds. +- `PXAT` _timestamp-milliseconds_ -- Set the specified Unix time at which the + key will expire, in milliseconds. - `NX` -- Only set the key if it does not already exist. - `XX` -- Only set the key if it already exist. - `KEEPTTL` -- Retain the time to live associated with the key. +- `GET` -- Return the old string stored at key, or nil if key did not exist. An + error is returned and `SET` aborted if the value stored at key is not a + string. -Note: Since the `SET` command options can replace `SETNX`, `SETEX`, `PSETEX`, it -is possible that in future versions of Redis these three commands will be +Note: Since the `SET` command options can replace `SETNX`, `SETEX`, `PSETEX`, +`GETSET`, it is possible that in future versions of Redis these commands will be deprecated and finally removed. @return -@simple-string-reply: `OK` if `SET` was executed correctly. @nil-reply: a Null -Bulk Reply is returned if the `SET` operation was not performed because the user +@simple-string-reply: `OK` if `SET` was executed correctly. + +@nil-reply: `(nil)` if the `SET` operation was not performed because the user specified the `NX` or `XX` option but the condition was not met. +If the command is issued with the `GET` option, the above does not apply. It +will instead reply as follows, regardless if the `SET` was actually performed: + +@bulk-string-reply: the old string value stored at key. + +@nil-reply: `(nil)` if the key did not exist. + @history - `>= 2.6.12`: Added the `EX`, `PX`, `NX` and `XX` options. - `>= 6.0`: Added the `KEEPTTL` option. +- `>= 6.2`: Added the `GET`, `EXAT` and `PXAT` option. +- `>= 7.0`: Allowed the `NX` and `GET` options to be used together. @examples @@ -39,7 +56,7 @@ SET anotherkey "will expire in a minute" EX 60 ## Patterns **Note:** The following pattern is discouraged in favor of -[the Redlock algorithm](http://redis.io/topics/distlock) which is only a bit +[the Redlock algorithm](https://redis.io/topics/distlock) which is only a bit more complex to implement, but offers better guarantees and is fault tolerant. The command `SET resource-name anystring NX EX max-lock-time` is a simple way to |