pg_restore

Restores a database from an archive file created by pg_dump.

Synopsis

pg_restore [<connection-option> ...] [<restore_option> ...] [<filename>]

pg_restore -? | --help

pg_restore -V | --version

Description

pg_restore is a utility for restoring a database from an archive created by pg_dump in one of the non-plain-text formats. It will issue the commands necessary to reconstruct the database to the state it was in at the time it was saved. The archive files also allow pg_restore to be selective about what is restored, or even to reorder the items prior to being restored.

pg_restore can operate in two modes. If a database name is specified, the archive is restored directly into the database. Otherwise, a script containing the SQL commands necessary to rebuild the database is created and written to a file or standard output. The script output is equivalent to the plain text output format of pg_dump. Some of the options controlling the output are therefore analogous to pg_dump options.

pg_restore cannot restore information that is not present in the archive file. For instance, if the archive was made using the "dump data as INSERT commands" option, pg_restore will not be able to load the data using COPY statements.

Options

filename

Specifies the location of the archive file (or directory, for a directory-format archive) to be restored. If not specified, the standard input is used.

Restore Options

-a | --data-only

Restore only the data, not the schema (data definitions). Table data and sequence values are restored, if present in the archive.

This option is similar to, but for historical reasons not identical to, specifying --section=data.

-c | --clean

Clean (drop) database objects before recreating them. (If you do not also specify --if-exists, this may generate some harmless error messages if any objects were not present in the destination database.)

-C | --create

Create the database before restoring into it. If --clean is also specified, drop and recreate the target database before connecting to it.

With --create, pg_restore also restores the database's comment if any, and any configuration variable settings that are specific to this database, that is, any ALTER DATABASE ... SET ... and ALTER ROLE ... IN DATABASE ... SET ... commands that mention this database. Access privileges for the database itself are also restored, unless --no-acl is specified.

When this option is used, the database named with -d is used only to issue the initial DROP DATABASE and CREATE DATABASE commands. All data is restored into the database name that appears in the archive.

-d dbname | --dbname=dbname

Connect to this database and restore directly into this database. The dbname can be a Connection Strings. If so, connection string parameters override any conflicting command line options.

-e | --exit-on-error

Exit if an error is encountered while sending SQL commands to the database. The default is to continue and to display a count of errors at the end of the restoration.

-f outfilename | --file=outfilename

Specify output file for generated script, or for the listing when used with -l. Use - for stdout.

-F c|d|t | --format={custom | directory | tar}

The format of the archive produced by pg_dump. It is not necessary to specify the format, since pg_restore will determine the format automatically. Format can be custom, directory, or tar.

-I index | --index=index

Restore definition of named index only. You can specify multiple indexes with multiple -I switches.

-j | --number-of-jobs | --jobs=number-of-jobs

Run the most time-consuming parts of pg_restore — those which load data, create indexes, or create constraints — using multiple concurrent jobs. This option can dramatically reduce the time to restore a large database to a server running on a multiprocessor machine. This option is ignored when emitting a script rather than connecting directly to a database server.

Each job is one process or one thread, depending on the operating system, and uses a separate connection to the server.

The optimal value for this option depends on the hardware setup of the server, of the client, and of the network. Factors include the number of CPU cores and the disk setup. A good place to start is the number of CPU cores on the server, but values larger than that can also lead to faster restore times in many cases. Of course, values that are too high will lead to decreased performance because of thrashing.

Only the custom and directory archive formats ase supported with this option. The input file must be a regular file or directory (not, for example, a pipe or standard input). Also, multiple jobs cannot be used together with the option --single-transaction.

-l | --list

List the table contents of the archive. The output of this operation can be used as input to the -L option. Note that if filtering switches such as -n or -t are used with -l, they restrict the items listed.

-L list-file | --use-list=list-file

Restore only those archive elements that are listed in list-file, and restore them in the order they appear in the file. Note that if filtering switches such as -n or -t are used with -L, they further restrict the items restored.

list-file is normally created by editing the output of a previous -l operation. Lines can be moved or removed, and can also be commented out by placing a semicolon ( ;) at the start of the line. See below for examples.

-n schema | --schema=schema

Restore only objects that are in the named schema. You can specify multiple schemas with multiple -n switches. Combine with the -t option to restore just a specific table.

-N schema | --exclude-schema=schema

Do not restore objects that are in the named schema. You can specify multiple schemas to exclude with multiple -N switches.

When both -n and -N are specified for the same schema name, the -N switch takes precedence and the schema is excluded.

-O | --no-owner

Do not output commands to set ownership of objects to match the original database. By default, pg_restore issues ALTER OWNER or SET SESSION AUTHORIZATION statements to set ownership of created schema elements. These statements will fail unless the initial connection to the database is made by a superuser (or the same user that owns all of the objects in the script). With -O, any user name can be used for the initial connection, and this user will own all the created objects.

-P function-name(argtype [, ...]) | --function=function-name(argtype [, ...])

Restore the named function only. The function name must be enclosed in quotes. Be careful to spell the function name and arguments exactly as they appear in the dump file's table of contents (as shown by the --list option). You can specify multiple functions with multiple -P switches.

-s | --schema-only

Restore only the schema (data definitions), not data, to the extent that schema entries are present in the archive.

This option is the inverse of --data-only. It is similar to, but for historical reasons not identical to, specifying --section=pre-data --section=post-data.

(Do not confuse this with the --schema option, which uses the word schema in a different meaning.)

-S username | --superuser=username

Specify the superuser user name to use when deactivating triggers. This is only relevant if --disable-triggers is used.

Note

Greenplum Database does not support user-defined triggers.

-t table | --table=table

Restore definition and/or data of the named table only. "table" includes views, materialized views, sequences, and foreign tables. You can specify multiple tables with multiple -t switches. Combine this option with the -n option to specify table(s) in a particular schema.

When you specify -t, pg_restore makes no attempt to restore any other database objects that the selected table(s) might depend upon. Therefore, there is no guarantee that a specific-table restore into a clean database will succeed.

This option does not behave identically to the -t option of pg_dump. pg_restore does not currently support wild-card matching, nor can you include a schema name within its -t. And, while pg_dump's -t flag will also dump subsidiary objects (such as indexes) of the selected table(s), pg_restore's -t flag does not include such subsidiary objects.

Note

In versions prior to Greenplum 7, this flag matched only tables, not any other type of relation.

-T trigger | --trigger=trigger

Restore named trigger only.

Note

Greenplum Database does not support user-defined triggers.

-v | --verbose

Specifies verbose mode.

-V | --version

Print the pg_restore version and exit.

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

Prevent restoration of access privileges ( GRANT/REVOKE commands).

-1 | --single-transaction

Run the restore as a single transaction (that is, wrap the emitted commands in BEGIN/ COMMIT1). This ensures that either all of the commands complete successfully, or no changes are applied. This option implies --exit-on-error`.

--disable-triggers

This option is relevant only when performing a data-only restore. It instructs pg_restore to run commands to temporarily deactivate triggers on the target tables while the data is reloaded. Use this if you have triggers on the tables that you do not want to invoke during data reload. The commands emitted for --disable-triggers must be invoked as superuser. So you should also specify a superuser name with -S or, preferably, run pg_restore as a superuser.

Note

Greenplum Database does not support user-defined triggers.

--enable-row-security

This option is relevant only when restoring the contents of a table which has row security. By default, pg_restore sets row_security to off, to ensure that all data is restored in to the table. If the user does not have sufficient privileges to bypass row security, then an error is thrown. This parameter instructs pg_restore to set row_security to on instead, allowing the user to attempt to restore the contents of the table with row security enabled. This might still fail if the user does not have the right to insert the rows from the dump into the table.

This option currently also requires the dump be in INSERT format, as COPY FROM does not support row security.

--if-exists

Use conditional commands (for example, add an IF EXISTS clause) to drop database objects. This option is not valid unless --clean is also specified.

--no-comments

Do not output commands to restore comments, even if the archive contains them.

--no-data-for-failed-tables

By default, table data is restored even if the creation command for the table failed (for example, because it already exists). With this option, data for such a table is skipped. This behavior is useful when the target database may already contain the desired table contents. Specifying this option prevents duplicate or obsolete data from being loaded. This option is effective only when restoring directly into a database, not when producing SQL script output.

--no-security-labels

Do not output commands to restore security labels, even if the archive contains them.

--no-tablespaces

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

--section=sectionname

Only restore the named section. The section name can be pre-data, data, or post-data. This option can be specified more than once to select multiple sections.

The data section contains actual table data. Post-data items consist of definitions of indexes, triggers, rules, and constraints other than validated check constraints. Pre-data items consist of all other data definition items.

The default is to restore all sections.

--strict-names

Require that each schema ( -n/ --schema) and table ( -t/ --table) qualifier match at least one schema/table in the backup file.

--use-set-session-authorization

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

-? | --help

Show help about pg_restore command line arguments, and exit.

Connection Options

-h host | --host host

The host name of the machine on which the Greenplum coordinator database server is running. If not specified, reads from the environment variable PGHOST or defaults to localhost.

-p port | --port port

The TCP port on which the Greenplum Database coordinator database server is listening for connections. If not specified, reads from the environment variable PGPORT or defaults to 5432.

-U username | --username username

The database role name to connect as. If not specified, reads from the environment variable PGUSER or defaults to the current system role name.

-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

Force a password prompt.

This option is never required, since pg_restore automatically prompts for a password if the server demands password authentication. However, pg_restore will waste a connection attempt determinig that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt.

--role=rolename

Specifies a role name to be used to perform the restore. This option causes pg_restore to issue a SET ROLE <rolename> command after connecting to the database. It is useful when the authenticated user (specified by -U) lacks privileges needed by pg_restore, 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 restores to be performed without violating the policy.

Environment

PGHOST

PGOPTIONS

PGPORT

PGUSER

Default connection parameters.

PG_COLOR

Specifies whether to use color in diagnostic messages. Possible values are always, auto, and never.

This utility also uses the environment variables supported by libpq.

Diagnostics

When you specify a direct database connection using the -d option, pg_restore internally executes SQL statements. If you have problems running pg_restore, make sure you are able to select information from the database using, for example, psql. Also, any default connection settings and environment variables used by the libpq front-end library will apply.

Notes

If your installation has any local additions to the template1 database, be careful to load the output of pg_restore into a truly empty database; otherwise you are likely to get errors due to duplicate definitions of the added objects. To make an empty database without any local additions, copy from template0 not template1, for example:

CREATE DATABASE foo WITH TEMPLATE template0;

When restoring data to a pre-existing table and the option --disable-triggers is used, pg_restore emits commands to deactivate triggers on user tables before inserting the data, then emits commands to re-enable them after the data has been inserted. If the restore is stopped in the middle, the system catalogs may be left in the wrong state.

See also the pg_dump documentation for details on limitations of pg_dump.

Once restored, it is wise to run ANALYZE on each restored table so the query planner has useful statistics.

Examples

Assume we have dumped a database called mydb into a custom-format dump file:

pg_dump -Fc mydb > db.dump

To drop the database and recreate it from the dump:

dropdb mydb
pg_restore -C -d template1 db.dump

Run the following commands to reload the dump into a new database called newdb. Notice there is no -C option provided. Instead, connect directly to the database to which to restore to. Also note that the new database is cloned from template0 not template1, to ensure that it is initially empty:

createdb -T template0 newdb
pg_restore -d newdb db.dump

To reorder database items, you must first dump the table of contents of the archive:

pg_restore -l db.dump > db.list

The listing file consists of a header and one line for each item, for example,

; Archive created at Mon Sep 14 13:55:39 2019
;     dbname: DBDEMOS
;     TOC Entries: 81
;     Compression: 9
;     Dump Version: 1.10-0
;     Format: CUSTOM
;     Integer: 4 bytes
;     Offset: 8 bytes
;     Dumped from database version: 9.4.24
;     Dumped by pg_dump version: 9.4.24
;
; Selected TOC Entries:
;
3; 2615 2200 SCHEMA - public pasha
1861; 0 0 COMMENT - SCHEMA public pasha
1862; 0 0 ACL - public pasha
317; 1247 17715 TYPE public composite pasha
319; 1247 25899 DOMAIN public domain0 pasha2

Semicolons start a comment, and the numbers at the start of lines refer to the internal archive ID assigned to each item. You can comment out, delete, and reorder lines in the file. For example:

10; 145433 TABLE map_resolutions postgres
;2; 145344 TABLE species postgres
;4; 145359 TABLE nt_header postgres
6; 145402 TABLE species_records postgres
;8; 145416 TABLE ss_old postgres

You can use this file as input to pg_restore, to restore only items 10 and 6, in that order:

pg_restore -L db.list db.dump

See Also

pg_dump, pg_dumpall, psql