#1796: documentation

2023-09-28 14:09:32 +01:00
parent 6202d320a6
commit bca3e6344e
2 changed files with 9 additions and 0 deletions
--- a/docs/source/simulation_components/system/database_client_server.rst
+++ b/docs/source/simulation_components/system/database_client_server.rst
@@ -60,6 +60,12 @@ Usage
 - Retrieve results in a dictionary.
 - Disconnect when finished.

+To create database backups:
+
+- Configure the backup server the ``DatabaseService`` by providing the Backup server ``IPv4Address`` with ``configure_backup``
+- Create a backup using ``backup_database``. This fails if the backup server is not configured.
+- Restore a backup using ``restore_backup``. By default, this uses the database created via ``backup_database``.
+
 Implementation
 ^^^^^^^^^^^^^^