Merge pull request #766 from ksss/unlink

Support UNLINK command interface for redis v4

Author: byroot

lib/redis.rb

@@ -527,6 +527,16 @@ def del(*keys)
     end
   end
 
+  # Unlink one or more keys.
+  #
+  # @param [String, Array<String>] keys
+  # @return [Fixnum] number of keys that were unlinked
+  def unlink(*keys)
+    synchronize do |client|
+      client.call([:unlink] + keys)
+    end
+  end
+
   # Determine if a key exists.
   #
   # @param [String] key

lib/redis/distributed.rb

@@ -161,6 +161,14 @@ def del(*args)
       end
     end
 
+    # Unlink keys.
+    def unlink(*args)
+      keys_per_node = args.group_by { |key| node_for(key) }
+      keys_per_node.inject(0) do |sum, (node, keys)|
+        sum + node.unlink(*keys)
+      end
+    end
+
     # Determine if a key exists.
     def exists(key)
       node_for(key).exists(key)

test/commands_on_value_types_test.rb

@@ -38,6 +38,42 @@ def test_del_with_array_argument
     assert_equal [], r.keys("*").sort
   end
 
+  def test_unlink
+    target_version "4.0.0" do
+      r.set "foo", "s1"
+      r.set "bar", "s2"
+      r.set "baz", "s3"
+
+      assert_equal ["bar", "baz", "foo"], r.keys("*").sort
+
+      assert_equal 1, r.unlink("foo")
+
+      assert_equal ["bar", "baz"], r.keys("*").sort
+
+      assert_equal 2, r.unlink("bar", "baz")
+
+      assert_equal [], r.keys("*").sort
+    end
+  end
+
+  def test_unlink_with_array_argument
+    target_version "4.0.0" do
+      r.set "foo", "s1"
+      r.set "bar", "s2"
+      r.set "baz", "s3"
+
+      assert_equal ["bar", "baz", "foo"], r.keys("*").sort
+
+      assert_equal 1, r.unlink(["foo"])
+
+      assert_equal ["bar", "baz"], r.keys("*").sort
+
+      assert_equal 2, r.unlink(["bar", "baz"])
+
+      assert_equal [], r.keys("*").sort
+    end
+  end
+
   def test_randomkey
     assert r.randomkey.to_s.empty?
 

test/distributed_commands_on_value_types_test.rb

@@ -38,6 +38,42 @@ def test_del_with_array_argument
     assert_equal [], r.keys("*").sort
   end
 
+  def test_unlink
+    target_version "4.0.0" do
+      r.set "foo", "s1"
+      r.set "bar", "s2"
+      r.set "baz", "s3"
+
+      assert_equal ["bar", "baz", "foo"], r.keys("*").sort
+
+      assert_equal 1, r.unlink("foo")
+
+      assert_equal ["bar", "baz"], r.keys("*").sort
+
+      assert_equal 2, r.unlink("bar", "baz")
+
+      assert_equal [], r.keys("*").sort
+    end
+  end
+
+  def test_unlink_with_array_argument
+    target_version "4.0.0" do
+      r.set "foo", "s1"
+      r.set "bar", "s2"
+      r.set "baz", "s3"
+
+      assert_equal ["bar", "baz", "foo"], r.keys("*").sort
+
+      assert_equal 1, r.unlink(["foo"])
+
+      assert_equal ["bar", "baz"], r.keys("*").sort
+
+      assert_equal 2, r.unlink(["bar", "baz"])
+
+      assert_equal [], r.keys("*").sort
+    end
+  end
+
   def test_randomkey
     assert_raise Redis::Distributed::CannotDistribute do
       r.randomkey