SET key value [NX | XX] [GET] [EX seconds | PX milliseconds | EXAT unix-time-seconds | PXAT unix-time-milliseconds | KEEPTTL]
- Available since:
- Time complexity:
- ACL categories:
key to hold the string
key already holds a value, it is overwritten, regardless of its type.
Any previous time to live associated with the key is discarded on successful
SET command supports a set of options that modify its behavior:
EXseconds -- Set the specified expire time, in seconds.
PXmilliseconds -- Set the specified expire time, in milliseconds.
EXATtimestamp-seconds -- Set the specified Unix time at which the key will expire, in seconds.
PXATtimestamp-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
SETaborted if the value stored at key is not a string.
Simple string reply:
SET was executed correctly.
(nil) if the
SET operation was not performed because the user specified the
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) if the key did not exist.
Note: The following pattern is discouraged in favor of the Redlock algorithm which is only a bit more complex to implement, but offers better guarantees and is fault tolerant.
SET resource-name anystring NX EX max-lock-time is a simple way to implement a locking system with Redis.
A client can acquire the lock if the above command returns
OK (or retry after some time if the command returns Nil), and remove the lock just using
The lock will be auto-released after the expire time is reached.
It is possible to make this system more robust modifying the unlock schema as follows:
- Instead of setting a fixed string, set a non-guessable large random string, called token.
- Instead of releasing the lock with
DEL, send a script that only removes the key if the value matches.
This avoids that a client will try to release the lock after the expire time deleting the key created by another client that acquired the lock later.
An example of unlock script would be similar to the following:
if redis.call("get",KEYS) == ARGV then return redis.call("del",KEYS) else return 0 end
The script should be called with
EVAL ...script... 1 resource-name token-value
- Starting with Redis version 2.6.12: Added the
- Starting with Redis version 6.0.0: Added the
- Starting with Redis version 6.2.0: Added the
- Starting with Redis version 7.0.0: Allowed the
GEToptions to be used together.