Skip to content
Merged
30 changes: 13 additions & 17 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,6 @@ Remember to xref:backup-restore/planning.adoc[plan your backup] carefully and ba
Note that it is not allowed to take a backup of a database alias, only physical databases can be backed up.
====

Take into account that a backup job triggers a checkpoint if needed.

Consider the following statements:

* The backup cannot proceed until the checkpoint finishes.

* If the server is checkpointing and the backup job does not receive any data, the backup will fail.
To adjust the duration of the backup timeout, configure the xref:configuration/configuration-settings.adoc#config_dbms.cluster.catchup.client_inactivity_timeout[`dbms.cluster.catchup.client_inactivity_timeout`] setting, which restricts how long the network can be inactive.

* If the next checkpoint takes less time, it may lead to a successful backup attempt.

* Taking a backup during high traffic may fail, as checkpoints during high traffic may take much longer than usual.

* If backups are timing out due to checkpointing, consider tuning xref:configuration/configuration-settings.adoc#_checkpoint_settings[the Checkpoint settings].

To configure the checkpointing policy, see xref:database-internals/checkpointing.adoc[Database internals -> Checkpointing and log pruning].

[[online-backup-command]]
== Command

Expand Down Expand Up @@ -280,6 +263,19 @@ For example, if your current database has a `Total mapped size` of `128GB` as pe
[[online-backup-resources]]
=== Computational resource configurations

Checkpointing::

Remember that a backup job triggers a checkpoint if needed.
The backup cannot proceed until the checkpoint finishes.
+
While the server is checkpointing, the backup job does not receive any data.
To adjust the backup timeout, configure the xref:configuration/configuration-settings.adoc#config_dbms.cluster.catchup.client_inactivity_timeout[`dbms.cluster.catchup.client_inactivity_timeout`] setting, which restricts how long the network can be inactive.
You can also tune up xref:configuration/configuration-settings.adoc#_checkpoint_settings[the Checkpoint settings] if backups are timing out due to checkpointing.
+
Periods of high traffic may impact the duration of checkpointing -- and thus the success of a backup job.
+
For more details on the checkpointing policy, see xref:database-internals/checkpointing.adoc[Database internals -> Checkpointing and log pruning].

Transaction log files::
The xref:database-internals/transaction-logs.adoc[transaction log files], which keep track of recent changes, are rotated and pruned based on a provided configuration.
For example, setting `db.tx_log.rotation.retention_policy=3` files keeps 3 transaction log files in the backup.
Expand Down