{"id":28255,"date":"2022-12-27T11:50:20","date_gmt":"2022-12-27T01:50:20","guid":{"rendered":"https:\/\/database.guide\/?p=28255"},"modified":"2022-12-28T12:16:45","modified_gmt":"2022-12-28T02:16:45","slug":"redis-zdiff-command-explained","status":"publish","type":"post","link":"https:\/\/database.guide\/redis-zdiff-command-explained\/","title":{"rendered":"Redis ZDIFF Command Explained"},"content":{"rendered":"\n

In Redis, the ZDIFF<\/code> command returns the difference between the first and all successive input sorted sets.<\/p>\n\n\n\n\n\n\n\n

There’s also a ZDIFFSTORE<\/a><\/code> command that stores the result in a key.<\/p>\n\n\n\n

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

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

ZDIFF numkeys key [key ...] [WITHSCORES]<\/code><\/pre>\n\n\n\n
Example<\/h2>\n\n\n\n
Suppose we create two sorted sets, like this:<\/p>\n\n\n\n
ZADD cats 1 meow 2 fluffy 3 scratch<\/code><\/pre>\n\n\n\n
And:<\/p>\n\n\n\n
ZADD dogs 1 bark 2 woof<\/code><\/pre>\n\n\n\n
We can use the ZDIFF<\/code> command against those two sorted sets like this:<\/p>\n\n\n\n
ZDIFF 2 cats dogs<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
1) \"meow\"\n2) \"fluffy\"\n3) \"scratch\"<\/pre>\n\n\n\n
That returns all the elements in the first set that aren’t in the second set. By this, I mean all elements whose values aren’t in the second set.<\/p>\n\n\n\n
Let’s add an element to the dogs<\/code> set:<\/p>\n\n\n\n
ZADD dogs 3 fluffy<\/code><\/pre>\n\n\n\n
Now let’s run ZDIFF<\/code> again:<\/p>\n\n\n\n
ZDIFF 2 cats dogs<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
1) \"meow\"\n2) \"scratch\"<\/pre>\n\n\n\n
This time only two elements are returned. That’s because fluffy<\/code> appears in both sorted sets and ZDIFF<\/code> only returns the difference between the first sorted set and all subsequent sorted sets.<\/p>\n\n\n\n
The numkeys<\/code><\/em> value of 2<\/code> in the above examples means that I’m providing two sets.<\/p>\n\n\n\n
More Sorted Sets<\/h2>\n\n\n\n
The ZDIFF<\/code> command allows us to include as many sorted sets as we want in our list. They are all compared to the first one and any difference between the first and subsequent sets are returned.<\/p>\n\n\n\n
Let’s create another sorted set:<\/p>\n\n\n\n
ZADD birds 1 tweet 2 scratch<\/code><\/pre>\n\n\n\n
Now let’s run ZDIFF<\/code> against all three sets:<\/p>\n\n\n\n
ZDIFF 3 cats dogs birds<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
1) \"meow\"<\/pre>\n\n\n\n
This time only one element is returned. That’s because the other elements from the cats<\/code> set contain values that are also present in at least one of the other sorted sets. That is, the dogs<\/code> set contains fluffy<\/code> and the birds<\/code> set contains scratch<\/code>, both of which are in the cats<\/code> set.<\/p>\n\n\n\n
Note that the numkeys<\/code><\/em> argument is now 3<\/code>, which reflects the number of sorted sets I’m providing.<\/p>\n\n\n\n
The WITHSCORES<\/code> Argument<\/h2>\n\n\n\n
The WITHSCORES<\/code> argument can be used to output the scores of each element returned:<\/p>\n\n\n\n
ZDIFF 2 cats dogs WITHSCORES<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
1) \"meow\"\n2) \"1\"\n3) \"scratch\"\n4) \"3\"<\/pre>\n\n\n\n
Non-Existent Keys<\/h2>\n\n\n\n
Keys that don’t exist are treated as empty sets:<\/p>\n\n\n\n
ZDIFF 2 oops1 oops2<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(empty array)<\/pre>\n\n\n\n
Here we got an empty array because none of the keys exist.<\/p>\n\n\n\n
Here’s what happens when the first key exists, but none of the others do:<\/p>\n\n\n\n
ZDIFF 3 cats oops1 oops2<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
1) \"meow\"\n2) \"fluffy\"\n3) \"scratch\"<\/pre>\n\n\n\n
All elements from the first set are returned because none of them are present in any of the other (empty) sets.<\/p>\n\n\n\n
Using the Wrong numkeys<\/em><\/code> Argument<\/h2>\n\n\n\n
Here’s what happens when we use the wrong value for the numkeys<\/em><\/code> argument:<\/p>\n\n\n\n
ZDIFF 3 cats dogs<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(error) ERR syntax error<\/pre>\n\n\n\n
In this case I specified that there would be three sorted sets to compare, but I only provided two.<\/p>\n\n\n\n
The same error applies when it’s the other way around (i.e. I specify 2<\/code> but provide three keys):<\/p>\n\n\n\n
ZDIFF 2 cats dogs birds<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(error) ERR syntax error<\/pre>\n\n\n\n
Passing a Key of the Wrong Type<\/h2>\n\n\n\n
Here’s what happens when we pass a key that contains a different type (i.e. it’s not a sorted set):<\/p>\n\n\n\n
ZDIFF 2 cats country<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(error) WRONGTYPE Operation against a key holding the wrong kind of value<\/pre>\n\n\n\n
Here the country<\/code> key contains a string.<\/p>\n\n\n\n
However, the command does work on non-sorted sets:<\/p>\n\n\n\n
ZDIFF 2 countries cats<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
1) \"Australia\"\n2) \"New Zealand\"<\/pre>\n\n\n\n
In this case the countries<\/code> key contains a (non-sorted) set.<\/p>\n","protected":false},"excerpt":{"rendered":"
In Redis, the ZDIFF command returns the difference between the first and all successive input sorted sets.<\/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-28255","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\/28255","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=28255"}],"version-history":[{"count":5,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts\/28255\/revisions"}],"predecessor-version":[{"id":28303,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts\/28255\/revisions\/28303"}],"wp:attachment":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/media?parent=28255"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/categories?post=28255"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/tags?post=28255"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}