From fc2cdd4cf6bf9a5e91066df0c551da1a1cc81dbd Mon Sep 17 00:00:00 2001 From: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Mon, 16 Sep 2024 10:24:40 +0200 Subject: [PATCH] Explain the importance of checkpointing for backups (#1793) Co-authored-by: Reneta Popova --- .../ROOT/pages/backup-restore/online-backup.adoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc index 81528290e..a04fda974 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -217,6 +217,22 @@ The error codes include details of what error was encountered. [[online-backup-configurations]] == Online backup configurations +[[online-backup-checkpoints]] +=== Checkpointing + +When a full backup is requested, it always triggers a checkpoint. +The backup cannot proceed until the checkpoint finishes. + +While the server is checkpointing, the backup job receives no data, which may lead to the backup timeout. +To extend the backup timeout, modify the xref:configuration/configuration-settings.adoc#config_dbms.cluster.catchup.client_inactivity_timeout[`dbms.cluster.catchup.client_inactivity_timeout`] setting, which restricts the network inactivity. +It controls the timeout duration of the catchup protocol, which is the underlying protocol of multiple catchup processes, including backups. + +You can also tune up xref:configuration/configuration-settings.adoc#_checkpoint_settings[the Checkpoint settings] or check that your disks are performant enough to handle the load. +For more information, see xref:performance/disks-ram-and-other-tips.adoc#performance-checkpoint-iops-limit[Checkpoint IOPS limit]. + +To read more about checkpointing, see xref:database-internals/checkpointing.adoc[Database internals -> Checkpointing and log pruning]. + + [[backup-server-configuration]] === Server configuration