KurlesHS/restic
1
0
Fork 0
forked from TrueCloudLab/restic
Code Pull requests Activity

restore: add dry-run docs

Browse source
This commit is contained in:
Michael Eischer 2024-05-31 21:12:13 +02:00
parent 83351f42e3
commit 798256ec52
3 changed files with 45 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
changelog/unreleased/pull-4839 Normal file
View file

@ -0,0 +1,7 @@
Enhancement: Add dry-run support to `restore` command
The `restore` command now supports the `--dry-run` option to perform
a dry run. Pass the `--verbose=2` option to see which files would
remain unchanged, which would be updated or freshly restored.
https://github.com/restic/restic/pull/4839

22
doc/050_restore.rst
View file

@ -111,6 +111,28 @@ values are supported:
newer modification time (mtime). newer modification time (mtime).
* ``--overwrite never``: never overwrite existing files. * ``--overwrite never``: never overwrite existing files.
Dry run
-------
As restore operations can take a long time, it can be useful to perform a dry-run to
see what would be restored without having to run the full restore operation. The
restore command supports the ``--dry-run`` option and prints information about the
restored files when specifying ``--verbose=2``.
.. code-block:: console
$ restic restore --target /tmp/restore-work --dry-run --verbose=2 latest
unchanged /restic/internal/walker/walker.go with size 2.812 KiB
updated /restic/internal/walker/walker_test.go with size 11.143 KiB
restored /restic/restic with size 35.318 MiB
restored /restic
[...]
Summary: Restored 9072 files/dirs (153.597 MiB) in 0:00
Files with already up to date content are reported as ``unchanged``. Files whose content
was modified are ``updated`` and files that are new are shown as ``restored``. Directories
and other file types like symlinks are always reported as ``restored``.
Restore using mount Restore using mount
=================== ===================

16
doc/075_scripting.rst
View file

@ -511,6 +511,22 @@ Status
|``bytes_skipped`` | Total size of skipped files | |``bytes_skipped`` | Total size of skipped files |
+----------------------+------------------------------------------------------------+ +----------------------+------------------------------------------------------------+
Verbose Status
^^^^^^^^^^^^^^
Verbose status provides details about the progress, including details about restored files.
Only printed if `--verbose=2` is specified.
+----------------------+-----------------------------------------------------------+
| ``message_type`` | Always "verbose_status" |
+----------------------+-----------------------------------------------------------+
| ``action`` | Either "restored", "updated" or "unchanged" |
+----------------------+-----------------------------------------------------------+
| ``item`` | The item in question |
+----------------------+-----------------------------------------------------------+
| ``size`` | Size of the item in bytes |
+----------------------+-----------------------------------------------------------+
Summary Summary
^^^^^^^ ^^^^^^^