pg_dump - 云端在线

程序：

您的姓名

pg_dump - 将 PostgreSQL 数据库提取到脚本文件或其他存档文件中

概要

pg_dump [连接选项...] [选项...] [DBNAME]

商品描述

pg_dump 是用于备份 PostgreSQL 数据库的实用程序。 它进行一致的备份
即使数据库正在同时使用。 pg_dump 不会阻止其他用户
访问数据库（读者或作者）。

pg_dump 只转储单个数据库。 备份所有公用的全局对象
集群中的数据库，例如角色和表空间，使用 pg_dumpall（1）。

转储可以以脚本或存档文件格式输出。 脚本转储是纯文本文件
包含将数据库重建到其所处状态所需的 SQL 命令
它被保存的时间。 要从这样的脚本恢复，请将其提供给 psql的(1). 脚本文件可以
即使在其他机器和其他架构上也可用于重建数据库； 和
一些修改，甚至在其他 SQL 数据库产品上。

替代存档文件格式必须与 pg_恢复(1) 重建
数据库。 它们允许 pg_restore 选择恢复的内容，甚至重新排序
恢复之前的项目。 存档文件格式设计为可移植
跨架构。

当与一种存档文件格式一起使用并与 pg_restore、pg_dump 结合使用时
提供灵活的归档和传输机制。 pg_dump 可用于备份
整个数据库，然后 pg_restore 可用于检查存档和/或选择哪个
部分数据库将被恢复。 最灵活的输出文件格式是
“自定义”格式（-Fc) 和“目录”格式(-FD）。 它们允许选择和
对所有归档项目进行重新排序，支持并行恢复，并通过
默认。 “目录”格式是唯一支持并行转储的格式。

在运行 pg_dump 时，应该检查输出是否有任何警告（打印在标准
错误），尤其是考虑到下面列出的限制。

配置

以下命令行选项控制输出的内容和格式。

DBNAME
指定要转储的数据库的名称。 如果未指定，则
环境变量 PG数据库 用来。 如果未设置，则指定用户名
用于连接。

-a
--仅数据
只转储数据，而不转储模式（数据定义）。 表数据、大对象和
序列值被转储。

此选项类似于，但由于历史原因不完全相同，指定
--section=数据.

-b
--blob
在转储中包含大对象。 这是默认行为，除非 --模式,
- 桌子或 --仅模式 被指定，所以 -b 开关仅用于添加大
对象选择性转储。

-c
- 干净的
在输出命令之前清除（删除）数据库对象的输出命令
创建它们。 （除非 --如果存在 也指定了，restore 可能会产生一些
无害的错误消息，如果目标数据库中不存在任何对象。）

此选项仅对纯文本格式有意义。 对于存档格式，您
可以在调用时指定选项 pg_恢复.

-C
- 创建
使用命令开始输出以创建数据库本身并重新连接到
创建的数据库。 （使用这种形式的脚本，在哪个数据库中无关紧要
在运行脚本之前连接到的目标安装。）如果 - 干净的 也是
指定，脚本在重新连接到目标数据库之前删除并重新创建目标数据库
它。

此选项仅对纯文本格式有意义。 对于存档格式，您
可以在调用时指定选项 pg_恢复.

-E 编码
--编码=编码
以指定的字符集编码创建转储。 默认情况下，转储是
在数据库编码中创建。 （获得相同结果的另一种方法是设置
PG客户端编码 环境变量到所需的转储编码。）

-f 文件
--文件=文件
将输出发送到指定的文件。 对于基于文件的输出，可以省略此参数
格式，在这种情况下使用标准输出。 必须为目录提供
然而，输出格式，它指定目标目录而不是文件。 在
在这种情况下，目录是由 pg_dump 并且之前一定不存在。

-F 格式
--格式=格式
选择输出的格式。 格式 可以是以下之一：

p
平原
输出一个纯文本的 SQL 脚本文件（默认）。

c
习俗
输出适合输入到 pg_restore 的自定义格式存档。 和...一起
目录输出格式，这是最灵活的输出格式，因为它
允许在恢复期间手动选择和重新排序归档项目。 这个
格式也默认压缩。

d
目录
输出适合输入到 pg_restore 的目录格式存档。 这会
为要转储的每个表和 blob 创建一个包含一个文件的目录，以及一个
描述转储对象的所谓目录文件
pg_restore 可以读取的机器可读格式。 目录格式存档可以
使用标准的 Unix 工具进行操作； 例如，未压缩的文件
可以使用 gzip 工具压缩存档。 此格式默认压缩
并且还支持并行转储。

t
焦油
输出一个 焦油-format 适合输入到 pg_restore 的存档。 tar 格式是
与目录格式兼容：提取 tar 格式的存档会产生一个
有效的目录格式存档。 但是，tar 格式不支持
压缩。 此外，当使用 tar 格式时，表数据项的相对顺序
恢复期间不能更改。

-j 工作
--工作=工作
通过转储并行运行转储 工作 表同时。 此选项减少
转储的时间，但它也增加了数据库服务器上的负载。 你可以
仅将此选项与目录输出格式一起使用，因为这是唯一的输出
多个进程可以同时写入数据的格式。

pg_dump 将打开 工作 + 1 个与数据库的连接，因此请确保您的
max_connections 设置足够高以容纳所有连接。

在运行并行转储时请求对数据库对象的排他锁可能
导致转储失败。 原因是 pg_dump master 进程请求共享
锁定工作进程稍后要转储的对象，以便
确保在转储运行时没有人删除它们并使它们消失。
如果另一个客户端随后请求一个表的排他锁，该锁将不会被
授予但将排队等待主进程的共享锁
释放。 因此，也不会授予对该表的任何其他访问权限，并且
将在排他锁请求之后排队。 这包括工作进程尝试
转储桌子。 如果没有任何预防措施，这将是典型的死锁情况。
为了检测这个冲突，pg_dump 工作进程使用另一个共享锁请求
NOWAIT 选项。 如果工作进程没有被授予这个共享锁，有人
else 必须在此期间请求了排他锁并且没有办法
继续转储，所以 pg_dump 除了中止转储别无选择。

为了一致备份，数据库服务器需要支持同步快照，
PostgreSQL 9.2 中引入的一项功能。 有了这个特性，数据库客户端
即使他们使用不同的连接，也可以确保他们看到相同的数据集。
pg_dump -j 使用多个数据库连接； 它连接到数据库一次
主进程，并再次为每个工人工作。 没有同步
快照功能，不能保证不同的工人作业看到相同的
每个连接中的数据，这可能导致备份不一致。

如果要运行 9.2 之前的服务器的并行转储，则需要确保
数据库内容在 master 连接到
直到最后一个工作作业连接到数据库。 最简单的方法
这样做是为了停止访问数据库的任何数据修改过程（DDL 和 DML）
在开始备份之前。 您还需要指定 --无同步快照
运行时的参数 pg_dump -j 针对 9.2 之前的 PostgreSQL 服务器。

-n 架构
--模式=架构
仅转储模式匹配 架构; 这将选择模式本身及其所有
包含的对象。 未指定此选项时，所有非系统模式在
目标数据库将被转储。 可以通过编写多个来选择多个模式
-n 开关。 此外，该 架构 参数被解释为一个模式，根据
与 psql 的 \d 命令使用的规则相同（请参阅模式），因此也可以使用多个模式
通过在模式中写入通配符来选择。 使用通配符时，
如果需要，请小心引用模式以防止外壳扩展
通配符； 参见示例。

备注
什么时候 -n 指定，pg_dump 不尝试转储任何其他数据库对象
选择的模式可能依赖。 因此，无法保证
特定模式转储的结果可以通过以下方式成功恢复
自己进入一个干净的数据库。

备注
非模式对象（如 blob）在以下情况下不会转储 -n 被指定。 你可以加
blob 带回转储 --blob 开关。

-N 架构
--排除模式=架构
不要转储任何与 架构 图案。 模式被解释
根据相同的规则 -n. -N 可以多次给出排除
匹配几种模式中的任何一种的模式。

当两个 -n 和 -N 给出，行为是只转储匹配的模式
至少有一个 -n 切换但没有 -N 开关。 如果 -N 没有出现 -n，然后模式
匹配 -N 被排除在正常转储之外。

-o
--oids
转储对象标识符 (OID) 作为每个表的数据的一部分。 使用此选项，如果
您的应用程序以某种方式引用了 OID 列（例如，在外键中
约束）。 否则，不应使用此选项。

-O
--无所有者
不要输出命令来设置对象的所有权以匹配原始数据库。 经过
默认，pg_dump 问题 改变 业主 or 设置 SESSION 授权 要设置的语句
创建的数据库对象的所有权。 当脚本运行时，这些语句将失败
除非它由超级用户（或拥有所有对象的同一用户）启动
在脚本中）。 制作一个任何用户都可以恢复的脚本，但会给
所有对象的用户所有权，指定 -O.

此选项仅对纯文本格式有意义。 对于存档格式，您
可以在调用时指定选项 pg_恢复.

-R
--无重新连接
此选项已过时，但仍被接受以实现向后兼容性。

-s
--仅模式
仅转储对象定义（架构），而不转储数据。

此选项与 --仅数据. 它类似于，但对于历史
原因不相同，指定 --section=预数据 --section=后数据.

（不要将此与 --模式 选项，它在一个
不同的意思。）

要仅排除数据库中一部分表的表数据，请参阅
--排除表数据.

-S 用户名
--超级用户=用户名
指定禁用触发器时要使用的超级用户名。 这只是相关的
if --禁用触发器 用来。 （通常，最好将其排除在外，取而代之的是
以超级用户身份启动生成的脚本。）

-t 表
--表=表
仅转储匹配的表（或视图或序列或外部表） 表。 多
可以通过写入多个表来选择表 -t 开关。 此外，该 表 参数是
根据 psql 的 \d 命令使用的相同规则解释为模式（参见
模式），因此也可以通过在其中写入通配符来选择多个表
图案。 使用通配符时，如果需要，请小心引用模式
防止外壳扩展通配符； 参见示例。

这款 -n 和 -N 开关在以下情况下无效 -t 被使用，因为表被选择 -t
无论这些开关如何，都将被转储，并且不会转储非表对象。

备注
什么时候 -t 指定，pg_dump 不尝试转储任何其他数据库对象
选定的表可能依赖。 因此，无法保证
特定表转储的结果可以通过以下方式成功恢复
自己进入一个干净的数据库。

备注
的行为 -t switch 并不完全向上兼容 8.2 之前的版本
PostgreSQL 版本。 以前，写 -t tab 会转储所有名为 tab 的表，但是
现在它只是转储默认搜索路径中可见的任何一个。 为了得到
您可以编写 -t '*.tab' 的旧行为。 另外，你必须写一些像 -t
sch.tab 选择特定模式中的表，而不是旧的位置
-n sch -t 选项卡。

-T 表
--排除表=表
不要转储任何匹配的表 表 图案。 模式被解释
根据相同的规则 -t. -T 可以多次给出排除
匹配多种模式中的任何一种的表。

当两个 -t 和 -T 给出，行为是只转储匹配的表
至少有一个 -t 切换但没有 -T 开关。 如果 -T 没有出现 -t，然后表匹配
-T 被排除在正常转储之外。

-v
--详细
指定详细模式。 这将导致 pg_dump 输出详细的对象注释和
转储文件的开始/停止时间，以及标准错误的进度消息。

-V
- 版
打印 pg_dump 版本并退出。

-x
--无权限
--无acl
防止转储访问权限（授予/撤销命令）。

-Z 0 9 ......
--压缩=0 9 ......
指定要使用的压缩级别。 零意味着没有压缩。 对于定制
归档格式，这指定了单个表数据段的压缩，以及
默认是在中等水平压缩。 对于纯文本输出，设置一个非零
压缩级别导致整个输出文件被压缩，就好像它有
通过 gzip 输入； 但默认是不压缩。 tar 存档格式
目前根本不支持压缩。

--二进制升级
此选项供就地升级实用程序使用。 它用于其他目的是
不推荐或不支持。 该选项的行为可能会在未来版本中发生变化
不知不觉中。

--列插入
--属性插入
转储数据为 插入 具有显式列名的命令 (INSERT INTO 表 (栏,
...) 值 ...)。 这会使恢复非常缓慢； 它主要用于制作
可以加载到非 PostgreSQL 数据库中的转储。 但是，由于这个选项
为每一行生成一个单独的命令，重新加载一行时的错误只会导致
要丢失的那一行而不是整个表的内容。

--禁用美元报价
此选项禁用函数体的美元引用，并强制它们
使用 SQL 标准字符串语法引用。

--禁用触发器
此选项仅在创建仅数据转储时相关。 它指示 pg_dump
包括用于临时禁用目标表上的触发器的命令，同时数据
被重新加载。 如果您有参照完整性检查或其他触发器，请使用此选项
您不想在数据重新加载期间调用的表。

目前，发出的命令为 --禁用触发器 必须以超级用户身份完成。 所以，
您还应该指定一个超级用户名 -S，或者最好小心开始
生成的脚本作为超级用户。

此选项仅对纯文本格式有意义。 对于存档格式，您
可以在调用时指定选项 pg_恢复.

--启用行安全
此选项仅在转储具有行的表的内容时相关
安全。 默认情况下，pg_dump 会将 row_security 设置为 off，以确保所有数据都在
从桌子上倾倒。 如果用户没有足够的权限绕过行
安全，则抛出错误。 该参数指示 pg_dump 设置
row_security 改为 on，允许用户转储部分内容
他们有权访问的表。

--排除表数据=表
不要转储与匹配的任何表的数据 表 图案。 模式被解释
根据相同的规则 -t. --排除表数据 可以给予超过
一次排除匹配几种模式中的任何一种的表。 此选项在以下情况下很有用
即使您不需要其中的数据，您也需要特定表的定义
它。

要排除数据库中所有表的数据，请参阅 --仅模式.

--如果存在
清理数据库时使用条件命令（即添加 IF EXISTS 子句）
对象。 此选项无效，除非 - 干净的 也有规定。

--插入
转储数据为 插入 命令（而不是 COPY）。 这会使恢复非常缓慢；
它主要用于制作可以加载到非 PostgreSQL 数据库中的转储。
但是，由于此选项为每一行生成单独的命令，因此在
重新加载一行只会导致该行丢失，而不是整个表格内容。
请注意，如果您重新排列了列顺序，则恢复可能会完全失败。 这
--列插入 选项对于列顺序更改是安全的，尽管速度更慢。

--锁定等待超时=超时
不要在转储开始时一直等待获取共享表锁。
如果无法锁定指定范围内的表，则失败 超时. 超时可能
以任何接受的格式指定 设置 语句超时. （允许值
取决于您要转储的服务器版本，但整数个
自 7.3 以来，所有版本都接受毫秒。 当这个选项被忽略时
从 7.3 之前的服务器转储。）

--无安全标签
不要倾倒安全标签。

--无同步快照
此选项允许运行 pg_dump -j 针对 9.2 之前的服务器，请参阅文档
的 -j 参数了解更多详情。

--无表空间
不要输出选择表空间的命令。 使用此选项，所有对象都将
在恢复期间默认的表空间中创建。

此选项仅对纯文本格式有意义。 对于存档格式，您
可以在调用时指定选项 pg_恢复.

--无未记录的表数据
不要转储未记录表的内容。 此选项对是否或
不转储表定义（架构）； 它只会抑制倾倒表格
数据。 从备用服务器转储时，未记录表中的数据总是被排除在外。

--引用所有标识符
强制引用所有标识符。 这在转储数据库时可能很有用
迁移到可能引入了其他关键字的未来版本。

--节=部分名称
只转储命名部分。 部分名称可以是 预数据, data或 发布数据.
可以多次指定此选项以选择多个部分。 默认的
是转储所有部分。

数据部分包含实际表数据、大对象内容和序列
值。 后数据项包括索引、触发器、规则和
验证检查约束以外的约束。 预数据项包括所有其他
数据定义项。

--serializable-deferable
对转储使用可序列化的事务，以确保使用的快照是
与后来的数据库状态一致； 但是通过等待一个点来做到这一点
不存在异常的交易流，因此不存在风险
转储失败或导致其他事务回滚
序列化_失败。 请参阅文档中的第 13 章，并发控制
有关事务隔离和并发控制的更多信息。

此选项对于仅用于灾难恢复的转储无益。
对于用于加载数据库副本以进行报告或
其他只读负载分担，同时原始数据库继续更新。
如果没有它，转储可能会反映与任何串行不一致的状态
最终提交的事务的执行。 例如，如果批处理
使用技术，一个批次可能在没有所有项目的转储中显示为关闭
正在出现的批次中。

如果没有读写事务处于活动状态，此选项将没有任何区别
当 pg_dump 启动时。 如果读写事务处于活动状态，则转储的开始
可能会延迟不确定的时间长度。 一旦运行，性能与或
没有开关是一样的。

--快照=快照名称
在进行数据库转储时使用指定的同步快照（请参阅
表 9.71，“快照同步功能”了解更多详细信息）。

当需要将转储与逻辑复制同步时，此选项很有用
slot（参见文档中的第 46 章，逻辑解码）或并发
会议。

在并行转储的情况下，使用此选项定义的快照名称
而不是拍摄新快照。

--use-set-session-授权
输出 SQL 标准 设置 SESSION 授权 命令而不是 改变 业主 命令
确定对象所有权。 这使得转储更符合标准，但是
根据转储中对象的历史记录，可能无法正确恢复。 还，
转储使用 设置 SESSION 授权 肯定需要超级用户权限
正确恢复，而 改变 业主 需要较少的权限。

-?
- 帮帮我
显示有关 pg_dump 命令行参数的帮助，然后退出。

以下命令行选项控制数据库连接参数。

-d DBNAME
--数据库名=DBNAME
指定要连接的数据库的名称。 这相当于指定
DBNAME 作为命令行上的第一个非选项参数。

如果此参数包含 = 符号或以有效的 URI 前缀开头 (postgresql://
或 postgres://)，它被视为 信息 细绳。 见第 31.1 节，“数据库
连接控制功能”，在文档中了解更多信息。

-h 主持人
--主机=主持人
指定运行服务器的机器的主机名。 如果值
以斜杠开头，用作 Unix 域套接字的目录。 这
默认值取自 PG主机 环境变量，如果设置，否则为 Unix 域
尝试套接字连接。

-p 端口
--端口=端口
指定服务器使用的 TCP 端口或本地 Unix 域套接字文件扩展名
正在侦听连接。 默认为 PG端口 环境变量（如果已设置），或
一个编译的默认值。

-U 用户名
--用户名=用户名
要连接的用户名。

-w
--无密码
永远不要发出密码提示。 如果服务器需要密码认证和
密码无法通过其他方式获得，例如 .pgpass 文件、连接
尝试会失败。 此选项在没有用户的批处理作业和脚本中很有用
存在以输入密码。

-W
- 密码
强制 pg_dump 在连接到数据库之前提示输入密码。

这个选项从来都不是必需的，因为 pg_dump 会自动提示输入密码
如果服务器要求密码认证。 但是，pg_dump 会浪费一个
连接尝试发现服务器需要密码。 在某些情况下是
值得打字 -W 以避免额外的连接尝试。

--角色=角色名称
指定用于创建转储的角色名称。 此选项导致 pg_dump
发出 设置 身份 角色名称 连接数据库后的命令。 当
经过身份验证的用户（由 -U) 缺少 pg_dump 所需的权限，但可以
切换到具有所需权限的角色。 一些安装有一个政策反对
直接以超级用户身份登录，并使用此选项允许进行转储
在不违反政策的情况下。

环境

PG数据库
PG主机
选项
PG端口
用户
默认连接参数。

此实用程序与大多数其他 PostgreSQL 实用程序一样，也使用环境变量
libpq 支持（请参阅文档中的第 31.14 节“环境变量”）。

诊断

pg_dump 内部执行 选择 声明。 如果您在运行 pg_dump 时遇到问题，请执行
确保您能够从数据库中选择信息，例如， psql的（1）。
此外，libpq 使用的任何默认连接设置和环境变量
前端库将适用。

pg_dump 的数据库活动通常由统计收集器收集。 如果
这是不可取的，您可以设置参数 曲目数 假通过 选项 或者
更改用户命令。

附注

如果您的数据库集群对 template1 数据库有任何本地添加，请注意
将 pg_dump 的输出恢复到真正空的数据库中； 否则你很可能会得到
由于添加对象的重复定义而导致的错误。 创建一个空数据库
没有任何本地添加，从模板0复制而不是模板1，例如：

使用模板模板 0 创建数据库 foo；

当选择了仅数据转储并且选项 --禁用触发器 被使用，pg_dump 发出
命令在插入数据之前禁用用户表上的触发器，然后命令
在插入数据后重新启用它们。 如果恢复在
中间，系统目录可能处于错误状态。

pg_dump 产生的转储文件不包含优化器使用的统计信息
制定查询计划决策。 因此，运行是明智的 分析 从一个恢复后
转储文件以确保最佳性能； 请参阅第 23.1.3 节，“更新计划程序
统计”，在文档和第 23.1.6 节，“Autovacuum 守护进程”，在
文档以获取更多信息。 转储文件也不包含任何 改变 数据库
... 设置 命令； 这些设置由 pg_dumpall(1)、连同数据库用户
和其他安装范围的设置。

因为 pg_dump 用于将数据传输到较新版本的 PostgreSQL，所以输出
pg_dump 可以加载到比 pg_dump 更新的 PostgreSQL 服务器版本中
版本。 pg_dump 也可以从比它自己的版本旧的 PostgreSQL 服务器转储。
（目前，支持回到 7.0 版的服务器。）但是，pg_dump 不能从
PostgreSQL 服务器比它自己的主要版本更新； 它甚至会拒绝尝试，而是
而不是冒着进行无效转储的风险。 此外，不保证 pg_dump 的输出可以是
加载到旧主要版本的服务器 - 即使转储是从
那个版本的服务器。 将转储文件加载到旧服务器可能需要手动
编辑转储文件以删除旧服务器不理解的语法。

示例

要将名为 mydb 的数据库转储到 SQL 脚本文件中：

$ pg_dump 数据库 > 数据库.sql

要将这样的脚本重新加载到名为 newdb 的（新创建的）数据库中：

$ psql的 -d 新数据库 -f 数据库.sql

要将数据库转储到自定义格式的存档文件中：

$ pg_dump -Fc 数据库 > 转储

要将数据库转储到目录格式的存档中：

$ pg_dump -FD 数据库 -f 转储目录

要将数据库与 5 个工作作业并行转储到目录格式的存档中：

$ pg_dump -FD 数据库 -j 5 -f 转储目录

要将存档文件重新加载到名为 newdb 的（新创建的）数据库中：

$ pg_恢复 -d 新数据库 转储

要转储名为 mytab 的单个表：

$ pg_dump -t 我的表 数据库 > 数据库.sql

转储底特律模式中名称以 emp 开头的所有表，表除外
名为employee_log：

$ pg_dump -t '底特律.emp*' -T 底特律.employee_log 数据库 > 数据库.sql

转储名称以东或西开头并以 gsm 结尾的所有模式，不包括任何
名称包含单词 test 的模式：

$ pg_dump -n '东*gsm' -n '西* gsm' -N '*测试*' 数据库 > 数据库.sql

同样，使用正则表达式表示法来合并开关：

$ pg_dump -n '(东|西)*gsm' -N '*测试*' 数据库 > 数据库.sql

转储除名称以 ts_ 开头的表之外的所有数据库对象：

$ pg_dump -T 'ts_*' 数据库 > 数据库.sql

指定大写或大小写混合的名称 -t 和相关的开关，你需要
双引号名称； 否则它会被折叠成小写（参见模式）。 但是双
引号对于 shell 来说是特殊的，因此它们必须被引用。 因此，要转储单个
具有大小写混合名称的表，您需要类似的东西

$ pg_dump -t "\"MixedCaseName\"" 数据库 > 数据库表

使用 onworks.net 服务在线使用 pg_dump