add docs for database restore params and config bootstrap

This commit is contained in:
Divyansh Singh 2023-07-15 12:27:54 +05:30
parent 0055de08a4
commit 1f415a24b8
2 changed files with 39 additions and 0 deletions

View file

@ -338,6 +338,29 @@ within the database dump:
borgmatic restore --archive latest --database users --schema tentant1 borgmatic restore --archive latest --database users --schema tentant1
``` ```
### Restore to an alternate host
<span class="minilink minilink-addedin">New in version 1.7.15</span> You
can restore a database dump to a host other than the one from which it was
originally dumped. You can also change other connection parameters like the
username, password, and port. This can be done from the command line:
```bash
borgmatic restore --archive latest --database users --hostname database2.example.org --port 5433 --username postgres --password trustsome1
```
Or from the configuration file:
```yaml
hooks:
postgresql_databases:
- name: users
hostname: database1.example.org
restore_hostname: database1.example.org
restore_port: 5433
restore_username: postgres
restore_password: trustsome1
```
### Limitations ### Limitations

View file

@ -45,6 +45,22 @@ in the right place before running the command—or see below about the
`--destination` flag. `--destination` flag.
## Extract the configuration file used to create an archive
<span class="minilink minilink-addedin">New in version 1.7.15</span> Borgmatic
also stores the configuration file used to create an archive, inside the
archive itself. This is useful in cases where you've lost your configuration
file, or you want to see what configuration was used to create a particular
archive.
To extract the configuration file from an archive, use the `config bootstrap` action:
```bash
borgmatic config bootstrap --repository repo.borg --destination /tmp
```
This extracts the configuration file from the latest archive in the repository `repo.borg` to `/tmp/config.yaml`.
## Repository selection ## Repository selection
If you have a single repository in your borgmatic configuration file(s), no If you have a single repository in your borgmatic configuration file(s), no