From b34ce57dd4d48059d183d92afc6d14c0e7a276b6 Mon Sep 17 00:00:00 2001 From: Michael Eischer Date: Sat, 17 Jun 2023 21:47:17 +0200 Subject: [PATCH] doc: describe JSON output of restore command --- doc/075_scripting.rst | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/doc/075_scripting.rst b/doc/075_scripting.rst index 9855b9ffb..85c67ab38 100644 --- a/doc/075_scripting.rst +++ b/doc/075_scripting.rst @@ -470,6 +470,49 @@ node +-----------------+--------------------------+ +restore +------- + +The ``restore`` command uses the JSON lines format with the following message types. + +Status +^^^^^^ + ++----------------------+------------------------------------------------------------+ +|``message_type`` | Always "status" | ++----------------------+------------------------------------------------------------+ +|``seconds_elapsed`` | Time since restore started | ++----------------------+------------------------------------------------------------+ +|``percent_done`` | Percentage of data backed up (bytes_restored/total_bytes) | ++----------------------+------------------------------------------------------------+ +|``total_files`` | Total number of files detected | ++----------------------+------------------------------------------------------------+ +|``files_restored`` | Files restored | ++----------------------+------------------------------------------------------------+ +|``total_bytes`` | Total number of bytes in restore set | ++----------------------+------------------------------------------------------------+ +|``bytes_restored`` | Number of bytes restored | ++----------------------+------------------------------------------------------------+ + + +Summary +^^^^^^^ + ++----------------------+------------------------------------------------------------+ +|``message_type`` | Always "summary" | ++----------------------+------------------------------------------------------------+ +|``seconds_elapsed`` | Time since restore started | ++----------------------+------------------------------------------------------------+ +|``total_files`` | Total number of files detected | ++----------------------+------------------------------------------------------------+ +|``files_restored`` | Files restored | ++----------------------+------------------------------------------------------------+ +|``total_bytes`` | Total number of bytes in restore set | ++----------------------+------------------------------------------------------------+ +|``bytes_restored`` | Number of bytes restored | ++----------------------+------------------------------------------------------------+ + + snapshots ---------