octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-11-25 06:07:44 +00:00
Code Issues Releases Wiki Activity

Merge pull request #4650 from MichaelEischer/improve-stdin-from-command-description

Browse Source 
backup: Improve help text for `--stdin-from-command`
This commit is contained in:
Michael Eischer 2024-01-23 19:22:15 +01:00 committed by GitHub
commit 0e2ee06803
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
changelog/unreleased/issue-4251
View File

@ -1,14 +1,16 @@
Enhancement: Support reading backup from a program's standard output Enhancement: Support reading backup from a commands's standard output
When reading data from stdin, the `backup` command could not verify whether the The `backup` command now supports the `--stdin-from-command` option. When using
corresponding command completed successfully. this option, the arguments to `backup` are interpreted as a command instead of
paths to back up. `backup` then executes the given command and stores the
standard output from it in the backup, similar to the what the `--stdin` option
does. This also enables restic to verify that the command completes with exit
code zero. A non-zero exit code causes the backup to fail.
The `backup` command now supports starting an arbitrary command and sourcing Note that the `--stdin` option does not have to be specified at the same time,
the backup content from its standard output. This enables restic to verify that and that the `--stdin-filename` option also applies to `--stdin-from-command`.
the command completes with exit code zero. A non-zero exit code causes the
backup to fail.
Example: `restic backup --stdin-from-command mysqldump [...]` Example: `restic backup --stdin-from-command --stdin-filename dump.sql mysqldump [...]`
https://github.com/restic/restic/issues/4251 https://github.com/restic/restic/issues/4251
https://github.com/restic/restic/pull/4410 https://github.com/restic/restic/pull/4410

2
cmd/restic/cmd_backup.go
View File

@ -135,7 +135,7 @@ func init() {
f.StringVar(&backupOptions.ExcludeLargerThan, "exclude-larger-than", "", "max `size` of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T)") f.StringVar(&backupOptions.ExcludeLargerThan, "exclude-larger-than", "", "max `size` of the files to be backed up (allowed suffixes: k/K, m/M, g/G, t/T)")
f.BoolVar(&backupOptions.Stdin, "stdin", false, "read backup from stdin") f.BoolVar(&backupOptions.Stdin, "stdin", false, "read backup from stdin")
f.StringVar(&backupOptions.StdinFilename, "stdin-filename", "stdin", "`filename` to use when reading from stdin") f.StringVar(&backupOptions.StdinFilename, "stdin-filename", "stdin", "`filename` to use when reading from stdin")
f.BoolVar(&backupOptions.StdinCommand, "stdin-from-command", false, "execute command and store its stdout") f.BoolVar(&backupOptions.StdinCommand, "stdin-from-command", false, "interpret arguments as command to execute and store its stdout")
f.Var(&backupOptions.Tags, "tag", "add `tags` for the new snapshot in the format `tag[,tag,...]` (can be specified multiple times)") f.Var(&backupOptions.Tags, "tag", "add `tags` for the new snapshot in the format `tag[,tag,...]` (can be specified multiple times)")
f.UintVar(&backupOptions.ReadConcurrency, "read-concurrency", 0, "read `n` files concurrently (default: $RESTIC_READ_CONCURRENCY or 2)") f.UintVar(&backupOptions.ReadConcurrency, "read-concurrency", 0, "read `n` files concurrently (default: $RESTIC_READ_CONCURRENCY or 2)")
f.StringVarP(&backupOptions.Host, "host", "H", "", "set the `hostname` for the snapshot manually. To prevent an expensive rescan use the \"parent\" flag") f.StringVarP(&backupOptions.Host, "host", "H", "", "set the `hostname` for the snapshot manually. To prevent an expensive rescan use the \"parent\" flag")