1BARMAN-CLOUD-WAL-RESTORE(1)      Version 3.0.1     BARMAN-CLOUD-WAL-RESTORE(1)
2
3
4

NAME

6       barman-cloud-wal-restore  - Restore PostgreSQL WAL files from the Cloud
7       using restore_command
8

SYNOPSIS

10       barman-cloud-wal-restore  [OPTIONS]  SOURCE_URL  SERVER_NAME   WAL_NAME
11       WAL_PATH
12

DESCRIPTION

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
18       This  script  and Barman are administration tools for disaster recovery
19       of PostgreSQL servers written in Python and maintained by EnterpriseDB.
20

POSITIONAL ARGUMENTS

22       SOURCE_URL
23              URL of the cloud source, such as a bucket in AWS S3.  For  exam‐
24              ple:  s3://BUCKET_NAME/path/to/folder  (where BUCKET_NAME is the
25              bucket you have created in AWS).
26
27       SERVER_NAME
28              the name of the server as configured in Barman.
29
30       WAL_NAME
31              the name of the WAL file, equivalent of `%f' keyword  (according
32              to `restore_command').
33
34       WAL_PATH
35              the value of the `%p' keyword (according to `restore_command').
36

OPTIONS

38       -h, –help
39              show a help message and exit
40
41       -V, –version
42              show program's version number and exit
43
44       -v, –verbose
45              increase output verbosity (e.g., -vv is more than -v)
46
47       -q, –quiet
48              decrease output verbosity (e.g., -qq is less than -q)
49
50       -t, –test
51              test connectivity to the cloud destination and exit
52
53       –cloud-provider {aws-s3,azure-blob-storage,google-cloud-storage}
54              the cloud provider to which the backup should be uploaded
55
56       -P, –profile
57              profile name (e.g. INI section in AWS credentials file)
58
59       –endpoint-url
60              override the default S3 URL construction mechanism by specifying
61              an endpoint.
62
63       –credential {azure-cli,managed-identity}
64              optionally specify the type of credential to use when  authenti‐
65              cating  with Azure Blob Storage.  If omitted then the credential
66              will be obtained from the environment.  If no credentials can be
67              found  in  the environment then the default Azure authentication
68              flow will be used.
69

REFERENCES

71       For Boto:
72
73       • https://boto3.amazonaws.com/v1/documentation/api/latest/guide/config‐
74         uration.html
75
76       For AWS:
77
78       • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
79         ting-set-up.html
80
81       • https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-get‐
82         ting-started.html.
83
84       For Azure Blob Storage:
85
86       • https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-da‐
87         ta-operations-cli#set-environment-variables-for-authorization-parame‐
88         ters
89
90       • https://docs.microsoft.com/en-us/python/api/azure-stor‐
91         age-blob/?view=azure-python
92
93       For       Google       Cloud       Storage:       *        Credentials:
94       https://cloud.google.com/docs/authentication/getting-started#set‐
95       ting_the_environment_variable
96
97       Only authentication with GOOGLE_APPLICATION_CREDENTIALS env is support‐
98       ed at the moment.
99

DEPENDENCIES

101       If using --cloud-provider=aws-s3:
102
103       • boto3
104
105       If using --cloud-provider=azure-blob-storage:
106
107       • azure-storage-blob
108
109       • azure-identity (optional, if you wish to use DefaultAzureCredential)
110
111       If using --cloud-provider=google-cloud-storage * google-cloud-storage
112

EXIT STATUS

114       0      Success
115
116       1      The requested WAL could not be found
117
118       2      The connection to the cloud provider failed
119
120       3      There was an error in the command input
121
122       Other non-zero codes
123              Failure
124

BUGS

126       Barman has been extensively tested, and is currently being used in sev‐
127       eral production environments.  However, we cannot exclude the  presence
128       of bugs.
129
130       Any bug can be reported via the Github issue tracker.
131

RESOURCES

133       • Homepage: <https://www.pgbarman.org/>
134
135       • Documentation: <https://docs.pgbarman.org/>
136
137       • Professional support: <https://www.enterprisedb.com/>
138

COPYING

140       Barman  is the property of EnterpriseDB UK Limited and its code is dis‐
141       tributed under GNU General Public License v3.
142
143       © Copyright EnterpriseDB UK Limited 2011-2022
144

AUTHORS

146       EnterpriseDB <https://www.enterprisedb.com>.
147
148
149
150Barman User manuals              June 27, 2022     BARMAN-CLOUD-WAL-RESTORE(1)