pg_restore

Name

pg_restore --  从一个由 pg_dump 创建的备份文件中恢复 PostgreSQL 数据库.

Synopsis

pg_restore [options...]

描述

pg_restore 是一种用于恢复由 pg_dump 创建的任何非纯文本输出格式中的 PostgreSQL 数据库的应用. 它将发出重新生成包括数据在内的所有用户定义类型,函数,表,索引,聚积和 操作符的所有必要的命令.

归档(备份)文件包含 pg_restore 用于重建数据库的足够的信息, 而且还允许pg_restore 有选择地进行恢复, 甚至在恢复前重新排列条目的顺序.归档的文件设计成可以在不同的硬件体系 之间移植.

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

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

选项

pg_restore 接受下列命令行参数 (长选项只有在一些平台上可用):

archive-name

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

-a
--data-only

只恢复数据,而不恢复表大纲(定义).

-c
--clean

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

-C
--create

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

-d dbname
--dbname=dbname

与数据库 dbname 联接并且直接恢复到该数据库中.BLOB 只能通过与数据库直接联接才能恢复.

-f filename
--file=filename

声明生成的脚本的输出文件,或者出现-l 选项时用于列表的文件, 缺省是标准输出.

-F format
--format=format

声明备份文件的格式.因为pg_restore 会自动判断格式,所以如果声明了,它可以是下面之一:

t

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

c

备份的格式是来自pg_dump的客户化格式. 这是最灵活的格式,因为 它允许重新对数据排序,也允许重载表大纲元素. 缺省时这个格式是压缩的.

-i
--ignore-version

忽略数据库版本检查。

-I index
--index=index

只为名为 index 恢复定义.

-l
--list

列出备份的内容.这条命令的输出可以用 -L 选项限制和重排 所恢复的项目.

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

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

-N
--orig-order

以最初的转储顺序恢复项目.缺省时 pg_dump会以自己方便的顺序 转储项目,然后把备份保存为 OID 顺序被修改过的形式. 这个选项覆盖了 OID 的排序.

-o
--oid-order

以 OID 顺序恢复项目.缺省时 pg_dump会以自己方便的顺序转储项目, 然后以这个变化了的 OID 顺序保存备份.这个选项强制严格的 OID 顺序.

-O
--no-owner

防止任何恢复原来对象所有者的企图.对象将由与数据库相联的用户所有.

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

声明一个要恢复的过程或者函数.

-r
--rearrange

以修改了的 OID 顺序恢复项目.缺省时 pg_dump会以自己方便的顺序转储项目, 然后以这个变化了的 OID 顺序保存备份. 大多数对象将以 OID 顺序恢复,但有些东西(比如,规则和索引)会在 过程的最后恢复,而不管它们的 OID 是什么.这个选项是缺省的.

-R
--no-reconnect

在恢复一个归档的过程中,pg_restore 通常必须以不同的用户名重新联接数据库若干次才能 正确设置所创建的对象的权限.如果你不想这么做 (比如,因为需要对每次重新联接进行收工干涉),这个选项就 避免了 pg_restore 发出任何重新联接的请求. (在纯文本模式时的联接请求,如果没有与数据联接,是使用一个 psql \connect 命令进行的.) 不果,这个选项是一个很简单的指令,因为它令 pg_restore 丢失了所有对象所有权信息,除非你使用了 -X use-set-session-authorization 选项.

-s
--schema-only

恢复表结构(定义).不恢复数据,序列值将重置.

-S username
--superuser=username

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

-t table
--table=table

只恢复表 table 的大纲/数据.

-T trigger
--trigger=trigger

只恢复触发器 trigger 的定义.

-v
--verbose

声明冗余模式.

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

避免 ACL 的恢复(grant/revoke 命令).

-X use-set-session-authorization
--use-set-session-authorization

通常,如果恢复一个归档 需要更改当前的数据库用户(比如,设置正确的对象所有权)的时候, 必须与数据库建立一个新的联接,这个时候可能需要收工干涉 (也就是输入口令). 如果你使用 -X use-set-session-authorization选项,那么 pg_restore 则会输出 SET SESSION AUTHORIZATION 命令.这么做效果相同, 但是它要求使用生成的脚本做数据库恢复的用户是数据库超级用户. 这个选项有效地覆盖了 -R 选项.

-X disable-triggers
--disable-triggers

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

目前,为 --disable-triggers 发出的命令必须以超级用户发出。 因此,你应该也要用 -S 声明一个超级用户名,或者更好是设置 --use-set-session-authorization 并且以 PostgreSQL 超级用户身份运行 pg_restore

pg_restore 还接受下面的命令行参数 做为联接参数:

-h host
--host=host

声明服务器运行的机器的主机名. 如果主机名以斜扛开头,那么它被用做 Unix 域套接字的目录.

-p port
--port=port

声明服务器侦听的 TCP/IP 端口 或者本地的 Unix 域套接字文件扩展.缺省的端口是 5432,或者 环境变量 PGPORT 的值(如果设置了的话).

-U username

以给出用户身分联接.

-W

强制给出口令提示.如果服务器要求口令认证,那么这个应该 自动发生.

环境

PGHOST
PGPORT
PGUSER

缺省连接参数。

诊断

Connection to database 'template1' failed.
connectDBStart() -- connect() failed: No such file or directory
        Is the postmaster running locally
        and accepting connections on Unix socket '/tmp/.s.PGSQL.5432'?
pg_restore 无法与在声明的主机和端口上运行的 PostgreSQL 服务器联接. 如果你看到这条信息,确保服务器 在正确的主机和你声明的正确的端口上运行.如果你的节点使用某种认证系统, 确保你已经获取了认证需要的细节.

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

注意

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

CREATE DATABASE foo WITH TEMPLATE = template0;

pg_restore 的局限在下面列出.

又见参阅 pg_dump 的文挡获取有关 pg_dump 的局限的细节.

例子

转储一个数据库∶

$ pg_dump mydb > db.out

重载这个数据库:

$ psql -d database -f db.out

把一个包含BLOB的叫 mydb 的数据库转储到一个 tar文件:

$ pg_dump -Ft -b mydb > db.tar

把这个数据库恢复到现有的叫 newdb 的数据库中 (连同BLOB):

$ pg_restore -d newdb db.tar

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

$ pg_restore -l archive.file > archive.list

这个文件由一行头和每个项目一行组成,比如.

;
; Archive created at Fri Jul 28 22:28:36 2000
;     dbname: birds
;     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 archive.file archive.list

历史

pg_restore 工具第一次出现在 PostgreSQL 7.1.

又见

pg_dump, pg_dumpall, psql, PostgreSQL 管理员手册