1BARMAN-CLOUD-WAL-RESTORE(1) Version 3.9.0 BARMAN-CLOUD-WAL-RESTORE(1)
2
6 barman-cloud-wal-restore - Restore PostgreSQL WAL files from the Cloud
7 using restore_command
8
10 barman-cloud-wal-restore [OPTIONS] SOURCE_URL SERVER_NAME WAL_NAME
11 WAL_PATH
12
14 This script can be used as a restore_command to download WAL files pre‐
15 viously archived with barman-cloud-wal-archive command. Currently AWS
16 S3, Azure Blob Storage and Google Cloud Storage are supported.
17 This script and Barman are administration tools for disaster recovery
19 of PostgreSQL servers written in Python and maintained by EnterpriseDB.
20
22 usage: barman-cloud-wal-restore [-V] [--help] [-v | -q] [-t]
23 [--cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}]
24 [--endpoint-url ENDPOINT_URL] [-P AWS_PROFILE]
25 [--profile AWS_PROFILE]
26 [--read-timeout READ_TIMEOUT]
27 [--azure-credential {azure-cli,managed-identity}]
28 source_url server_name wal_name wal_dest
29 This script can be used as a `restore_command` to download WAL files
31 previously archived with barman-cloud-wal-archive command. Currently AWS S3,
32 Azure Blob Storage and Google Cloud Storage are supported.
33 positional arguments:
35 source_url URL of the cloud source, such as a bucket in AWS S3.
36 For example: `s3://bucket/path/to/folder`.
37 server_name the name of the server as configured in Barman.
38 wal_name The value of the '%f' keyword (according to
39 'restore_command').
40 wal_dest The value of the '%p' keyword (according to
41 'restore_command').
42 optional arguments:
44 -V, --version show program's version number and exit
45 --help show this help message and exit
46 -v, --verbose increase output verbosity (e.g., -vv is more than -v)
47 -q, --quiet decrease output verbosity (e.g., -qq is less than -q)
48 -t, --test Test cloud connectivity and exit
49 --cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
50 The cloud provider to use as a storage backend
51 Extra options for the aws-s3 cloud provider:
53 --endpoint-url ENDPOINT_URL
54 Override default S3 endpoint URL with the given one
55 -P AWS_PROFILE, --aws-profile AWS_PROFILE
56 profile name (e.g. INI section in AWS credentials
57 file)
58 --profile AWS_PROFILE
59 profile name (deprecated: replaced by --aws-profile)
60 --read-timeout READ_TIMEOUT
61 the time in seconds until a timeout is raised when
62 waiting to read from a connection (defaults to 60
63 seconds)
64 Extra options for the azure-blob-storage cloud provider:
66 --azure-credential {azure-cli,managed-identity}, --credential {azure-cli,managed-identity}
67 Optionally specify the type of credential to use when
68 authenticating with Azure. If omitted then Azure Blob
69 Storage credentials will be obtained from the
70 environment and the default Azure authentication flow
71 will be used for authenticating with all other Azure
72 services. If no credentials can be found in the
73 environment then the default Azure authentication flow
74 will also be used for Azure Blob Storage.
75
77 For Boto:
78 • https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
80 uration.html
81 For AWS:
83 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
85 ting-set-up.html
86 • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
88 ting-started.html.
89 For Azure Blob Storage:
91 • https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-da‐
93 ta-operations-cli#set-environment-variables-for-authorization-parame‐
94 ters
95 • https://docs.microsoft.com/en-us/python/api/azure-stor‐
97 age-blob/?view=azure-python
98 For Google Cloud Storage: * Credentials:
100 https://cloud.google.com/docs/authentication/getting-started#set‐
101 ting_the_environment_variable
102 Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is support‐
104 ed at the moment.
105
107 If using --cloud-provider=aws-s3:
108 • boto3
110 If using --cloud-provider=azure-blob-storage:
112 • azure-storage-blob
114 • azure-identity (optional, if you wish to use DefaultAzureCredential)
116 If using --cloud-provider=google-cloud-storage * google-cloud-storage
118
120 0 Success
121 1 The requested WAL could not be found
123 2 The connection to the cloud provider failed
125 3 There was an error in the command input
127 Other non-zero codes
129 Failure
130
132 Barman has been extensively tested, and is currently being used in sev‐
133 eral production environments. However, we cannot exclude the presence
134 of bugs.
135 Any bug can be reported via the GitHub issue tracker.
137
139 • Homepage: <https://www.pgbarman.org/>
140 • Documentation: <https://docs.pgbarman.org/>
142 • Professional support: <https://www.enterprisedb.com/>
144
146 Barman is the property of EnterpriseDB UK Limited and its code is dis‐
147 tributed under GNU General Public License v3.
148 © Copyright EnterpriseDB UK Limited 2011-2023
150
152 EnterpriseDB <https://www.enterprisedb.com>.
153Barman User manuals October 3, 2023 BARMAN-CLOUD-WAL-RESTORE(1)