summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/dump.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2020-03-21 10:28:17 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-02-07 11:16:53 +0000
commit06cba6ccd165ca8b224797e37fccb9e63f026d77 (patch)
treee82f1bc439997ae296f2e74f8a64d84c5d95f140 /iredis/data/commands/dump.md
parentInitial commit. (diff)
downloadiredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.tar.xz
iredis-06cba6ccd165ca8b224797e37fccb9e63f026d77.zip
Adding upstream version 1.9.1.upstream/1.9.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'iredis/data/commands/dump.md')
-rw-r--r--iredis/data/commands/dump.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/iredis/data/commands/dump.md b/iredis/data/commands/dump.md
new file mode 100644
index 0000000..b81d7af
--- /dev/null
+++ b/iredis/data/commands/dump.md
@@ -0,0 +1,30 @@
+Serialize the value stored at key in a Redis-specific format and return it to
+the user. The returned value can be synthesized back into a Redis key using the
+`RESTORE` command.
+
+The serialization format is opaque and non-standard, however it has a few
+semantic characteristics:
+
+- It contains a 64-bit checksum that is used to make sure errors will be
+ detected. The `RESTORE` command makes sure to check the checksum before
+ synthesizing a key using the serialized value.
+- Values are encoded in the same format used by RDB.
+- An RDB version is encoded inside the serialized value, so that different Redis
+ versions with incompatible RDB formats will refuse to process the serialized
+ value.
+
+The serialized value does NOT contain expire information. In order to capture
+the time to live of the current value the `PTTL` command should be used.
+
+If `key` does not exist a nil bulk reply is returned.
+
+@return
+
+@bulk-string-reply: the serialized value.
+
+@examples
+
+```cli
+SET mykey 10
+DUMP mykey
+```