1% BARMAN-CLOUD-WAL-RESTORE(1) Barman User manuals | Version 2.17
2% EnterpriseDB <http://www.enterprisedb.com>
3% December 1, 2021
4
5# NAME
6
7barman-cloud-wal-restore - Restore PostgreSQL WAL files from the Cloud using `restore_command`
8
9
10# SYNOPSIS
11
12barman-cloud-wal-restore [*OPTIONS*] *SOURCE_URL* *SERVER_NAME* *WAL_NAME* *WAL_PATH*
13
14
15# DESCRIPTION
16
17This script can be used as a `restore_command` to download WAL files
18previously archived with `barman-cloud-wal-archive` command.
19Currently AWS S3 and Azure Blob Storage are supported.
20
21This script and Barman are administration tools for disaster recovery
22of PostgreSQL servers written in Python and maintained by EnterpriseDB.
23
24
25# POSITIONAL ARGUMENTS
26
27SOURCE_URL
28:    URL of the cloud source, such as a bucket in AWS S3.
29     For example: `s3://BUCKET_NAME/path/to/folder` (where `BUCKET_NAME`
30     is the bucket you have created in AWS).
31
32SERVER_NAME
33:    the name of the server as configured in Barman.
34
35WAL_NAME
36:    the name of the WAL file, equivalent of '%f' keyword (according to 'restore_command').
37
38WAL_PATH
39:    the value of the '%p' keyword (according to 'restore_command').
40
41# OPTIONS
42
43-h, --help
44:    show a help message and exit
45
46-V, --version
47:    show program's version number and exit
48
49-v, --verbose
50:    increase output verbosity (e.g., -vv is more than -v)
51
52-q, --quiet
53:    decrease output verbosity (e.g., -qq is less than -q)
54
55-t, --test
56:    test connectivity to the cloud destination and exit
57
58--cloud-provider {aws-s3,azure-blob-storage}
59:    the cloud provider to which the backup should be uploaded
60
61-P, --profile
62:    profile name (e.g. INI section in AWS credentials file)
63
64--endpoint-url
65:    override the default S3 URL construction mechanism by specifying an endpoint.
66
67# REFERENCES
68
69For Boto:
70
71* https://boto3.amazonaws.com/v1/documentation/api/latest/guide/configuration.html
72
73For AWS:
74
75* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-set-up.html
76* http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html.
77
78For Azure Blob Storage:
79
80* https://docs.microsoft.com/en-us/azure/storage/blobs/authorize-data-operations-cli#set-environment-variables-for-authorization-parameters
81* https://docs.microsoft.com/en-us/python/api/azure-storage-blob/?view=azure-python
82
83# DEPENDENCIES
84
85If using `--cloud-provider=aws-s3`:
86
87* boto3
88
89If using `--cloud-provider=azure-blob-storage`:
90
91* azure-storage-blob
92* azure-identity (optional, if you wish to use DefaultAzureCredential)
93
94# EXIT STATUS
95
960
97:   Success
98
99Not zero
100:   Failure
101
102
103# BUGS
104
105Barman has been extensively tested, and is currently being used in several
106production environments. However, we cannot exclude the presence of bugs.
107
108Any bug can be reported via the Github issue tracker.
109
110# RESOURCES
111
112* Homepage: <http://www.pgbarman.org/>
113* Documentation: <http://docs.pgbarman.org/>
114* Professional support: <http://www.enterprisedb.com/>
115
116
117# COPYING
118
119Barman is the property of EnterpriseDB UK Limited
120and its code is distributed under GNU General Public License v3.
121
122© Copyright EnterpriseDB UK Limited 2011-2021
123