2022-06-23 23:19:19 +00:00
|
|
|
.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
|
|
|
|
|
|
|
|
|
|
.. _borg_transfer:
|
|
|
|
|
|
|
|
|
|
borg transfer
|
|
|
|
|
-------------
|
|
|
|
|
.. code-block:: none
|
|
|
|
|
|
|
|
|
|
borg [common options] transfer [options]
|
|
|
|
|
|
|
|
|
|
.. only:: html
|
|
|
|
|
|
|
|
|
|
.. class:: borg-options-table
|
|
|
|
|
|
2023-06-11 21:09:20 +00:00
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
2024-07-19 18:40:15 +00:00
|
|
|
| **optional arguments** |
|
2023-06-11 21:09:20 +00:00
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``-n``, ``--dry-run`` | do not change repository, just check |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``--other-repo SRC_REPOSITORY`` | transfer archives from the other repository |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
2024-09-07 20:31:48 +00:00
|
|
|
| | ``--from-borg1`` | other repository is borg 1.x |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
2023-06-11 21:09:20 +00:00
|
|
|
| | ``--upgrader UPGRADER`` | use the upgrader to convert transferred data (default: no conversion) |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``-C COMPRESSION``, ``--compression COMPRESSION`` | select compression algorithm, see the output of the "borg help compression" command for details. |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``--recompress MODE`` | recompress data chunks according to `MODE` and ``--compression``. Possible modes are `always`: recompress unconditionally; and `never`: do not recompress (faster: re-uses compressed data chunks w/o change).If no MODE is given, `always` will be used. Not passing --recompress is equivalent to "--recompress never". |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| .. class:: borg-common-opt-ref |
|
|
|
|
|
| |
|
|
|
|
|
| :ref:`common_options` |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| **Archive filters** — Archive filters can be applied to repository targets. |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
2024-02-20 16:11:43 +00:00
|
|
|
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp |
|
2023-06-11 21:09:20 +00:00
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``--first N`` | consider first N archives after other filters were applied |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``--last N`` | consider last N archives after other filters were applied |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
2024-02-20 16:11:43 +00:00
|
|
|
| | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. |
|
2023-06-11 21:09:20 +00:00
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
|
| | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. |
|
|
|
|
|
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
2022-06-23 23:19:19 +00:00
|
|
|
|
|
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
|
|
<script type='text/javascript'>
|
|
|
|
|
$(document).ready(function () {
|
|
|
|
|
$('.borg-options-table colgroup').remove();
|
|
|
|
|
})
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
.. only:: latex
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2024-07-19 18:40:15 +00:00
|
|
|
optional arguments
|
2022-06-23 23:19:19 +00:00
|
|
|
-n, --dry-run do not change repository, just check
|
|
|
|
|
--other-repo SRC_REPOSITORY transfer archives from the other repository
|
2024-09-07 20:31:48 +00:00
|
|
|
--from-borg1 other repository is borg 1.x
|
2022-07-03 23:21:50 +00:00
|
|
|
--upgrader UPGRADER use the upgrader to convert transferred data (default: no conversion)
|
2023-06-11 21:09:20 +00:00
|
|
|
-C COMPRESSION, --compression COMPRESSION select compression algorithm, see the output of the "borg help compression" command for details.
|
|
|
|
|
--recompress MODE recompress data chunks according to `MODE` and ``--compression``. Possible modes are `always`: recompress unconditionally; and `never`: do not recompress (faster: re-uses compressed data chunks w/o change).If no MODE is given, `always` will be used. Not passing --recompress is equivalent to "--recompress never".
|
2022-06-23 23:19:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
:ref:`common_options`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Archive filters
|
2022-10-02 13:51:17 +00:00
|
|
|
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives".
|
2024-02-20 16:11:43 +00:00
|
|
|
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp
|
2022-10-02 13:51:17 +00:00
|
|
|
--first N consider first N archives after other filters were applied
|
|
|
|
|
--last N consider last N archives after other filters were applied
|
2023-02-26 20:30:28 +00:00
|
|
|
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
|
|
|
|
|
--newest TIMESPAN consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m.
|
2024-02-20 16:11:43 +00:00
|
|
|
--older TIMESPAN consider archives older than (now - TIMESPAN), e.g. 7d or 12m.
|
2023-02-26 20:30:28 +00:00
|
|
|
--newer TIMESPAN consider archives newer than (now - TIMESPAN), e.g. 7d or 12m.
|
2022-06-23 23:19:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
This command transfers archives from one repository to another repository.
|
2022-07-03 23:21:50 +00:00
|
|
|
Optionally, it can also upgrade the transferred data.
|
2023-06-11 21:09:20 +00:00
|
|
|
Optionally, it can also recompress the transferred data.
|
|
|
|
|
|
|
|
|
|
It is easiest (and fastest) to give ``--compression=COMPRESSION --recompress=never`` using
|
|
|
|
|
the same COMPRESSION mode as in the SRC_REPO - borg will use that COMPRESSION for metadata (in
|
|
|
|
|
any case) and keep data compressed "as is" (saves time as no data compression is needed).
|
|
|
|
|
|
|
|
|
|
If you want to globally change compression while transferring archives to the DST_REPO,
|
|
|
|
|
give ``--compress=WANTED_COMPRESSION --recompress=always``.
|
2022-06-23 23:19:19 +00:00
|
|
|
|
2024-09-07 20:31:48 +00:00
|
|
|
The default is to transfer all archives.
|
|
|
|
|
|
|
|
|
|
You could use the misc. archive filter options to limit which archives it will
|
|
|
|
|
transfer, e.g. using the ``-a`` option. This is recommended for big
|
|
|
|
|
repositories with multiple data sets to keep the runtime per invocation lower.
|
|
|
|
|
|
|
|
|
|
General purpose archive transfer
|
|
|
|
|
++++++++++++++++++++++++++++++++
|
|
|
|
|
|
|
|
|
|
Transfer borg2 archives into a related other borg2 repository::
|
2022-06-23 23:19:19 +00:00
|
|
|
|
2022-08-03 20:19:12 +00:00
|
|
|
# create a related DST_REPO (reusing key material from SRC_REPO), so that
|
2022-06-23 23:19:19 +00:00
|
|
|
# chunking and chunk id generation will work in the same way as before.
|
2024-09-08 15:18:53 +00:00
|
|
|
borg --repo=DST_REPO repo-create --encryption=DST_ENC --other-repo=SRC_REPO
|
2022-06-23 23:19:19 +00:00
|
|
|
|
|
|
|
|
# transfer archives from SRC_REPO to DST_REPO
|
|
|
|
|
borg --repo=DST_REPO transfer --other-repo=SRC_REPO --dry-run # check what it would do
|
|
|
|
|
borg --repo=DST_REPO transfer --other-repo=SRC_REPO # do it!
|
|
|
|
|
borg --repo=DST_REPO transfer --other-repo=SRC_REPO --dry-run # check! anything left?
|
|
|
|
|
|
|
|
|
|
|
2024-09-07 20:31:48 +00:00
|
|
|
Data migration / upgrade from borg 1.x
|
|
|
|
|
++++++++++++++++++++++++++++++++++++++
|
|
|
|
|
|
|
|
|
|
To migrate your borg 1.x archives into a related, new borg2 repository, usage is quite similar
|
|
|
|
|
to the above, but you need the ``--from-borg1`` option::
|
2022-07-03 23:21:50 +00:00
|
|
|
|
2024-09-08 15:18:53 +00:00
|
|
|
borg --repo=DST_REPO repocreate --encryption=DST_ENC --other-repo=SRC_REPO --from-borg1
|
2022-07-03 23:21:50 +00:00
|
|
|
|
2024-09-07 20:31:48 +00:00
|
|
|
# to continue using lz4 compression as you did in SRC_REPO:
|
|
|
|
|
borg --repo=DST_REPO transfer --other-repo=SRC_REPO --from-borg1 \
|
|
|
|
|
--compress=lz4 --recompress=never
|
2023-06-11 21:09:20 +00:00
|
|
|
|
2024-09-07 20:31:48 +00:00
|
|
|
# alternatively, to recompress everything to zstd,3:
|
|
|
|
|
borg --repo=DST_REPO transfer --other-repo=SRC_REPO --from-borg1 \
|
2023-06-11 21:09:20 +00:00
|
|
|
--compress=zstd,3 --recompress=always
|
2022-07-03 23:21:50 +00:00
|
|
|
|
