Question

名称

pg_restore--从 pg_dump 创建的备份文件中恢复数据库

语法

pg_restore [option...] [filename]

描述

pg_restore 用于恢复由 pg_dump 转储的任何非纯文本格式中的 PostgreSQL 数据库。它将发出必要的命令重建数据库，并把它恢复成转储时的样子。归档(备份)文件还允许 pg_restore 有选择地进行恢复，甚至在恢复前重新排列条目的顺序。归档的文件设计成可以在不同的硬件体系之间移植。

pg_restore 可以按照两种模式操作。如果声明了数据库名字，那么归档是直接恢复到数据库里。否则，先创建一个包含重建数据库所必须的 SQL 命令的脚本，并且写入到一个文件或者标准输出。等效于 pg_dump 输出纯文本格式的时候创建的那种脚本。因此，一些控制输出的选项就是模拟 pg_dump 的选项设置的。

显然，pg_restore 无法恢复那些不存在归档文件中的信息；比如，如果归档是用"把数据转储为 INSERT 命令"选项制作的，那么 pg_restore 将不能使用 COPY 语句加载数据。

选项

pg_restore 接受下列命令行参数：

filename

要恢复的备份文件的位置。如果没有声明，则使用标准输入。

-a
--data-only

只恢复数据，而不恢复表模式(数据定义)

-c
--clean

创建数据库对象前先清理(删除)它们

-C
--create

在恢复数据库之前先创建它。如果出现了这个选项，和 -d 在一起的数据库名只是用于发出最初的 CREATE DATABASE 命令。所有数据都恢复到名字出现在归档中的数据库中去。

-d dbname
--dbname=dbname

与数据库 dbname 连接并且直接恢复到该数据库中。

-e
--exit-on-error

如果在向数据库发送 SQL 命令的时候碰到错误，则退出。缺省是继续执行并且在恢复结束时显示一个错误计数。

-f filename
--file=filename

指定生成的脚本的输出文件，或者出现 -l 选项时用于列表的文件，缺省是标准输出。

-F format
--format=format

指定备份文件的格式。因为 pg_restore 会自动判断格式，所以如果一定要指定的话，它可以是下面之一：

t
tar

备份是一个 tar 归档。使用这个格式允许在恢复数据库的时候重新排序和/或把表模式元素排除出去。同时还可能在恢复的时候限制加载的数据。

c
custom

备份的格式是来自 pg_dump 的自定义格式。这是最灵活的格式，因为它允许重新对数据排序，也允许重载表模式元素。缺省时这个格式是压缩的。

-i
--ignore-version

忽略数据库版本检查

-I index
--index=index

只恢复命名的索引

-l
--list

列出备份的内容。这个操作的输出可以用 -L 选项限制和重排所恢复的项目。

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

以它们在文件中出现的顺序只恢复在 list-file 里面的元素。你可以移动各个行并且也可以通过在行开头放置 ; 的方式注释。例子见下文。

-n namespace
--schema=schema

只恢复指定名字的模式里面的定义和/或数据。这个选项可以和 -t 选项一起使用，实现只转储一个表的数据。

-O
--no-owner

不要输出设置与最初数据库对象权限匹配的命令。缺省时，pg_restore 发出 ALTER OWNER 或 SET SESSION AUTHORIZATION 语句设置创建出来的模式元素的所有者权限。如果最初的数据库连接不是由超级用户(或者是拥有所有创建出来的对象的同一个用户)发起的，那么这些语句将失败。如果使用 -O ，那么任何用户都可以用于初始的连接，并且这个用户将拥有所有创建出来的对象。

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

只恢复指定的命名函数。请注意仔细拼写函数名及其参数，应该和转储的内容列表中的完全一样。

-R
--no-reconnect

这个选项已经废弃了，但是为了保持向下兼容仍然接受。

-s
--schema-only

只恢复表结构(数据定义)。不恢复数据(数据表内容)。序列的当前值也不会得到恢复。请不要和 --schema 选项混淆，那里使用了"模式"(schema)的其它含义。

-S username
--superuser=username

设置关闭触发器时声明超级用户的用户名。只有在设置了 --disable-triggers 的时候才有用。

-t table
--table=table

只恢复指定的表的定义和/或数据。

-T trigger
--trigger=trigger

只恢复指定的触发器

-v
--verbose

声明冗余模式

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

禁止恢复访问权限(grant/revoke 命令)

--disable-triggers

这个选项只有在执行仅恢复数据的时候才相关。它告诉 pg_restore 在加载数据的时候执行一些命令临时关闭在目标表上的触发器。如果你在表上有完整性检查或者其它触发器，而你又不希望在加载数据的时候激活它们，那么可以使用这个选项。

目前，为 --disable-triggers 发出的命令必须以超级用户发出。因此，你应该也要用 -S 声明一个超级用户名，或者更好是以超级用户身份运行 pg_restore

--use-set-session-authorization

输出 SQL 标准的 SET SESSION AUTHORIZATION 命令，而不是 ALTER OWNER 命令。这样令转储与标准兼容的更好，但是根据转储中对象的历史，这个转储可能不能恰当地恢复。

--no-data-for-failed-tables

缺省时，即使创建表的命令因为该表已经存在而失败了，表中的数据仍将被恢复。使用这个选项之后，这些表的数据就将跳过恢复操作。当目标数据库可能已经包含所需恢复的某些表的内容时，该选项就很有用处了。比如，用于 PostgreSQL 扩展的辅助表(例如 PostGIS)就可能已经在目标数据库中恢复过了，使用该选项就可以防止多次恢复以致重复或者覆盖了已经恢复的数据。

该选项仅在直接向一个数据库中恢复的时候有效，在生成 SQL 脚本输出时无效。

pg_restore 还接受下面的命令行参数做为连接参数：

-h host
--host=host

指定运行服务器的主机名。如果数值以斜杠开头，则被用作到 Unix 域套接字的路径。缺省从 PGHOST 环境变量中获取(如果设置了的话)，否则，尝试一个 Unix 域套接字连接。

-p port
--port=port

指定服务器正在侦听的 TCP 端口或本地 Unix 域套接字文件的扩展(描述符)。缺省使用 PGPORT 环境变量(如果设置了的话)，否则，编译时的缺省值。

-U username

连接的用户名

-W

强制口令提示。如果服务器需要口令认证，那么这个动作应该自动发生。

-1
--single-transaction

将整个恢复过程作为一个完整的事务来执行，也就是将所有恢复命令放在 BEGIN/COMMIT 之间。这将保证恢复要么全部成功要么没有任何影响。该选项隐含 --exit-on-error

环境变量

PGHOST
PGPORT
PGUSER

缺省连接参数

诊断

当使用 -d 选项声明了直接数据库连接时，pg_restore 在内部执行 SQL 语句。如果你运行 pg_restore 出了毛病，请确保你能用类似 psql 这样的东西从数据库中选取信息。

注意

如果你的安装给 template1 数据库增加了任何你自己的东西，那么请注意把 pg_restore 的输出恢复到一个真正空的数据库中；否则你可能会收到因为重复定义所追加的对象而造成的错误信息。要制作一个没有任何本地附属物的数据库，可以从 template0 而不是 template1 拷贝，比如：

CREATE DATABASE foo WITH TEMPLATE template0;

pg_restore 的局限如下：

• 当向一个已经存在的表恢复数据，并且还使用了 --disable-triggers 选项时，pg_restore 在插入数据前放出一些查询关闭用户表上的触发器，在数据插入完成后重新打开它们。如果恢复的中途停止，那么系统表可能处于错误状态。

• pg_restore 不会为单一的表恢复大对象。如果一个归档包含大对象，那么所有大对象都将被恢复。

参阅 pg_dump 的文挡获取有关 pg_dump 的局限的细节。

一旦完成恢复，最好在每个恢复的对象上运行 ANALYZE ，以便给优化器有用的统计。

例子

假定我们已经转储了 mydb 数据库到一个自定义格式的文件中：

$ pg_dump -Fc mydb > db.dump

删除该数据库并从转储中重建：

$ dropdb mydb
$ pg_restore -C -d postgres db.dump

在 -d 中指定的数据库可以是当前集群中的任意数据库；pg_restore 仅用该名字来为 mydb 发出 CREATE DATABASE 命令。使用 -C 可以确保数据总是会被恢复到转储文件中指定名字的数据库里面。

将转储出来的数据重新加载到一个新建的数据库 newdb 中：

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

注意，这里没有使用 -C 选项，而是直接链接到将要恢复的数据库上。还要注意的是，我们从 template0 而不是 template1 创建了新数据库一确保干净。

要对项目重新排序，首先必须转储归档的目录：

$ pg_restore -l db.dump > db.list

这个文件由一行头和每个条目一行组成，比如。

;
; Archive created at Fri Jul 28 22:28:36 2000
;     dbname: mydb
;     TOC Entries: 74
;     Compression: 0
;     Dump Version: 1.4-0
;     Format: CUSTOM
;
;
; Selected TOC Entries:
;
2; 145344 TABLE species postgres
3; 145344 ACL species
4; 145359 TABLE nt_header postgres
5; 145359 ACL nt_header
6; 145402 TABLE species_records postgres
7; 145402 ACL species_records
8; 145416 TABLE ss_old postgres
9; 145416 ACL ss_old
10; 145433 TABLE map_resolutions postgres
11; 145433 ACL map_resolutions
12; 145443 TABLE hs_old postgres
13; 145443 ACL hs_old

这里分号是注释分隔符，而行开头的数字代表赋给每个项目的内部归档 ID 。

文件内的行可以注释、删除和/或重新排列。比如，

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

可以用做 pg_restore 的输入并且只会恢复项目 10 和 6 (以这个顺序)：

$ pg_restore -L db.list db.dump

历史

pg_restore 工具第一次出现在 PostgreSQL 7.1 中。

又见

pg_dump, pg_dumpall, psql, 环境变量(节29.12)