View Source: pg_dumpall(1) - Waikato Linux Users Group

You are viewing an old revision of this page. View the current version.

PG_DUMPALL
!!!PG_DUMPALL
NAME
SYNOPSIS
DESCRIPTION
EXAMPLES
SEE ALSO
----
!!NAME


pg_dumpall - extract all PostgreSQL databases into a script file
!!SYNOPSIS


__pg_dumpall__ [[ __-c__ | __--clean__ ] [[ __-g__
| __--globals-only__ ] [[ __-h__ ''host'' ] [[
__-p__ ''port'' ] [[ __-U__ ''username'' ] [[
__-W__ ]
!!DESCRIPTION


__pg_dumpall__ is a utility for writing out (``dumping'')
all PostgreSQL databases of a cluster into one script file.
The script file contains SQL commands that can be used as
input to psql(1) to restore the databases. It does
this by calling __pg_dump__(1) for each database in a
cluster. __pg_dumpall__ also dumps global objects that
are common to all databases. (__pg_dump__ does not save
these objects.) This currently includes the information
about database users and groups.


Thus, __pg_dumpall__ is an integrated solution for
backing up your databases. But note a limitation: it cannot
dump ``large objects'', since __pg_dump__ cannot dump
such objects into text files. If you have databases
containing large objects, they should be dumped using one of
__pg_dump__'s non-text output modes.


Since __pg_dumpall__ reads tables from all databases you
will most likely have to connect as a database superuser in
order to produce a complete dump. Also you will need
superuser privileges to execute the saved script in order to
be allowed to add users and groups, and to create
databases.


The SQL script will be written to the standard output. Shell
operators should be used to redirect it into a
file.


__OPTIONS__


__pg_dumpall__ accepts the following command line
arguments:


__-c, --clean__


Include SQL commands to clean (drop) database objects before
recreating them. (This option is fairly useless, since the
output script expects to create the databases themselves;
they would always be empty upon creation.)


__-g, --globals-only__


Only dump global objects (users and groups), no
databases.


__-h__ ''host''


Specifies the host name of the machine on which the database
server is running. If host begins with a slash, it is used
as the directory for the Unix domain socket. The default is
taken from the __PGHOST__ environment variable, if set,
else a Unix domain socket connection is
attempted.


__-p__ ''port''


The port number on which the server is listening. Defaults
to the __PGPORT__ environment variable, if set, or a
compiled-in default.


__-U__ ''username''


Connect as the given user.


__-W__


Force a password prompt. This should happen automatically if
the server requires password authentication.


Any other command line parameters are passed to the
underlying __pg_dump__(1) calls. This is useful to
control some aspects of the output format, but some options
such as __-f__, __-t__, and ''dbname'' should be
avoided.
!!EXAMPLES


To dump all databases:


$ __pg_dumpall
__To reload this database use, for example:


$ __psql -f db.out template1
__(It is not important to which database you connect here since the script file created by __pg_dumpall__ will contain the appropriate commands to create and connect to the saved databases.)
!!SEE ALSO


__pg_dump__(1), psql(1). Check there for details
on possible error conditions.
----

2 pages link to pg_dumpall(1):

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Version 1, saved on Tuesday, June 4, 2002 12:22:41 am by "perry"

Edit PageHistory Diff Info LikePages