{"id":26154,"date":"2022-06-24T12:02:14","date_gmt":"2022-06-24T02:02:14","guid":{"rendered":"https:\/\/database.guide\/?p=26154"},"modified":"2022-06-27T11:58:08","modified_gmt":"2022-06-27T01:58:08","slug":"redis-pexpireat-command-explained","status":"publish","type":"post","link":"https:\/\/database.guide\/redis-pexpireat-command-explained\/","title":{"rendered":"Redis PEXPIREAT Command Explained"},"content":{"rendered":"\n

The Redis PEXPIREAT<\/code> command sets a timeout as a Unix timestamp on a given key in milliseconds. It works the same as the EXPIREAT<\/a><\/code> command, except that it sets the timeout in milliseconds instead of seconds.<\/p>\n\n\n\n

It’s also similar to the PEXPIRE<\/a><\/code> command, but with an absolute Unix timestamp instead of a time interval.<\/p>\n\n\n\n\n\n\n\n

Syntax<\/h2>\n\n\n\n

The syntax goes like this:<\/p>\n\n\n\n

PEXPIREAT key unix-time-milliseconds [ NX | XX | GT | LT]<\/code><\/pre>\n\n\n\n
Explanation of arguments:<\/p>\n\n\n\n
key<\/em><\/code><\/td>The key for which to set the timeout.<\/td><\/tr>
unix-time-milliseconds<\/em><\/code><\/td>The absolute Unix timestamp of the timeout in milliseconds.<\/td><\/tr>
NX<\/code><\/td>Sets an expiry only when the key has no expiry.<\/td><\/tr>
XX<\/code><\/td>Sets an expiry only when the key has an existing expiry.<\/td><\/tr>
GT<\/code><\/td>Sets an expiry only when the new expiry is greater than current one.<\/td><\/tr>
LT<\/code><\/td>Sets an expiry only when the new expiry is less than current one.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
The NX<\/code>, XX<\/code>, GT<\/code>, and LT<\/code> arguments were introduced in Redis 7.0.0.<\/p>\n\n\n\n
See the Redis documentation<\/a> for any changes since this article was written.<\/p>\n\n\n\n
Example<\/h2>\n\n\n\n
Suppose we set a key:<\/p>\n\n\n\n
SET beverage \"Coffee\"<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
OK<\/pre>\n\n\n\n
We didn’t set an expiry for this key, so when I run the PTTL<\/a><\/code> command against it:<\/p>\n\n\n\n
PTTL beverage<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) -1<\/pre>\n\n\n\n
We get an integer reply of -1<\/code> (which means it has no expiry).<\/p>\n\n\n\n
Now let’s use PEXPIREAT<\/code> to set an expiry:<\/p>\n\n\n\n
PEXPIREAT beverage 1656040209088<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 1<\/pre>\n\n\n\n
I got an integer reply of 1, which means it was successful. Here, I set the expiry to an absolute Unix time of 1656040209088 (in milliseconds). This means that if I want to use the key, I’ll need to do so before that Unix time (unless I change the timeout to a different value).<\/p>\n\n\n\n
Let’s check its time to live:<\/p>\n\n\n\n
PTTL beverage<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 86290741<\/pre>\n\n\n\n
So we still have plenty of time left.<\/p>\n\n\n\n
We can also use the PEXPIRETIME<\/a><\/code> to check the absolute Unix timestamp of the expiry:<\/p>\n\n\n\n
PEXPIRETIME beverage<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 1656040209088<\/pre>\n\n\n\n
So it’s exactly as we specified. <\/p>\n\n\n\n
Note that the PEXPIRETIME<\/code> command was introduced in 7.0.0.<\/p>\n\n\n\n
The NX<\/code> Argument<\/h2>\n\n\n\n
The NX<\/code> argument was introduced in Redis 7.0.0. <\/p>\n\n\n\n
We can use the NX<\/code> argument to set the timeout only if the key doesn’t already have an expiry. <\/p>\n\n\n\n
To demonstrate this, let’s first try to set the expiry on the key that we used in the previous example:<\/p>\n\n\n\n
PEXPIREAT beverage 1656040209080 NX<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 0<\/pre>\n\n\n\n
It doesn’t work. We get an integer reply of 0<\/code>, which means that the timeout wasn’t set.<\/p>\n\n\n\n
Let’s remove the expiry:<\/p>\n\n\n\n
PERSIST beverage<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 1<\/pre>\n\n\n\n
And try again:<\/p>\n\n\n\n
PEXPIREAT beverage 1656040209080 NX<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 1<\/pre>\n\n\n\n
This time we were successful.<\/p>\n\n\n\n
Let’s check the time to live:<\/p>\n\n\n\n
PTTL beverage<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 84844859<\/pre>\n\n\n\n
Yes, it worked as expected.<\/p>\n\n\n\n
The XX<\/code> Argument<\/h2>\n\n\n\n
The XX<\/code> argument was introduced in Redis 7.0.0. <\/p>\n\n\n\n
We can use the XX<\/code> argument to set the timeout only if the key already has an expiry.<\/p>\n\n\n\n
Let’s try updating the same key from the previous examples:<\/p>\n\n\n\n
PEXPIREAT beverage 1656040209000 XX<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 1<\/pre>\n\n\n\n
It worked.<\/p>\n\n\n\n
Let’s check the current TTL:<\/p>\n\n\n\n
PTTL beverage<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 84774111<\/pre>\n\n\n\n
Looks good. That’s how many milliseconds to go until the key expires.<\/p>\n\n\n\n
Let’s also use the PEXPIRETIME<\/code> command to check the absolute Unix time of the expiry:<\/p>\n\n\n\n
PEXPIRETIME beverage<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 1656040209000<\/pre>\n\n\n\n
Yes, it’s exactly as we specified.<\/p>\n\n\n\n
The GT<\/code> Argument<\/h2>\n\n\n\n
The GT<\/code> argument was introduced in Redis 7.0.0. <\/p>\n\n\n\n
We can use the GT<\/code> argument to set the timeout only if the new expiry is greater than current one.<\/p>\n\n\n\n
First, let’s try updating our key with a smaller timeout:<\/p>\n\n\n\n
PEXPIREAT beverage 1656040200000 GT<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 0<\/pre>\n\n\n\n
It didn’t work, because the new expiry is less than the current one.<\/p>\n\n\n\n
Let’s try again, with a larger expiry:<\/p>\n\n\n\n
PEXPIREAT beverage 1656040210000 GT<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 1<\/pre>\n\n\n\n
This time it worked, because our expiry is greater than the current one.<\/p>\n\n\n\n
The LT<\/code> Argument<\/h2>\n\n\n\n
The LT<\/code> argument was introduced in Redis 7.0.0. <\/p>\n\n\n\n
We can use the LT<\/code> argument to set the timeout only if the new expiry is less than current one.<\/p>\n\n\n\n
To test this, let’s try updating our key with a larger timeout:<\/p>\n\n\n\n
PEXPIREAT beverage 1656040219000 LT<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 0<\/pre>\n\n\n\n
It didn’t work, because the new expiry is greater than the current one.<\/p>\n\n\n\n
Let’s try again, with a smaller expiry:<\/p>\n\n\n\n
PEXPIREAT beverage 1656040200000 LT<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(integer) 1<\/pre>\n\n\n\n
This time it worked, because our expiry is less than the current one.<\/p>\n\n\n\n
Note that non-volatile keys (i.e. keys with no expiry) are considered infinite for the purpose of the LT<\/code> and GT<\/code> arguments.<\/p>\n","protected":false},"excerpt":{"rendered":"
The Redis PEXPIREAT command sets a timeout as a Unix timestamp on a given key in milliseconds. It works the same as the EXPIREAT command, except that it sets the timeout in milliseconds instead of seconds. It’s also similar to the PEXPIRE command, but with an absolute Unix timestamp instead of a time interval.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[153],"tags":[154,20],"class_list":["post-26154","post","type-post","status-publish","format-standard","hentry","category-redis","tag-commands","tag-what-is"],"_links":{"self":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts\/26154","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/comments?post=26154"}],"version-history":[{"count":5,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts\/26154\/revisions"}],"predecessor-version":[{"id":26261,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts\/26154\/revisions\/26261"}],"wp:attachment":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/media?parent=26154"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/categories?post=26154"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/tags?post=26154"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}