Movatterモバイル変換

pg_dumpall [connection-option...] [option...]

-a
--data-only

Dump only the data, not the schema (data definitions).

-c
--clean

Emit SQL commands toDROP all the dumped databases, roles, and tablespaces before recreating them. This option is useful when the restore is to overwrite an existing cluster. If any of the objects do not exist in the destination cluster, ignorable error messages will be reported during restore, unless--if-exists is also specified.

-Eencoding
--encoding=encoding

Create the dump in the specified character set encoding. By default, the dump is created in the database encoding. (Another way to get the same result is to set thePGCLIENTENCODING environment variable to the desired dump encoding.)

-ffilename
--file=filename

Send output to the specified file. If this is omitted, the standard output is used.

--filter=filename

Specify a filename from which to read patterns for databases excluded from the dump. The patterns are interpreted according to the same rules as--exclude-database. To read fromSTDIN, use- as the filename. The--filter option can be specified in conjunction with--exclude-database for excluding databases, and can also be specified more than once for multiple filter files.

The file lists one database pattern per row, with the following format:

exclude databasePATTERN

Lines starting with# are considered comments and ignored. Comments can be placed after an object pattern row as well. Blank lines are also ignored. SeePatterns for how to perform quoting in patterns.

-g
--globals-only

Dump only global objects (roles and tablespaces), no databases.

-O
--no-owner

Do not output commands to set ownership of objects to match the original database. By default,pg_dumpall issuesALTER OWNER orSET SESSION AUTHORIZATION statements to set ownership of created schema elements. These statements will fail when the script is run unless it is started by a superuser (or the same user that owns all of the objects in the script). To make a script that can be restored by any user, but will give that user ownership of all the objects, specify-O.

-r
--roles-only

Dump only roles, no databases or tablespaces.

-s
--schema-only

Dump only the object definitions (schema), not data.

-Susername
--superuser=username

Specify the superuser user name to use when disabling triggers. This is relevant only if--disable-triggers is used. (Usually, it's better to leave this out, and instead start the resulting script as superuser.)

-t
--tablespaces-only

Dump only tablespaces, no databases or roles.

-v
--verbose

Specifies verbose mode. This will causepg_dumpall to output start/stop times to the dump file, and progress messages to standard error. Repeating the option causes additional debug-level messages to appear on standard error. The option is also passed down topg_dump.

-V
--version

Print thepg_dumpall version and exit.

-x
--no-privileges
--no-acl

Prevent dumping of access privileges (grant/revoke commands).

--binary-upgrade

This option is for use by in-place upgrade utilities. Its use for other purposes is not recommended or supported. The behavior of the option may change in future releases without notice.

--column-inserts
--attribute-inserts

Dump data asINSERT commands with explicit column names (INSERT INTOtable (column, ...) VALUES ...). This will make restoration very slow; it is mainly useful for making dumps that can be loaded into non-PostgreSQL databases.

--disable-dollar-quoting

This option disables the use of dollar quoting for function bodies, and forces them to be quoted using SQL standard string syntax.

--disable-triggers

This option is relevant only when creating a data-only dump. It instructspg_dumpall to include commands to temporarily disable triggers on the target tables while the data is restored. Use this if you have referential integrity checks or other triggers on the tables that you do not want to invoke during data restore.

Presently, the commands emitted for--disable-triggers must be done as superuser. So, you should also specify a superuser name with-S, or preferably be careful to start the resulting script as a superuser.

--exclude-database=pattern

Do not dump databases whose name matchespattern. Multiple patterns can be excluded by writing multiple--exclude-database switches. Thepattern parameter is interpreted as a pattern according to the same rules used bypsql's\d commands (seePatterns), so multiple databases can also be excluded by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent shell wildcard expansion.

--extra-float-digits=ndigits

Use the specified value of extra_float_digits when dumping floating-point data, instead of the maximum available precision. Routine dumps made for backup purposes should not use this option.

--if-exists

UseDROP ... IF EXISTS commands to drop objects in--clean mode. This suppresses“does not exist” errors that might otherwise be reported. This option is not valid unless--clean is also specified.

--inserts

Dump data asINSERT commands (rather thanCOPY). This will make restoration very slow; it is mainly useful for making dumps that can be loaded into non-PostgreSQL databases. Note that the restore might fail altogether if you have rearranged column order. The--column-inserts option is safer, though even slower.

--load-via-partition-root

When dumping data for a table partition, make theCOPY orINSERT statements target the root of the partitioning hierarchy that contains it, rather than the partition itself. This causes the appropriate partition to be re-determined for each row when the data is loaded. This may be useful when restoring data on a server where rows do not always fall into the same partitions as they did on the original server. That could happen, for example, if the partitioning column is of type text and the two systems have different definitions of the collation used to sort the partitioning column.

--lock-wait-timeout=timeout

Do not wait forever to acquire shared table locks at the beginning of the dump. Instead, fail if unable to lock a table within the specifiedtimeout. The timeout may be specified in any of the formats accepted bySET statement_timeout.

--no-comments

Do not dump comments.

--no-publications

Do not dump publications.

--no-role-passwords

Do not dump passwords for roles. When restored, roles will have a null password, and password authentication will always fail until the password is set. Since password values aren't needed when this option is specified, the role information is read from the catalog viewpg_roles instead ofpg_authid. Therefore, this option also helps if access topg_authid is restricted by some security policy.

--no-security-labels

Do not dump security labels.

--no-subscriptions

Do not dump subscriptions.

--no-sync

By default,pg_dumpall will wait for all files to be written safely to disk. This option causespg_dumpall to return without waiting, which is faster, but means that a subsequent operating system crash can leave the dump corrupt. Generally, this option is useful for testing but should not be used when dumping data from production installation.

--no-table-access-method

Do not output commands to select table access methods. With this option, all objects will be created with whichever table access method is the default during restore.

--no-tablespaces

Do not output commands to create tablespaces nor select tablespaces for objects. With this option, all objects will be created in whichever tablespace is the default during restore.

--no-toast-compression

Do not output commands to setTOAST compression methods. With this option, all columns will be restored with the default compression setting.

--no-unlogged-table-data

Do not dump the contents of unlogged tables. This option has no effect on whether or not the table definitions (schema) are dumped; it only suppresses dumping the table data.

--on-conflict-do-nothing

AddON CONFLICT DO NOTHING toINSERT commands. This option is not valid unless--inserts or--column-inserts is also specified.

--quote-all-identifiers

Force quoting of all identifiers. This option is recommended when dumping a database from a server whosePostgreSQL major version is different frompg_dumpall's, or when the output is intended to be loaded into a server of a different major version. By default,pg_dumpall quotes only identifiers that are reserved words in its own major version. This sometimes results in compatibility issues when dealing with servers of other versions that may have slightly different sets of reserved words. Using--quote-all-identifiers prevents such issues, at the price of a harder-to-read dump script.

--rows-per-insert=nrows

Dump data asINSERT commands (rather thanCOPY). Controls the maximum number of rows perINSERT command. The value specified must be a number greater than zero. Any error during restoring will cause only rows that are part of the problematicINSERT to be lost, rather than the entire table contents.

--use-set-session-authorization

Output SQL-standardSET SESSION AUTHORIZATION commands instead ofALTER OWNER commands to determine object ownership. This makes the dump more standards compatible, but depending on the history of the objects in the dump, might not restore properly.

-?
--help

Show help aboutpg_dumpall command line arguments, and exit.

-dconnstr
--dbname=connstr

Specifies parameters used to connect to the server, as aconnection string; these will override any conflicting command line options.

The option is called--dbname for consistency with other client applications, but becausepg_dumpall needs to connect to many databases, the database name in the connection string will be ignored. Use the-l option to specify the name of the database used for the initial connection, which will dump global objects and discover what other databases should be dumped.

-hhost
--host=host

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

-ldbname
--database=dbname

Specifies the name of the database to connect to for dumping global objects and discovering what other databases should be dumped. If not specified, thepostgres database will be used, and if that does not exist,template1 will be used.

-pport
--port=port

Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to thePGPORT environment variable, if set, or a compiled-in default.

-Uusername
--username=username

User name to connect as.

-w
--no-password

Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a.pgpass file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.

-W
--password

Forcepg_dumpall to prompt for a password before connecting to a database.

This option is never essential, sincepg_dumpall will automatically prompt for a password if the server demands password authentication. However,pg_dumpall will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing-W to avoid the extra connection attempt.

Note that the password prompt will occur again for each database to be dumped. Usually, it's better to set up a~/.pgpass file than to rely on manual password entry.

--role=rolename

Specifies a role name to be used to create the dump. This option causespg_dumpall to issue aSET ROLErolename command after connecting to the database. It is useful when the authenticated user (specified by-U) lacks privileges needed bypg_dumpall, but can switch to a role with the required rights. Some installations have a policy against logging in directly as a superuser, and use of this option allows dumps to be made without violating the policy.

PGHOST
PGOPTIONS
PGPORT
PGUSER

Default connection parameters

PG_COLOR

Specifies whether to use color in diagnostic messages. Possible values arealways,auto andnever.