summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/getdel.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/getdel.md')
-rw-r--r--iredis/data/commands/getdel.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/iredis/data/commands/getdel.md b/iredis/data/commands/getdel.md
new file mode 100644
index 0000000..fbd9f72
--- /dev/null
+++ b/iredis/data/commands/getdel.md
@@ -0,0 +1,16 @@
+Get the value of `key` and delete the key. This command is similar to `GET`,
+except for the fact that it also deletes the key on success (if and only if the
+key's value type is a string).
+
+@return
+
+@bulk-string-reply: the value of `key`, `nil` when `key` does not exist, or an
+error if the key's value type isn't a string.
+
+@examples
+
+```cli
+SET mykey "Hello"
+GETDEL mykey
+GET mykey
+```