summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/bgsave.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/bgsave.md')
-rw-r--r--iredis/data/commands/bgsave.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/iredis/data/commands/bgsave.md b/iredis/data/commands/bgsave.md
new file mode 100644
index 0000000..f04d71b
--- /dev/null
+++ b/iredis/data/commands/bgsave.md
@@ -0,0 +1,28 @@
+Save the DB in background.
+
+Normally the OK code is immediately returned. Redis forks, the parent continues
+to serve the clients, the child saves the DB on disk then exits.
+
+An error is returned if there is already a background save running or if there
+is another non-background-save process running, specifically an in-progress AOF
+rewrite.
+
+If `BGSAVE SCHEDULE` is used, the command will immediately return `OK` when an
+AOF rewrite is in progress and schedule the background save to run at the next
+opportunity.
+
+A client may be able to check if the operation succeeded using the `LASTSAVE`
+command.
+
+Please refer to the [persistence documentation][tp] for detailed information.
+
+[tp]: /topics/persistence
+
+@return
+
+@simple-string-reply: `Background saving started` if `BGSAVE` started correctly
+or `Background saving scheduled` when used with the `SCHEDULE` subcommand.
+
+@history
+
+- `>= 3.2.2`: Added the `SCHEDULE` option.