barman-cloud-restore

NAME

barman-cloud-restore - Restore a PostgreSQL backup from the Cloud

SYNOPSIS

barman-cloud-restore [ OPTIONS] SOURCE_URL SERVER_NAME BACKUP_ID RECOVERY_DIR

DESCRIPTION

This script can be used to download a backup previously made with barman-cloud-backup command. Currently AWS S3, Azure Blob Storage and Google Cloud Storage are supported.

This script can also be used to prepare for recovery from a snapshot backup by checking the attached disks were cloned from the correct snapshots and downloading the backup label from object storage.

This script and Barman are administration tools for disaster recovery of PostgreSQL servers written in Python and maintained by EnterpriseDB.

Usage

usage: barman-cloud-restore [-V] [--help] [-v | -q] [-t]
                            [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}]
                            [--endpoint-url ENDPOINT_URL] [-P PROFILE]
                            [--read-timeout READ_TIMEOUT]
                            [--credential {azure-cli,managed-identity}]
                            [--tablespace NAME:LOCATION]
                            [--snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCE]
                            [--snapshot-recovery-zone SNAPSHOT_RECOVERY_ZONE]
                            source_url server_name backup_id recovery_dir

This script can be used to download a backup previously made with barman-
cloud-backup command.Currently AWS S3, Azure Blob Storage and Google Cloud
Storage are supported.

positional arguments:
  source_url            URL of the cloud source, such as a bucket in AWS S3.
                        For example: `s3://bucket/path/to/folder`.
  server_name           the name of the server as configured in Barman.
  backup_id             the backup ID
  recovery_dir          the path to a directory for recovery.

optional arguments:
  -V, --version         show program's version number and exit
  --help                show this help message and exit
  -v, --verbose         increase output verbosity (e.g., -vv is more than -v)
  -q, --quiet           decrease output verbosity (e.g., -qq is less than -q)
  -t, --test            Test cloud connectivity and exit
  --cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
                        The cloud provider to use as a storage backend
  --tablespace NAME:LOCATION
                        tablespace relocation rule
  --snapshot-recovery-instance SNAPSHOT_RECOVERY_INSTANCE
                        Instance where the disks recovered from the snapshots
                        are attached
  --snapshot-recovery-zone SNAPSHOT_RECOVERY_ZONE
                        Zone containing the instance and disks for the
                        snapshot recovery

Extra options for the aws-s3 cloud provider:
  --endpoint-url ENDPOINT_URL
                        Override default S3 endpoint URL with the given one
  -P PROFILE, --profile PROFILE
                        profile name (e.g. INI section in AWS credentials
                        file)
  --read-timeout READ_TIMEOUT
                        the time in seconds until a timeout is raised when
                        waiting to read from a connection (defaults to 60
                        seconds)

Extra options for the azure-blob-storage cloud provider:
  --credential {azure-cli,managed-identity}
                        Optionally specify the type of credential to use when
                        authenticating with Azure Blob Storage. If omitted
                        then the credential will be obtained from the
                        environment. If no credentials can be found in the
                        environment then the default Azure authentication flow
                        will be used