summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/unlink.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/unlink.md')
-rw-r--r--iredis/data/commands/unlink.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/iredis/data/commands/unlink.md b/iredis/data/commands/unlink.md
new file mode 100644
index 0000000..e305440
--- /dev/null
+++ b/iredis/data/commands/unlink.md
@@ -0,0 +1,18 @@
+This command is very similar to `DEL`: it removes the specified keys. Just like
+`DEL` a key is ignored if it does not exist. However the command performs the
+actual memory reclaiming in a different thread, so it is not blocking, while
+`DEL` is. This is where the command name comes from: the command just
+**unlinks** the keys from the keyspace. The actual removal will happen later
+asynchronously.
+
+@return
+
+@integer-reply: The number of keys that were unlinked.
+
+@examples
+
+```cli
+SET key1 "Hello"
+SET key2 "World"
+UNLINK key1 key2 key3
+```