pg_restore是一个用来从pg_dump 创建的非文本格式归档恢复PostgreSQL数据库的工具。 它将发出必要的命令把该数据库重建成它被保存时的状态。这些归档文件还允许 pg_restore选择恢复哪些内容或者在恢复前对恢复项重排序。 这些归档文件被设计为可以在不同的架构之间迁移。
pg_restore可以在两种模式下操作。如果指定了一个数据库 名称,pg_restore会连接那个数据库并且把归档内容直接恢 复到该数据库中。否则,会创建一个脚本,其中包含着重建该数据库所必要的 SQL 命令, 它会被写入到一个文件或者标准输出。这个脚本输出等效于 pg_dump的纯文本输出格式。因此,一些控制输出的选项与 pg_dump的选项类似。
显然,pg_restore无法恢复不在归档文件中的信息。例如, 如果归档使用"以INSERT命令转储数据"选项 创建, pg_restore将无法使用COPY 语句装载数据。
pg_restore接受下列命令行参数。
指定要被恢复的归档文件(对于一个目录格式的归档则是目录)的位置。如果没有指定, 则使用标准输入。
只恢复数据,不恢复模式(数据定义)。如果在归档中存在,表数据、大对象和序列值 会被恢复。
这个选项类似于指定--section=data,但是由于历史原因两者不完全相同。
在重新创建数据库对象之前清除(丢弃)它们(除非使用了--if-exists, 如果有对象在目标数据库中不存在,这可能会生成一些无害的错误消息)。
在恢复一个数据库之前县创建它。如果还指定了--clean,在连接到 目标数据库之前丢弃并且重建它。
在使用这个选项时,-d提到的数据库只被用于发出初始的 DROP DATABASE和CREATE DATABASE命令。所有 要恢复到该数据库名中的数据都出现在归档中。
连接到数据库dbname并且 直接恢复到该数据库中。
在发送 SQL 命令到该数据库期间如果碰到一个错误就退出。默认行为是继续并且在恢复 结束时显示一个错误计数。
为生成的脚本或列表(当使用-l时)指定输出文件。默认是标准输出。
指定归档的格式。并不一定要指定该格式,因为pg_restore 将会自动决定格式。如果指定,可以是下列之一:
归档是pg_dump的自定义格式。
归档是一个目录归档。
归档是一个tar归档。
一个废弃的选项,现在已被忽略。
只恢复提及的索引的定义。可以通过写多个-I开关指定多个索引。
使用并发任务运行pg_restore中最耗时的部分 — 载入数据、创建索引或者创建约束。对于一个运行在多处理器机器上的服务器, 这个选项能够大幅度减少恢复一个大型数据库的时间。
每一个任务是一个进程或者一个线程,这取决于操作系统,它们都使用一个独立 的服务器连接。
这个选项的最佳值取决于服务器、客户端以及网络的硬件设置。因素包括 CPU 的 核心数和磁盘设置。一个好的建议是服务器上 CPU 的核心数,但是更大的值在很 多情况下也能导致更快的恢复时间。当然,过高的值会由于超负荷反而导致性能 降低。
这个选项只支持自定义和目录归档格式。输入必须是一个常规文件或目录(例如, 不能是一个管道)。当发出一个脚本而不是直接连接到数据库服务器时会忽略这个 选项。还有,多任务不能和选项--single-transaction一起用。
列出归档的内容。这个操作的输出能被用作-L选项的输入。 注意如果把-n或-t这样的过滤开关与 -l一起使用,它们将会限制列出的项。
只恢复在list-file中列出 的归档元素,并且按照它们出现在该文件中的顺序进行恢复。注意如果把 -n或-t这样的过滤开关与-L一起使 用,它们将会进一步限制要恢复的项。
list-file通常是编辑一个 -l操作的输出来创建。行可以被移动或者移除,并且也可以通过 在行首放一个(;)将其注释掉。例子见下文。
只恢复在被提及的模式中的对象。可以用多个-n开关来指定多个 模式。这可以与-t选项组合在一起只恢复一个指定的表。
不要输出将对象的所有权设置为与原始数据库匹配的命令。默认情况下, pg_restore会发出 ALTER OWNER或者 SET SESSION AUTHORIZATION语句来 设置已创建的模式对象的所有权。除非到该数据库的初始连接是一个超级 用户(或者拥有脚本中所有对象的同一个用户)建立的,这些语句将会 失败。通过-O,任何用户名都可以被用于初始连接, 并且这个用户将会拥有所有被创建的对象。
只恢复被提及的函数。要小心地拼写函数的名称和参数使它们正好就是出现 在转储文件的内容表中的名称和参数。可以使用多个-P开关 指定多个函数。
这个选项已被废弃,但是出于向后兼容性的目的,系统仍然还接受它。
只恢复归档中的模式(数据定义)不恢复数据。
这个选项是--data-only的逆选项。它与指定 --section=pre-data --section=post-data相似,但是 由于历史原因并不完全相同。
(不要把这个选项和--schema选项弄混,后者把词 "schema"用于一种不同的含义)。
指定在禁用触发器时要用的超级用户名。只有使用 --disable-triggers时这个选项才相关。
只恢复所提及表的定义或数据。可以用多个-t开关指定多个表。 这个选项可以和-n选项组合来指定一个模式。
只恢复所提及的触发器。可以用多个-T开关指定多个触发器。
指定冗长模式。
打印该pg_restore的版本并退出。
阻止恢复访问特权(授予/收回命令)。
将恢复作为单一事务执行(即把发出的命令包裹在 BEGIN/COMMIT中)。这可以确保要么 所有命令完全成功,要么任何改变都不被应用。这个选项隐含了 --exit-on-error。
只有在执行一个只恢复数据的恢复时,这个选项才相关。它指示 pg_restore在装载数据时执行命 令临时禁用目标表上的触发器。如果你在表上有参照完整性检查 或者其他触发器并且你不希望在数据载入期间调用它们时,请使 用这个选项。
目前,为--disable-triggers发出的命令必须以超 级用户身份完成。因此你还应该用-S指定一个超级 用户名,或者更好的方法是以一个PostgreSQL 超级用户运行pg_restore。
在清理数据库对象时使用条件命令(即增加一个 IF EXISTS子句)。只有指定了 --clean时,这个选项才有效。
默认情况下,即便表的创建命令失败(例如因为表已经存在), 表数据也会被恢复。通过这个选项,对这类表的数据会被跳过。 如果目标数据库已经包含了想要的表内容,这种行为又很有有用。 例如,PostgreSQL扩展(如PostGIS) 的辅助表可能已经被载入到目标数据库中,指定这个选项就能阻止 把重复的或者废弃的数据载入到这些表中。
只有当直接恢复到一个数据库中时这个选项才有效,在产生 SQL 脚本输出时这个选项不会产生效果。
不要输出恢复安全标签的命令,即使归档中包含安全标签。
不输出命令选择表空间。通过这个选项,所有的对象都会被创建 在恢复时的默认表空间中。
只恢复提及的小节。小节的名称可以是pre-data、 data或者post-data。可以把这个选项指定 多次来选择多个小节。默认值是恢复所有小节。
数据小节包含实际的表数据以及大对象定义。Post-data 项由索引定义、 触发器、规则和除已验证的检查约束之外的约束构成。Pre-data 项由所有 其他数据定义项构成。
输出 SQL 标准的SET SESSION AUTHORIZATION命令取代 ALTER OWNER命令来决定对象拥有权。这会让转储更加兼容 标准,但是依赖于转储中对象的历史,可能无法正确恢复。
显示有关pg_restore命令行参数的帮助,并且退出。
pg_restore也接受下列用于连接参数的命令行参数:
指定服务器正在运行的机器的主机名。如果该值开始于一个斜线,它被用作一个 Unix 域套接字的目录。默认是从PGHOST环境变量中取得( 如果被设置),否则将尝试一次 Unix 域套接字连接。
指定服务器正在监听连接的 TCP 端口或本地 Unix 域套接字文件扩展名。默认是放在 PGPORT环境变量中(如果被设置),否则使用编译在程序中的默认值。
要作为哪个用户连接。
不发出一个口令提示。如果服务器要求口令认证并且没有其他方式提供 口令(例如一个.pgpass文件), 那么连接尝试将失败。这个选项对于批处理任务和脚本有用, 因为在其中没有一个用户来输入口令。
强制pg_restore在连接到一个数据库之前 提示要求一个口令。
这个选项不是必须的,因为如果服务器要求口令认证, pg_restore将自动提示要求一个口令。 但是,pg_restore将浪费一次 连接尝试来发现服务器想要一个口令。在某些情况下,值得键入 -W来避免额外的连接尝试。
指定一个用来创建该转储的角色名。这个选项导致pg_restore 在连接到数据库后发出一个 SET ROLE rolename命令。 当已认证用户(由-U指定)缺少pg_restore 所需的特权但是能够切换到一个具有所需权利的角色时,这个选项很有用。 一些安装有针对直接作为超级用户登录的策略,使用这个选项可以让转储在 不违反该策略的前提下完成。
当使用-d选项指定一个直接数据库连接时, pg_restore在内部执行 SELECT语句。如果你运行 pg_restore时出现问题,确定你能够从正 在使用的数据库中选择信息,例如psql。此外, libpq前端-后端库所使用的任何默认连接 设置和环境变量都将适用。
如果你的数据库集簇对于template1数据库有任何本地添加, 要注意将pg_restore 的输出载入到一个真正的空数据库。否则你很可能由于以增加 对象的重复定义而得到错误。要创建一个不带任何本地添加的空数据库, 从template0而不是template1复制它,例如:
CREATE DATABASE foo WITH TEMPLATE template0;
下面将详细介绍pg_restore的局限性。
在恢复数据到一个已经存在的表中并且使用了选项 --disable-triggers时,pg_restore 会在插入数据之前发出命令禁用用户表上的触发器,然后在完成数据插入后重新启用 它们。如果恢复在中途停止,可能会让系统目录处于错误的状态。
pg_restore不能有选择地恢复大对象,例如 只恢复特定表的大对象。如果一个归档包含大对象,那么所有的大对象都会被恢复, 如果通过-L、-t或者其他选项进行了排除, 它们一个也不会被恢复。
pg_dump的局限性详见pg_dump 文档。
一旦完成恢复,应该在每一个被恢复的表上运行ANALYZE,这样 优化器能得到有用的统计信息。更多信息请见Section 23.1.3 和Section 23.1.6。
假设我们已经以自定义格式转储了一个叫做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 Mon Sep 14 13:55:39 2009 ; dbname: DBDEMOS ; TOC Entries: 81 ; Compression: 9 ; Dump Version: 1.10-0 ; Format: CUSTOM ; Integer: 4 bytes ; Offset: 8 bytes ; Dumped from database version: 8.3.5 ; Dumped by pg_dump version: 8.3.8 ; ; ; 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 pasha
分号表示开始一段注释,行首的数字表明了分配给每个项的内部归档 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,并且先恢复 10 再恢复 6。
$ pg_restore -L db.list db.dump