3 .\" Author: Nikolas Coukouma <atrus@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
6 .\" Manual: System Administration Commands
7 .\" Source: Amanda 3.3.2
10 .TH "AMPGSQL" "8" "07/25/2012" "Amanda 3\&.3\&.2" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 ampgsql \- Amanda Application to interface with PostgreSQL
34 Ampgsql is an Amanda Application API script\&. It should not be run by users directly\&. It implements on\-line backups of PostgreSQL databases in conjunction with WAL archiving\&.
40 .nr an-no-space-flag 1
48 Tablespaces are not currently supported\&.
56 .nr an-no-space-flag 1
64 On versions of PostgreSQL earlier than 8\&.2, if the database is quiet during a full backup, then the backup may not complete until enough database activity takes place to trigger the archiving of the current WAL file\&. Consider adjusting the PG\-MAX\-WAL\-WAIT property from its default (60s) to compensate\&. Note that you will need to increase
66 on the server accordingly\&.
71 This application implements the backup strategy described in
72 http://www\&.postgresql\&.org/docs/current/static/continuous\-archiving\&.html\&. For a level zero (full) backup, ampgsql:
82 execute PG_START_BACKUP()
93 dump the data directory
104 execute PG_STOP_BACKUP()
115 wait for the final WAL file to be archived
126 back up the required WAL files
137 optionally delete WAL files that are no longer necessary
140 The two dumps are made with GNU Tar, to
143 archive_dir, respectively\&. They are then combined into a single tar file\&.
145 A level N backup creates a single tar file containing all WAL files since the previous level N\-1 backup\&.
148 This section lists the
150 properties that control ampsql\*(Aqs functionality\&. See
151 \fBamanda-applications\fR(7)
152 for information on application properties and how they are configured\&.
156 Directory that WAL segment files are archived to, as specified by the archive_command in PosgreSQL\*(Aqs postgresql\&.conf\&. The amanda user on the client must have at least read and execute permission on this directory, and preferably write\&. Without write permission, Amanda cannot clean up expired WAL and backup files\&.
161 Whether or not to remove old WAL segment files during base backups\&. Defaults to yes\&.
166 Database to connect to\&. Defaults to "template1" (which exists by default)\&.
171 For restore command only, the data is recoved in that directory\&. Must be a unix path\&.
176 Path to the GNU tar executable\&. This option only has an effect during restore\&. The default is set when Amanda is built by the \-\-with\-gnutar configure option\&.
181 Host to connect to\&. If it starts with "/" it will be interepreted as a directory that holds the socket file\&. PostgreSQL defaults to /tmp\&.
186 The maximum amount of time to wait for PG_STOP_BACKUP to archive a WAL file\&. In versions of PostgreSQL before 8\&.2, PG_STOP_BACKUP does not automatically archive the latest WAL file, so a quiet database may wait a very long time before archiving the WAL file\&. Default: 60 seconds\&. Set to 0 to wait forever\&.
191 Connect using the creditials in this file\&. Each line should have the format "hostname:port:database:username:password"\&. The permissions must permit it to be read only by the user, or the file will not be used\&. Only usable with Postgres 8\&.1 and up\&.
196 The TCP port to connect to, or the suffix of the socket file\&. PostgreSQL defaults to 5432\&.
201 Path to the psql binary\&. If not specified, the PATH environment variable will be searched\&.
206 Directory for saving state about backups already made\&. The default is set when Amanda is built by the \-\-with\-gnutar\-listdir configure option\&.
211 Directory to use for temporary files during the backup process\&. It should have enough space to store a complete copy of the database\&. The default is set when Amanda is built by the \-\-with\-tmpdir configure option\&.
216 User to connect as\&. It must be a superuser\&.
218 .SH "CLIENT PROPERTIES"
220 Client properties are deprecated\&. All properties should be set in the dumptype\&.
222 This section lists the
223 \fBamanda-client.conf\fR(5)
224 properties that control ampsql\*(Aqs functionality\&. If a property is prefixed with the diskname and an underscore, then it will be used when that diskname is being backed up\&. For example, if the properties PG\-DATADIR and foo\-PG\-DATADIR are set, the value of PG\-DATADIR will be used when bar and baz are being backed up, but foo\-PG\-DATADIR will be used when foo is being backed up\&. Disknames are specified in the
230 Directory that WAL segment files are archived to, as specified by the archive_command
231 in PosgreSQL\*(Aqs postgresql\&.conf\&. The amanda user on the client must have at least read
232 and execute permission on this directory, and preferably write\&. Without write permission,
233 Amanda cannot clean up expired WAL and backup files\&.
239 Whether or not to remove old WAL segment files during base backups\&.
246 Cluster data directory
252 Database to connect to\&. Defaults to "template1" (which exists by default)\&.
258 Host to connect to\&. If it starts with "/" it will be interepreted as a directory
259 that holds the socket file\&. PostgreSQL defaults to /tmp\&.
264 The maximum amount of time to wait for PG_STOP_BACKUP to archive a WAL file\&. In versions of PostgreSQL before 8\&.2, PG_STOP_BACKUP does not automatically archive the latest WAL file, so a quiet database may wait a very long time before archiving the WAL file\&. Default: 60 seconds\&. Set to 0 to wait forever\&.
270 Connect using the creditials in this file\&. Each line should have the format
271 "hostname:port:database:username:password"\&. The permissions must
272 permit it to be read only by the user, or the file will not be used\&.
273 Only usable with Postgres 8\&.1 and up\&.
279 Password to use when connecting\&. Deprecated in favor of passfiles\&.
285 The TCP port to connect to, or the suffix of the socket file\&. PostgreSQL
292 User to connect as\&. It must be a superuser\&.
298 Path to the psql binary\&. If not specified, the PATH environment variable
303 Read the postgres documentation carefully before attempting a recovery\&. This section is only a rough guide to the process\&.
305 The data recovered from a postgres backup consists of a data tarball and one or more archive tarballs\&. The data contains the state of the database at the time the full backup was performed, and the archive tarballs contain postgres WAL files that must be re\-run to generate a consistent state\&.
307 Ensure that the database server is shut down, and move the existing data directory aside\&. Untar the data tarball over this directory, and verify that ownership and permissions are correct\&. Untar all of the archive tarballs into a single directory \- the archive directory\&. Create a
309 in the data directory, owned by the proper user and with proper permissions\&. Add a
310 \fBrestore_command\fR
313 restore_command = \*(Aqcp /path/to/archive_dir/%f "%p"\*(Aq
316 Start the database server, and examine the logs to track the process of the recovery\&. When the recovery is complete, the server will transition into a running state, and will move the
318 file aside so that it will not attempt a recovery on the next invocation\&.
322 \fBamanda.conf\fR(5),
323 \fBamanda-client.conf\fR(5),
324 \fBamanda-applications\fR(7)
327 : http://wiki.zmanda.com/
330 \fBNikolas Coukouma\fR <\&atrus@zmanda\&.com\&>
332 Zmanda, Inc\&. (http://www\&.zmanda\&.com)