Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:description: This section describes how to back up an online database.

Check failure on line 1 in modules/ROOT/pages/backup-restore/online-backup.adoc

View workflow job for this annotation

GitHub Actions / docs-verify-pr / log-report

modules/ROOT/pages/backup-restore/online-backup.adoc

target of xref not found: database-internals/checkpointing.adoc
[role=enterprise-edition]
[[online-backup]]
= Back up an online database
Expand Down Expand Up @@ -217,6 +217,22 @@
[[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

Expand Down
Loading