gs_dumpall

背景信息

gs_dumpall是GaussDB用于导出所有数据库相关信息工具，它可以导出数据库的所有数据，包括默认数据库postgres的数据、自定义数据库的数据、以及所有数据库公共的全局对象。

gs_dumpall工具在进行数据导出时，其他用户可以访问数据库（读或写）。

gs_dumpall工具支持导出完整一致的数据。例如，T1时刻启动gs_dumpall导出整个数据库，那么导出数据结果将会是T1时刻该数据库的数据状态，T1时刻之后对数据库的修改不会被导出。

gs_dumpall时生成列不会被转储。

gs_dump时HTAP表创建IMCV元信息（gs_imcv系统表）不会被转储。

gs_dumpall在导出所有数据库时分为两部分：

• gs_dumpall自身对所有数据库公共的全局对象进行导出，包括有关数据库用户和组，表空间以及属性（例如，适用于数据库整体的访问权限）信息。
• gs_dumpall通过调用gs_dump来完成数据库中各数据库的SQL脚本文件导出，该脚本文件包含将数据库恢复为其保存时的状态所需要的全部SQL语句。

以上两部分导出的结果为纯文本格式的SQL脚本文件，使用gsql运行该脚本文件可以恢复数据库。

gs_dumpall支持SSL加密通信，使用方式同gsql方式。

使用gs_dumpall前请确保gs_dumpall版本与gs_dump版本、数据库版本保持一致，高版本gs_dump、gs_dump不保证完全兼容低版本内核数据。

注意事项

• 禁止修改导出的文件和内容，否则可能无法恢复成功。
• 为了保证数据一致性和完整性，gs_dumpall会对需要转储的表设置共享锁。如果某张表在别的事务中设置了共享锁，gs_dumpall会等待此表的锁释放后锁定此表。如果无法在指定时间内锁定某张表，转储会失败。用户可以通过指定--lock-wait-timeout选项，自定义等待锁超时时间。
• 由于gs_dumpall读取所有数据库中的表，因此必须以数据库管理员身份进行连接，才能导出完整文件。在使用gsql执行脚本文件导入时，同样需要管理员权限，以便添加用户和组，以及创建数据库。导入备份前，验证其安全性，防止管理员权限被利用。
• 使用gs_dumpall导出所有数据库对象，并希望在新的实例环境上进行导入时，需要保证导出和导入时使用用户的名称和权限相同，否则会出现名称不一致或权限不足的报错。
• gs_dumpall导出的文件，在新的实例环境上进行导入时，连接的数据库必须是默认database。否则可能出现语法不兼容的情况，导致导入出错。
• 由于M-compatibility数据库全局只能创建一个，当导出的数据库中包含M-compatibility数据库时，须保证导入的目标实例环境上不存在其他的M-compatibility模式数据库。
• 对于定时任务，本工具仅支持导出在B兼容性数据库中，通过CREATE EVENT创建的定时任务或通过高级包创建的非周期性定时任务。
• gs_dumpall不支持导出自定义Tokenweight分词词典，可以根据报错WARNING: dictionary xx cannot be automatically exported, please create it manually手动创建对应分词词典。
• 当导出的数据库中包含PDB时，使用gs_dumpall不会导出模板PDB及创建的PDB。
• gs_dump时HTAP表创建IMCV元信息（gs_imcv系统表）不会被转储。
• 当指定转储编码存在转码场景时，且表中的数据存在非法编码的数据，导出会报错invalid byte sequence，建议使用gs_dump的-s参数只导出定义，并单独使用COPY打开编码容错进行数据的导出与导入。

语法

gs_dumpall [OPTION]...

参数说明

通用参数：

• -f, --filename=<FILE_NAME>

  将输出发送至指定文件。如果这里省略，则使用标准输出。

• -v, --verbose

  指定verbose模式。该选项将导致gs_dumpall向转储文件输出详细的对象注解和启动/停止次数，向标准错误流输出处理信息。

• -V, --version

  打印gs_dumpall版本，然后退出。

• --lock-wait-timeout=TIMEOUT

  请勿在转储刚开始时一直等待以获取共享表锁。如果无法在指定时间内锁定某个表，就选择失败。可以以任何符合SET statement_timeout的格式指定超时时间。

• -?, --help

  显示gs_dumpall命令行参数帮助，然后退出。

转储参数：

• -a, --data-only

  只转储数据，不转储模式（数据定义）。

• -c, --clean

  在重新创建数据库之前，执行SQL语句清理（删除）这些数据库。针对角色和表空间的转储命令已添加。

• -g, --globals-only

  只转储全局对象（角色和表空间），无数据库。

• -o, --oids

  转储每个表的对象标识符（OIDs），作为表的一部分数据。该选项用于应用以某种方式（例如：外键约束方式）参照了OID列的情况。如果不是以上这种情况，请勿使用该选项。

• -O, --no-owner

  不输出设置对象的归属这样的命令，以匹配原始数据库。默认情况下，gs_dumpall会发出ALTER OWNER或SET SESSION AUTHORIZATION语句设置所创建的模式元素的所属。如果脚本正在运行，该语句不会执行成功，除非是由系统管理员触发（或是拥有脚本中所有对象的同一个用户）。通过指定-O，编写一个任何用户都能存储的脚本，且该脚本会授予该用户拥有所有对象的权限，因为没有使用ALTER OWNER或SET SESSION AUTHORIZATION语句，导入时一直使用执行用户权限，所以在导入前请确认转储文件内是否存在风险。例如，检查转储文件中是否包含提权语句，且该语句管理员是否知晓。

• -r, --roles-only

  只转储角色，不转储数据库或表空间。

• -s, --schema-only

  只转储对象定义（模式），而非数据。

• -S, --sysadmin=NAME

  该参数为扩展预留接口，不建议使用。

• -t, --tablespaces-only

  只转储表空间，不转储数据库或角色。

• -x, --no-privileges

  防止转储访问权限（授权/撤销命令）。

• --column-inserts/--attribute-inserts

  以INSERT命令带列名（INSERT INTO表（列、…）值…）方式导出数据。这会导致恢复缓慢。但是由于该选项会针对每行生成一个独立分开的命令，所以在重新加载某行时出现的错误只会导致失败语句对应的数据丢失，而非整个表内容。

  

  M-Compatibility模式数据库不支持该选项，导出M-Compatibility模式数据库时会跳过该选项。

• --disable-triggers

  该参数为扩展预留接口，不建议使用。

• --inserts

  发出INSERT命令（而非COPY命令）时转储数据。这会导致恢复缓慢。注意如果重排列顺序，可能会导致恢复整个失败。--column-inserts选项更加安全，虽然可能更慢些。

  

  M-Compatibility模式数据库不支持该选项，导出M-Compatibility模式数据库时会跳过该选项。

• --no-security-labels

  该参数为扩展预留接口，不建议使用。

• --no-tablespaces

  请勿输出创建表空间的命令，也请勿针对对象选择表空间。使用该选项，无论默认表空间是哪一个，在恢复过程中所有对象都会被创建。

• --no-unlogged-table-data

  该参数为扩展预留接口，不建议使用。

• --include-alter-table

  导出表中已删除的列信息。

• --quote-all-identifiers

  强制对所有标识符加引号。为了向后续版本迁移，且其中可能涉及引入额外关键词，在转储相应数据库时该选项会有帮助。

  

  M-Compatibility模式数据库不支持该选项，导出M-Compatibility模式数据库时会跳过该选项。

• --dont-overwrite-file

  不重写当前文件。

• --use-set-session-authorization

  输出符合SQL标准的SET SESSION AUTHORIZATION命令而不是ALTER OWNER命令来确定对象所有权。这样令转储更加符合标准，但是如果转储文件中的对象的历史有些问题，那么可能不能正确恢复。并且，使用SET SESSION AUTHORIZATION的转储需要数据库系统管理员的权限才能转储成功，而ALTER OWNER需要的权限则低得多。但是SET SESSION AUTHORIZATION部分支持使用密文密码随意切换用户及权限，因为使用此参数导出的脚本可能无法正常恢复，不建议使用此参数导出。

  

  SET SESSION AUTHORIZATION使用范围：

  • 系统管理员可以通过SET SESSION AUTHORIZATION语句切换到普通用户，无法切换到初始用户, 其他sysadmin、opradmin、monadmin、poladmin和auditadmin。
  • 其他用户无法通过SET SESSION AUTHORIZATION语句切换用户。
• --with-encryption=AES128

  指定转储数据需用AES128进行加密。

• --with-key=KEY

  AES128密钥规则如下：

  • 密钥长度为8~16个字符。
  • 至少包含大写字母（A-Z），小写字母（a-z），数字（0-9），非字母数字字符（限定为~!@#$%^&*()-_=+\|[{}];:,<.>/?）四类字符中的三类字符。
• --include-extensions

  如果include-extensions参数被设置，将备份所有的CREATE EXTENSION语句。

  

  扩展功能为内部使用功能，不建议用户使用。

• --include-templatedb

  转储过程中包含模板库。

• --binary-upgrade

  该参数为扩展预留接口，不建议使用。

  

  M-Compatibility数据库不支持该选项，导出M-Compatibility数据库时会跳过该选项。

• --binary-upgrade-usermap="USER1=USER2"
• 该参数为扩展预留接口，不建议使用。
• --non-lock-table

  该参数仅供软件间接口调用。

• --tablespaces-postfix

  该参数为扩展预留接口，不建议使用。

• --parallel-jobs

  指定备份进程并发数，取值范围为1~1000。

• --pipeline

  使用管道传输密码，禁止在终端使用。

说明

• 由于gs_dumpall内部调用gs_dump，所以一些诊断信息请参见gs_dump。
• 一旦恢复，建议在每个数据库上运行ANALYZE，优化程序提供有用的统计数据。
• gs_dumpall恢复前需要所有必要的表空间目录为空；否则，对于处在非默认位置的数据库，数据库创建会失败。

示例

使用gs_dumpall一次导出数据库的所有数据库。

gs_dumpall仅支持纯文本格式导出。所以只能使用gsql恢复gs_dumpall导出的转储内容。

相关命令

gs_dump