restore

Here's the command-line help for this action in the most recent version of borgmatic. If you're using an older version, some of these flags may not work, and you should instead run the action with --help to see the flags specific to your borgmatic version.

usage: borgmatic restore [--repository REPOSITORY] --archive ARCHIVE
                         [--data-source NAME] [--schema NAME]
                         [--hostname HOSTNAME] [--port PORT]
                         [--container CONTAINER] [--username USERNAME]
                         [--password PASSWORD] [--restore-path RESTORE_PATH]
                         [--original-label ORIGINAL_LABEL]
                         [--original-hostname ORIGINAL_HOSTNAME]
                         [--original-container ORIGINAL_CONTAINER]
                         [--original-port ORIGINAL_PORT] [--hook HOOK] [-h]

Restore data source (e.g. database) dumps from a named archive. (To extract
files instead, use "borgmatic extract".)

restore arguments:
  --repository REPOSITORY
                        Path of repository to restore from, defaults to the
                        configured repository if there is only one, quoted
                        globs supported
  --archive ARCHIVE     Name or hash of a single archive to restore from (or
                        "latest")
  --data-source NAME, --database NAME
                        Name of data source (e.g. database) to restore from
                        the archive, must be defined in borgmatic's
                        configuration, can specify the flag multiple times,
                        defaults to all data sources in the archive
  --schema NAME         Name of schema to restore from the data source, can
                        specify flag multiple times, defaults to all schemas.
                        Schemas are only supported for PostgreSQL and MongoDB
                        databases
  --hostname HOSTNAME   Database hostname to restore to. Defaults to the
                        "restore_hostname" option in borgmatic's configuration
  --port PORT           Database port to restore to. Defaults to the
                        "restore_port" option in borgmatic's configuration
  --container CONTAINER
                        Container to restore to. Defaults to the
                        "restore_container" option in borgmatic's
                        configuration
  --username USERNAME   Username with which to connect to the database.
                        Defaults to the "restore_username" option in
                        borgmatic's configuration
  --password PASSWORD   Password with which to connect to the restore
                        database. Defaults to the "restore_password" option in
                        borgmatic's configuration
  --restore-path RESTORE_PATH
                        Path to restore SQLite database dumps to. Defaults to
                        the "restore_path" option in borgmatic's configuration
  --original-label ORIGINAL_LABEL
                        The label where the dump to restore came from, only
                        necessary if you need to disambiguate dumps
  --original-hostname ORIGINAL_HOSTNAME
                        The hostname where the dump to restore came from, only
                        necessary if you need to disambiguate dumps
  --original-container ORIGINAL_CONTAINER
                        The container where the dump to restore came from,
                        only necessary if you need to disambiguate dumps
  --original-port ORIGINAL_PORT
                        The port where the dump to restore came from (if that
                        port is in borgmatic's configuration), only necessary
                        if you need to disambiguate dumps
  --hook HOOK           The name of the data source hook for the dump to
                        restore, only necessary if you need to disambiguate
                        dumps
  -h, --help            Show this help message and exit

Related documentation

• Database restoration