borgmatic-collective/borgmatic
borgmatic-collective
/
borgmatic
15
57
Fork 40
Code Issues 54 Pull Requests 1 Actions Packages Releases 121 Activity

Find a file by name across archives #541

New Issue
Closed
opened 2022-06-03 20:37:28 +00:00 by witten · 2 comments
witten commented 2022-06-03 20:37:28 +00:00
Owner
Copy Link

What I'm trying to do and why

A common use case with borgmatic is as follows: The user accidentally deletes or overwrites a file and wants to extract the original from backup so they can continue working with it. This is feasible with Borg and borgmatic, but it's kind of a pain today. The process might go something like this:

  1. Crap, it looks like foo.txt got deleted at some point! I need to restore it from backup.
  2. Okay, I need to figure out what archive it's in. borgmatic list --archive latest.
  3. Huh, it's not actually in that archive. How long has it been deleted? Let's get a list of all archives borgmatic list.
  4. Now I need to go through these archives one-by-one looking for the file... borgmatic list --archive 1234, borgmatic list --archive 1235, etc etc.
  5. I've finally found the file. Now I can finally extract it! borgmatic extract ....

As you can see, this process is kind of tedious—and not what you want to be doing when you're frantically trying to get your file back. Furthermore, if you're trying to use Borg patterns to try to find your file with --path or --pattern, that can further complicate the process if you're not super familiar with the pattern syntax.

So what if that process was a little more streamlined? Something like this:

  1. Crap, it looks like foo.txt got deleted at some point! I need to restore it from backup. borgmatic list --find foo.txt
  2. Aha! I can see at a glance every archive it's found in. Now I can easily borgmatic extract ...

And since this is borgmatic list, you can combine --find with parameters like --last 5 or --archive latest or --glob-archives ... to limit the search to the archives you're interested in searching.

Other notes / implementation ideas

Proposed output:

# borgmatic -c test.yaml list --find test.yaml
test.borg: Listing archives
flux-2022-05-29T15:27:04.333739      Sun, 2022-05-29 15:27:04 [2012...19d4]
-rw------- root   root      25833 Sat, 2022-05-28 19:15:15 root/tmp/test.yaml
flux-2022-05-29T15:27:09.202111      Sun, 2022-05-29 15:27:09 [c193...7e74]
-rw------- root   root      25833 Sat, 2022-05-28 19:15:15 root/tmp/test.yaml
flux-2022-05-30T19:47:15.848721      Mon, 2022-05-30 19:47:15 [5ddc...9266]
flux-2022-05-31T10:09:34.550785      Tue, 2022-05-31 10:09:34 [4df4...a40e]
flux-2022-06-02T19:31:09.768100      Thu, 2022-06-02 19:31:09 [ed60...a261]

Proposed implementation: When borgmatic list --find is used, ask Borg for a list of all matching archives via borg list. Parse that list and run borg list again with each archive, passing in the --find path to each invocation.

Inspired by: https://gitlab.gnome.org/World/pika-backup/-/issues/232 and restic-find.

#### What I'm trying to do and why A common use case with borgmatic is as follows: The user accidentally deletes or overwrites a file and wants to extract the original from backup so they can continue working with it. This is feasible with Borg and borgmatic, but it's kind of a pain today. The process might go something like this: 1. Crap, it looks like foo.txt got deleted at some point! I need to restore it from backup. 2. Okay, I need to figure out what archive it's in. `borgmatic list --archive latest`. 3. Huh, it's not actually *in* that archive. How long has it been deleted? Let's get a list of all archives `borgmatic list`. 4. Now I need to go through these archives one-by-one looking for the file... `borgmatic list --archive 1234`, `borgmatic list --archive 1235`, etc etc. 5. I've finally found the file. Now I can finally extract it! `borgmatic extract ...`. As you can see, this process is kind of tedious—and not what you want to be doing when you're frantically trying to get your file back. Furthermore, if you're trying to use Borg patterns to try to find your file with `--path` or `--pattern`, that can further complicate the process if you're not super familiar with the pattern syntax. So what if that process was a little more streamlined? Something like this: 1. Crap, it looks like foo.txt got deleted at some point! I need to restore it from backup. `borgmatic list --find foo.txt` 2. Aha! I can see at a glance every archive it's found in. Now I can easily `borgmatic extract ...` And since this is `borgmatic list`, you can combine `--find` with parameters like `--last 5` or `--archive latest` or `--glob-archives ...` to limit the search to the archives you're interested in searching. #### Other notes / implementation ideas **Proposed output:** ```bash # borgmatic -c test.yaml list --find test.yaml test.borg: Listing archives flux-2022-05-29T15:27:04.333739 Sun, 2022-05-29 15:27:04 [2012...19d4] -rw------- root root 25833 Sat, 2022-05-28 19:15:15 root/tmp/test.yaml flux-2022-05-29T15:27:09.202111 Sun, 2022-05-29 15:27:09 [c193...7e74] -rw------- root root 25833 Sat, 2022-05-28 19:15:15 root/tmp/test.yaml flux-2022-05-30T19:47:15.848721 Mon, 2022-05-30 19:47:15 [5ddc...9266] flux-2022-05-31T10:09:34.550785 Tue, 2022-05-31 10:09:34 [4df4...a40e] flux-2022-06-02T19:31:09.768100 Thu, 2022-06-02 19:31:09 [ed60...a261] ``` **Proposed implementation:** When `borgmatic list --find` is used, ask Borg for a list of all matching archives via `borg list`. Parse that list and run `borg list` again with each archive, passing in the `--find` path to each invocation. Inspired by: https://gitlab.gnome.org/World/pika-backup/-/issues/232 and [`restic-find`](https://manpages.ubuntu.com/manpages/kinetic/man1/restic-find.1.html).
witten added the
design finalized
 label 2022-06-03 20:42:14 +00:00
witten referenced this issue from a commit 2022-06-03 22:20:35 +00:00
Fix None find paths (#541).
witten commented 2022-06-03 23:54:45 +00:00
Author
Owner
Copy Link

Implemented in master!

Implemented in master!
witten commented 2022-06-09 23:40:57 +00:00
Author
Owner
Copy Link

Released in borgmatic 1.6.3!

Released in borgmatic 1.6.3!
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
main
spot-check
1.8.10
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.5.24
1.5.23
1.5.22
1.5.21
1.5.20
1.5.19
1.5.18
1.5.17
1.5.16
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.7.dev0
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.26
1.3.25
1.3.24
1.3.23
1.3.22
1.3.21
1.3.20
1.3.19
1.3.18
1.3.17
1.3.16
1.3.15
1.3.14
1.3.13
1.3.12
1.3.11
1.3.10
1.3.9
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.2.18
1.2.17
1.2.16
1.2.15
1.2.14
1.2.13
1.2.12
1.2.11
1.2.10
1.2.9
1.2.8
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.3
1.0.2
1.0.1
1.0.0
0.1.8
0.1.7
0.1.6
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
0.0.7
0.0.6
0.0.5
0.0.4
0.0.3
0.0.2
Labels
Clear labels   
bug

   
data loss

   
design finalized

   
good first issue

   
new feature area

   
question / support

   
security

   
waiting for response
No Label
bug
data loss
design finalized
good first issue
new feature area
question / support
security
waiting for response
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#541
No description provided.
Delete Branch "%!s(<nil>)"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?