PHP实战中知识总结 / PgSQL - pg_dump（bin目录文件）
一、pg_dump
pg_dump可以将表结构及数据以SQL语句的形式导出到文件中，恢复数据时，将导出的文件作为输入，执行其中的SQL语句，即可恢复数据。
pg_dump不阻塞其他用户访问数据库（读取或写入）。
pg_dump只转储单个数据库。要备份一个集簇或者集簇中 对于所有数据库公共的全局对象（例如角色和表空间），应使用pg_dumpall。
转储可以被输出到脚本或归档文件格式。脚本转储是包含 SQL 命令的纯文本文件，可以通过psql进行调用执行以达到数据恢复的效果；归档文件格式必须与pg_restore配合使用来重建数据库。它们允许pg_restore能选择恢复什么，或者甚至在恢复之前对条目重排序。归档文件格式被设计为在架构之间可移植。
二、命令格式
pg_dump [OPTION]... [DBNAME]
1、General options：
| 参数 | 说明 |
|---|---|
| -f, --file=FILENAME | 指定导出到指定文件的文件名 |
| -F, --format=c/d/t/p | 指定导出格式 |
| p / plan | 一个纯文本形式的SQL脚本文件（默认值） |
| c / custom | 输出一个适合于作为pg_restore输入的自定义格式归档。和目录输出格式一起，这是最灵活的输出格式，它允许在恢复时手动选择和排序已归档的项。这种格式在默认情况还会被压缩。 |
| d / directory | 输出一个适合作为pg_restore输入的目录格式归档。这将创建一个目录，其中每个被转储的表和大对象都有一个文件，外加一个目录文件，该文件以一种pg_restore能读取的机器可读格式描述被转储的对象。 |
| t / tar | 输出一个适合于输入到pg_restore中的tar-格式归档。tar 格式可以兼容目录格式，抽取一个 tar 格式的归档会产生一个合法的目录格式归档。不过，tar 格式不支持压缩。还有，在使用 tar 格式时，表数据项的相对顺序不能在恢复过程中被更改 |
| -j, --jobs=NUM | 执行多个并行任务来执行备份转存工作，需确保你的max_connections设置足够高以容纳所有的连接。只能和目录输出格式一起使用这个选项，因为这是唯一一种让多个进程能在同一时间写其数据的输出格式。 |
| -v, --verbose | 指定详情模式，pg_dump向标准错误输出详细的对象注释以及转储文件的开始/停止时间，还有进度消息 |
| -V, --version | 打印版本 |
| -Z, --compress=0-9 | 指定要使用的压缩级别。零意味着不压缩。对于自定义归档格式，这会指定个体表数据段的压缩，并且默认是进行中等级别的压缩。对于纯文本输出，设置一个非零压缩级别会导致整个输出文件被压缩，就好像它被gzip处理过一样，但是默认是不压缩。tar 归档格式当前完全不支持压缩 |
| --lock-wait-timeout=TIMEOUT | 在转储的开始从不等待共享表锁的获得。而是在指定的timeout内不能锁定一个表时失败。超时时长可以用SET statement_timeout接受的任何格式指定 |
| --no-sync | 默认情况下，pg_dump将等待所有文件被安全地写入磁盘。这个选项会让pg_dump不等待直接返回，这样会更快，但是也意味着后续的一次操作系统崩溃会让该转储损坏。通常这个选项对测试有用，但是不应该在从生产安装中转储数据时使用 |
| -?, --help | 显示帮助信息并退出 |
2、Options controlling the output content：
| 参数 | 说明 |
|---|---|
| -a, --data-only | 只转储数据，而不转储模式（数据定义）。表数据、大对象和序列值都会被转储 |
| -b, --blobs | 在转储中包括大对象。这是当--schema、--table或--schema-only被指定时的默认行为 |
| -B, --no-blobs | 在转储中排除大对象。当-b和-B同时指定时，默认是 -b 导出大对象 |
| -c, --clean | 此选项针对纯文本，指定输出的脚本中是否生成清理该数据库对象的语句 |
| -C, --create | 此选项针对纯文本。指定脚本中是否输出一条 create database 语句和连接到该数据库的语句。一般在备份的源数据库与恢复的目标数据库名称一致时，才指定这个参数。如果也指定了--clean，脚本会在重新连接到目标数据库之前先删除它然后再重建 |
| -E, --encoding=ENCODING | 以指定的字符集编码创建转储。在默认情况下，该转储会以该数据库的编码创建 |
| -n, --schema=PATTERN | 只转储匹配schema的模式内容，包括模式本身以及其中包含的对象。如果没有声明这个选项，所有目标数据库中的非系统模式都会被转储出来。可以使用多个 -n 选项指定多个模式转储 |
| -N, --exclude-schema=PATTERN | 不转储匹配pattern模式的任何模式。-N可以被给定多次来排除匹配几个模式中任意一个的模式。 |
| -O, --no-owner | 此参数针对纯文本格式。表示不把转储的对象的所有权设置为对应源数据库中的owner。pg_dump 默认发出 ALTER OWNER 或 SET SESSION AUTHORAZATION 语句来设置创建的数据库对象的所有者。如果这些脚本将来没有被超级用户（或拥有脚本中全部对象的用户）运行，会导致恢复失败， -O 选项就是为了让该脚本可以被任何用户使用。 |
| -s, --schema-only | 只转储对象定义（模式），而非数据。此选项用于备份表结构 |
| -S, --superuser=NAME | 此参数指定关闭触发器时需要用到的超级用户名。它只在使用了 --disable-triggers 时才有作用。 |
| -t, --table=PATTERN | 只转储名字匹配pattern的表。通过写多个-t开关可以选择多个表。当-t选项被使用时，-n和-N选项不会有效果。 |
| -T, --exclude-table=PATTERN | 不转储匹配pattern模式的任何表。-T可以被给定多次来排除匹配几个模式中任意一个的模式。当-t和-T都被给定时，该行为是只转储匹配至少一个-t开关但是不匹配-T开关的表。如果只有-T而没有-t，那么匹配-T的表会被从一个正常转储中排除。 |
| -x, --no-privileges | 禁止转储访问权限（grant、revoke 命令）。 |
| --binary-upgrade | 这个选项仅用于升级功能。 |
| --column-inserts | 该选项为表数据每一行生成具有列名的INSERT命令，当数据库恢复时遇到一行错误时，它只会导致错误的这一行数据丢失，而不是全部数据。 |
| --disable-dollar-quoting | 这个选项禁止在函数体中使用美元符号引用，并且强制它们使用 SQL 标准字符串语法被引用 |
| --disable-triggers | 此选项针对纯文本格式。它告诉 pg_dump 在恢复数据时，临时关闭目标表上触发器的命令。如果表上有参照完整性检查或其他触发器，且恢复数据时不需要重载它们，就使用此选项。为 --disable-trigger 发出的命令必须作为超级用户执行。因此，还应该使用-S指定超级用户名 |
| --enable-row-security | 只有在转储具有行安全性的表的内容时，这个选项才相关。默认情况下，pg_dump将把row_security设置为 off 来确保从该表中转储 出所有的数据。如果用户不具有足够能绕过行安全性的特权，那么会抛出 一个错误这个参数指示pg_dump将row_security设置为 on，允许用户只转储该表中 它们能够访问到的部分内容。 |
| --exclude-table-data=PATTERN | 此选项表示不转储匹配table模式的任何表中的数据。–exclude-table-data可以被给定多次来排除匹配多个模式的表。应用于当你需要一个特定表的定义但不想要其中的数据时 |
| --extra-float-digits=NUM | 在转储浮点数据时使用规定的extra_float_digits值，而不是最大可用精度 |
| --if-exists | 只有同时指定了--clean时，这个选项才可用，增加一个IF EXISTS子句 |
| --include-foreign-data=PATTERN | 包含外部服务器上与模式匹配的外部表的数据。可以通过编写 多个--include-foreign-data开关来选择多个外部服务器 |
| --inserts | 将数据转储为INSERT命令（而不是COPY）。重新加载期间的任何错误都将导致有问题的INSERT相关的行将丢失，而不是整个表内容。与--column-inserts的区别是--column-inserts导出时，insert语句携带了列名，而--inserts参数导出时，insert不带列名。 |
| --load-via-partition-root | 在为一个分区表转储数据时，让COPY语句或者INSERT语句将根表作为目标，在数据被装载时，会为每一个行重新确定合适的分区 |
| --no-comments | 不转储注释 |
| --no-publications | 不转储publication。 |
| --no-security-labels | 不转储安全标签 |
| --no-subscriptions | 不转储订阅 |
| --no-synchronized-snapshots | 这个选项允许对 9.2 以前的服务器运行pg_dump -j，详见-j参数的文档 |
| --no-tablespaces | 不转存表空间，通过这个选项，在恢复期间所有的对象都会被创建在任何作为默认的表空间中。这个选项只对纯文本格式有意义。对于归档格式，你可以在调用pg_restore时指定该选项 |
| --no-unlogged-table-data | 不转储未标记的表数据 |
| --on-conflict-do-nothing | 增加ON CONFLICT DO NOTHING到INSERTcommands。 除非规定了--inserts,--column-inserts或--rows-per-insert，否则此选项是无效的 |
| --quote-all-identifiers | 强制引用所有标识符，默认情况下，pg_dump只对在其主版本中是被保留词的标识符加上引号。在转储其他版本服务器时，这种默认行为有时会导致兼容性问题，因为那些版本可能具有些许不同的被保留词集合。使用--quote-all-identifiers能阻止这种问题，但代价是转储脚本更难阅读 |
| --rows-per-insert=NROWS | 数据转储为INSERT命令（而不是COPY）。 控制每个INSERT命令的最大行数。 指定的值必须大于零。重新加载期间的任何错误都将导致有问题的INSERT相关的行将丢失，而不是整个表内容。 |
| --section=SECTION | 转储命名节（预数据、数据或后数据） |
| --serializable-deferrable | 为转储使用一个可序列化事务，以保证所使用的快照与后来的数据库状态是一致的。但是这样做是在事务流中等待一个点，在该点上不能存在异常，这样就不会有转储失败或者导致其他事务带着serialization_failure回滚的风险 |
| --snapshot=SNAPSHOT | 在做一个数据库的转储时指定一个同步的快照`` |
| --strict-names | 要求每一个模式（-n/--schema）和表（-t/--table）限定符匹配要转储的数据库中至少一个模式/表。这个选项对-N/--exclude-schema、-T/--exclude-table或者--exclude-table-data没有效果。无法匹配任何对象的排除模式不会被当作错误。 |
| --use-set-session-authorization | 输出 SQL-标准的SET SESSION AUTHORIZATION命令取代ALTER OWNER命令来确定对象的所有关系。这让该转储更加兼容标准，但是取决于该转储中对象的历史，该转储可能无法正常恢复。而且，一个使用SET SESSION AUTHORIZATION的转储将一定会要求超级用户特权来正确地恢复，而ALTER OWNER要求更少的特权 |
3、Connection options
| 参数 | 说明 |
|---|---|
| -d, --dbname=DBNAME | 指定要转储的数据库 |
| -h, --host=HOSTNAME | 指定运行服务器的机器的主机名 |
| -p, --port=PORT | 指定端口 |
| -U, --username=NAME | 指定用户 |
| -w, --no-password | 不提示输入密码 |
| -W, --password | 强制密码提示 |
| --role=ROLENAME | 指定一个用来创建该转储的角色名。这个选项导致pg_dump在连接到数据库后发出一个SET ROLE*rolename*命令 |
| 命令 | 解释 |
|---|---|
| pg_dump test > test.sql pg_dump test -f test_db.sql pg_dump -d test -f test_db.sql | 将test数据库转储到test.sql文件 |
| pg_dump -t '(al/te)*' -f test.sql | 只转储al开头或者te开头的表 |
| pg_dump -t '(al/te)*' --column-inserts -f test.sql | 将al开头或者te开头的表转储为携带列名的sql文件。默认转储的格式为copy命令 |
| pg_dump -t '(al/te)*' --column-inserts --rows-per-insert=100 -f test.sql | --column-inserts参数将表数据转储为insert语句，默认一行转储为一条insert语句，--rows-per-insert将表数据转储为insert语句，每条insert包含对应数量的数据 |