华为云用户手册

参数说明 start 启动gds.conf中配置的gds。 stop 关闭当前用户有权限关闭的经配置文件启动的gds运行实例。 stop all 关闭当前用户有权限关闭的所有gds运行实例。 stop [ ip: ] port 关闭当前用户有权限关闭的特定gds运行实例。如果启动时指定了ip:port，那么停止需要指定相应的ip:port；如果启动时未指定IP，只指定port，则停止只需指定相应的port即可。如启动和停止指定不同的信息，则停止失败。 status 查询通过gds.conf启动的gds实例的运行状态。

操作步骤 以gds_user用户登录安装GDS的数据服务器。 请根据启动GDS的方式，选择停止GDS的方式。 若用户使用“gds”命令启动GDS，请使用以下方式停止GDS。 执行如下命令，查询GDS进程号。 ps -ef|grep gds 示例：其中GDS进程号为128954。 ps -ef|grep gds gds_user 128954 1 0 15:03 ? 00:00:00 gds -d /input_data/ -p 192.168.0.90:5000 -l /log/gds_log.txt -D gds_user 129003 118723 0 15:04 pts/0 00:00:00 grep gds 使用“kill”命令，停止GDS。其中128954为上一步骤中查询出的GDS进程号。 kill -9 128954

参数说明 --host 待卸载节点的IP列表，支持文件和字符串两种形式： 文件形式：每一行一个IP地址，如： 192.168.2.200 192.168.2.201 字符串形式：半角逗号分隔，如： 192.168.2.200,192.168.2.201。 -U GDS用户。 --delete-user 卸载的同时，删除用户。被删除的用户不可以是root用户。 --delete-user-and-group 卸载的同时，删除用户和其所在用户组。仅当用户组只包含该待删除用户一个用户时可以删除用户组。该用户组不能是root用户组。 -V 显示版本信息。 -h, --help 显示帮助信息。

示例 卸载安装部署在节点192.168.1.100、192.168.1.101上，安装用户为gds_test的，GDS文件夹及环境变量。 gds_uninstall -U gds_test --host 192.168.1.100,192.168.1.101 卸载时，同时删除用户。 gds_uninstall -U gds_test --host 192.168.1.100,192.168.1.101 --delete-user

参数说明 -I 安装目录。 默认值：/opt/${gds_user}/packages/，其中${gds_user}表示GDS业务的操作系统用户。 -U GDS用户。 -G GDS用户所属组。 --pkg GDS安装包路径，形如/path/to/ GaussDB -8.2.1-REDHAT-x86_64bit-Gds.tar.gz。 --host 待安装部署节点的IP列表，支持文件和字符串两种形式： 文件形式：每一行一个IP地址，如： 192.168.2.200 192.168.2.201 字符串形式：半角逗号分隔，如： 192.168.2.200,192.168.2.201。 执行命令节点必须是待部署节点之一，其IP须在列表中。 --ping-host 调用gds_check时，在各检查节点上进行网络ping检查的目标地址。 取值：IP列表，支持文件和字符串两种形式，一般是DN、CN、网关的IP地址。 文件形式：每一行一个IP地址，如： 192.168.2.200 192.168.2.201 字符串形式：半角逗号分隔，如： 192.168.2.200,192.168.2.201 -V 显示版本信息。 -h, --help 显示帮助信息。

示例 将GDS安装部署在节点192.168.1.100、192.168.1.101上，并指定安装目录为/opt/gdspackages/install_dir，GDS用户是gds_test:wheel。 gds_install -I /opt/gdspackages/install_dir --host 192.168.1.100,192.168.1.101 -U gds_test -G wheel --pkg /home/gds_test/GaussDB-8.2.1-REDHAT-x86_64bit-Gds.tar.gz

示例 启动一个GDS进程，其数据文件存放在“/data” 目录，IP为192.168.0.90，监听端口为5000。 gds_ctl start --host 192.168.0.90 -d /data/ -p 5000 -H 10.10.0.1/24 -D 启动一批GDS进程，其数据文件存放在“/data” 目录，IP为192.168.0.90、192.168.0.91、192.168.0.92，监听端口为5000。 gds_ctl start --host 192.168.0.90,192.168.0.91,192.168.0.92 -d /data/ -p 5000 -H 0/0 -D 批量关闭位于192.168.0.90、192.168.0.91、192.168.0.92节点上，端口是5000的GDS进程： gds_ctl stop --host 192.168.0.90,192.168.0.91,192.168.0.92 -p 5000 批量重启位于192.168.0.90、192.168.0.91、192.168.0.92节点上，端口是5000的GDS进程： gds_ctl restart --host 192.168.0.90,192.168.0.91,192.168.0.92 -p 5000

语法 启动命令 gds_ctl start --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT -d DATADIR -H ALLOW_IPs [gds other original options] 停止命令 gds_ctl stop --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT 重启命令 gds_ctl restart --host [/path/to/hostfile | ipaddr1,ipaddr2...] -p PORT

参数说明 -t 操作类型，表示检查/修复。 取值：check，fix。 --host 需要检查/修复的节点IP列表。 取值：IP列表，支持文件和字符串两种形式。 文件形式：每一行一个IP地址，如： 192.168.1.200 192.168.1.201 字符串形式：半角逗号分隔，如： 192.168.1.200,192.168.1.201 --ping-host 在各检查节点上进行网络ping检查的目标地址。 取值：IP列表，支持文件和字符串两种形式，一般是DN、CN、网关的IP地址。 文件形式：每一行一个IP地址，如： 192.168.2.200 192.168.2.201 字符串形式：半角逗号分隔，如： 192.168.2.200,192.168.2.201 --detail 显示检查/修复项详细信息，并存入日志。 -V 显示版本信息。 -h, --help 显示帮助信息。

示例 执行检查，--host、--ping-host均为IP字符串形式： gds_check -t check --host 192.168.1.100,192.168.1.101 --ping-host 192.168.2.100 执行检查，--host为字符串，--ping-host为文件形式： gds_check -t check --host 192.168.1.100,192.168.1.101 --ping-host /home/gds/iplist cat /home/gds/iplist 192.168.2.100 192.168.2.101 执行检查，--host为文件形式，--ping-host为字符串： gds_check -t check --host /home/gds/iplist --ping-host 192.168.1.100,192.168.1.101 执行修复，--host为字符串： gds_check -t fix --host 192.168.1.100,192.168.1.101 执行检查，打印详细信息，并存入日志： gds_check -t check --host 192.168.1.100 --detail 执行修复，打印详细信息，并存入日志： gds_check -t fix --host 192.168.1.100 --detail

语法 检查命令 gds_check -t check --host [/path/to/hostfile | ipaddr1,ipaddr2...] --ping-host [/path/to/pinghostfile | ipaddr1,ipaddr2...] [--detail] 修复命令 gds_check -t fix --host [/path/to/hostfile | ipaddr1,ipaddr2...] [--detail]

示例 特例：执行gsql程序，使用如下选项导入由gs_dump/gs_dumpall生成导出文件夹（纯文本格式）的MPPDB_backup.sql文件到gaussdb数据库。 gsql -d gaussdb -p 8000 -W {password} -f /home/omm/test/MPPDB_backup.sql SET SET SET SET SET ALTER TABLE ALTER TABLE ALTER TABLE ALTER TABLE ALTER TABLE CREATE INDEX CREATE INDEX CREATE INDEX SET CREATE INDEX REVOKE REVOKE GRANT GRANT total time: 30476 ms gs_restore用来导入由gs_dump生成的导出文件。 示例1：执行gs_restore，将导出的MPPDB_backup.dmp文件（自定义归档格式）导入到gaussdb数据库。 gs_restore -W {password} backup/MPPDB_backup.dmp -p 8000 -d gaussdb gs_restore: restore operation successful gs_restore: total time: 13053 ms 示例2：执行gs_restore，将导出的MPPDB_backup.tar文件（tar格式）导入到gaussdb数据库。 gs_restore backup/MPPDB_backup.tar -p 8000 -d gaussdb gs_restore[2017-07-21 19:16:26]: restore operation successful gs_restore[2017-07-21 19:16:26]: total time: 21203 ms 示例3：执行gs_restore，将导出的MPPDB_backup文件（目录格式）导入到gaussdb数据库。 gs_restore backup/MPPDB_backup -p 8000 -d gaussdb gs_restore[2017-07-21 19:16:26]: restore operation successful gs_restore[2017-07-21 19:16:26]: total time: 21003 ms 示例4：执行gs_restore，使用自定义归档格式的MPPDB_backup.dmp文件来进行如下导入操作。 导入PUBLIC模式下所有对象的定义和数据。在导入时会先删除已经存在的对象，如果原对象存在跨模式的依赖则需手工强制干预。 gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -n PUBLIC gs_restore: [archiver (db)] Error while PRO CES SING TOC: gs_restore: [archiver (db)] Error from TOC entry 313; 1259 337399 TABLE table1 gaussdba gs_restore: [archiver (db)] could not execute query: ERROR: cannot drop table table1 because other objects depend on it DETAIL: view t1.v1 depends on table table1 HINT: Use DROP ... CASCADE to drop the dependent objects too. Command was: DROP TABLE public.table1; 手工删除依赖，导入完成后再重新创建。 gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -n PUBLIC gs_restore[2017-07-21 19:16:26]: restore operation successful gs_restore[2017-07-21 19:16:26]: total time: 2203 ms 示例5：执行gs_restore，使用自定义归档格式的MPPDB_backup.dmp文件来进行如下导入操作。只导入PUBLIC模式下表table1的定义。 gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -c -s -n PUBLIC -t table1 gs_restore[2017-07-21 19:16:26]: restore operation successful gs_restore[2017-07-21 19:16:26]: total time: 21000 ms 示例6：执行gs_restore，使用自定义归档格式的MPPDB_backup.dmp文件来进行如下导入操作。只导入PUBLIC模式下表table1的数据。 gs_restore backup/MPPDB_backup.dmp -p 8000 -d gaussdb -e -a -n PUBLIC -t table1 gs_restore[2017-07-21 19:16:26]: restore operation successful gs_restore[2017-07-21 19:16:26]: total time: 20203 ms

命令格式 gs_restore [OPTION]... FILE FILE没有短选项或长选项。用来指定归档文件所处的位置。 作为前提条件，需输入dbname或-l选项。不允许用户同时输入dbname和-l选项。 gs_restore默认是以追加的方式进行数据导入。为避免多次导入造成数据异常，在进行导入时，建议使用"-e"和"-c" 参数，即导入前删除已存在于待导入数据库中的数据库对象，同时当出现导入错误时，忽略当前错误，继续执行导入任务，并在导入后会显示相应的错误信息。

背景信息 gs_restore是GaussDB(DWS)提供的针对gs_dump导出数据的导入工具。通过此工具可由gs_dump生成的导出文件进行导入。 主要功能包含： 导入到数据库 如果连接参数中指定了数据库，则数据将被导入到指定的数据库中。其中，并行导入必须指定连接的密码。 导入到脚本文件 如果未指定导入数据库，则创建包含重建数据库所必须的SQL语句脚本并写入到文件或者标准输出。等效于直接使用gs_dump导出为纯文本格式。

注意事项 禁止修改导出的文件和内容，否则可能无法恢复成功。 为了保证数据一致性和完整性，gs_dumpall会对需要转储的表设置共享锁。如果某张表在别的事务中设置了共享锁，gs_dumpall会等待此表的锁释放后锁定此表。如果无法在指定时间内锁定某张表，转储会失败。用户可以通过指定--lock-wait-timeout选项，自定义等待锁超时时间。 由于gs_dumpall读取所有数据库中的表，因此必须以数据库集群管理员身份进行连接，才能导出完整文件。在使用gsql执行脚本文件导入时，同样需要管理员权限，以便添加用户和组，以及创建数据库。

背景信息 gs_dumpall是GaussDB(DWS)用于导出所有数据库相关信息工具，它可以导出集群数据库的所有数据，包括默认数据库postgres的数据、自定义数据库的数据、以及集群所有数据库公共的全局对象。 gs_dumpall工具在进行数据导出时，其他用户可以访问集群数据库（读或写）。 gs_dumpall工具支持导出完整一致的数据。例如，T1时刻启动gs_dumpall导出整个集群数据库，那么导出数据结果将会是T1时刻该集群数据库的数据状态，T1时刻之后对集群数据库的修改不会被导出。 gs_dumpall在导出整个集群所有数据库时分为两部分： gs_dumpall自身对所有数据库公共的全局对象进行导出，包括有关数据库用户和组，表空间以及属性（例如，适用于数据库整体的访问权限）信息。 gs_dumpall通过调用gs_dump来完成集群中各数据库的SQL脚本文件导出，该脚本文件包含将数据库恢复为其保存时的状态所需要的全部SQL语句。 以上两部分导出的结果为纯文本格式的SQL脚本文件，使用gsql运行该脚本文件可以恢复集群数据库。

参数说明 通用参数： -f, --filename=FILENAME 将输出发送至指定文件。如果这里省略，则使用标准输出。 -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，编写一个任何用户都能存储的脚本，且该脚本会授予该用户拥有所有对象的权限。 -r, --roles-only 只转储角色，不转储数据库或表空间。 -s, --schema-only 只转储对象定义（模式），而非数据。 -S, --sysadmin=NAME 在转储过程中使用的系统管理员名称。 -t, --tablespaces-only 只转储表空间，不转储数据库或角色。 -x, --no-privileges 防止转储访问权限（授权/撤销命令）。 --column-inserts|--attribute-inserts 以INSERT命令带列名（INSERT INTO表（列、…）值…）方式导出数据。这会导致恢复缓慢。但是由于该选项会针对每行生成一个独立分开的命令，所以在重新加载某行时出现的错误只会导致那行丢失，而非整个表内容。 --disable-dollar-quoting 该选项将禁止在函数体前使用美元符号$，并强制使用SQL标准字符串语法对其进行引用。 --disable-triggers 该参数为扩展预留接口，不建议使用。 --inserts 发出INSERT命令（而非COPY命令）时转储数据。这会导致恢复缓慢。注意如果重排列顺序，可能会导致恢复整个失败。--column-inserts选项更加安全，虽然可能更慢些。 --no-security-labels 该参数为扩展预留接口，不建议使用。 --no-tablespaces 该参数在8.2.0.100版本中已废弃，为兼容历史版本功能保留该函数。 请勿输出创建表空间的命令，也请勿针对对象选择表空间。使用该选项，无论默认表空间是哪个，在恢复过程中所有对象都会被创建。 --no-unlogged-table-data 该参数为扩展预留接口，不建议使用。 --quote-all-identifiers 强制对所有标识符加引号。为了向后续版本迁移，且其中可能涉及引入额外关键词，在转储相应数据库时该选项会有帮助。 --dont-overwrite-file 不重写当前文件。 --use-set-session-authorization 输出符合SQL标准的SET SESSION AUTHORIZATION命令而不是ALTER OWNER命令来确定对象所有权。这样令转储更加符合标准，但是如果转储文件中的对象的历史有些问题，那么可能不能正确恢复。并且，使用SET SESSION AUTHORIZATION的转储需要数据库系统管理员的权限才能转储成功，而ALTER OWNER需要的权限则低得多。 --with-encryption=AES128 指定转储数据需用AES128进行加密。 --with-key=KEY AES128密钥长度必须是16字节。 --include-extensions 如果include-extensions参数被设置，将备份所有的CREATE EXTENSION语句。 --include-templatedb 转储过程中包含模板库。 --dump-nodes 转储过程中包含节点和Node Group。 --include-nodes 将TO NODE语句包含在已转储的CREATE TABLE命令中。 --include-buckets 该参数为扩展预留接口，不建议使用。 --dump-wrm 存储过程中包含负载资源管理器，具体包括资源池、负载组以及负载组映射。 --binary-upgrade 该参数为扩展预留接口，不建议使用。 --binary-upgrade-usermap="USER1=USER2" 该参数为扩展预留接口，不建议使用。 --tablespaces-postfix 该参数为扩展预留接口，不建议使用。 --parallel-jobs 指定备份进程并发数，取值范围为1~1000。

说明 场景1 如果某数据库集群有任何本地数据要添加到template1数据库，请谨慎将gs_dump的输出恢复到一个真正的空数据库中，否则可能会因为被添加对象的定义被复制，出现错误。要创建一个无本地添加的空数据库，需从template0而非template1复制，例如： CREATE DATABASE foo WITH TEMPLATE template0; tar归档形式的文件大小不得超过8GB（tar文件格式的固有限制）。tar文档整体大小和任何其他输出格式没有限制，操作系统可能对此有要求。 由gs_dump生成的转储文件不包含优化程序用来做执行计划决定的统计数据。因此，最好从某转储文件恢复之后运行ANALYZE以确保最佳效果。转储文件不包含任何ALTER DATABASE…SET命令，这些设置由gs_dumpall转储，还有数据库用户和其他完成安装设置。 场景2 当SEQUENCE已经到达最大或最小值时，通过gs_dump来备份SEQUENCE值会因执行报错退出。可参考如下说明处理： SEQUENCE已经到达最大值，但最大值小于2^63-2 报错示例： sequence对象定义 CREATE SEQUENCE seq INCREMENT 1 MINVALUE 1 MAXVALUE 3 START WITH 1; 执行gs_dump备份 gs_dump -U dbadmin -W {password} -p 37300 postgres -t PUBLIC.seq -f backup/MPPDB_backup.sql gs_dump[port='37300'][postgres][2019-12-27 15:09:49]: The total objects number is 337. gs_dump[port='37300'][postgres][2019-12-27 15:09:49]: WARNING: get invalid xid from GTM because connection is not established gs_dump[port='37300'][postgres][2019-12-27 15:09:49]: WARNING: Failed to receive GTM rollback transaction response for aborting prepared (null). gs_dump: [port='37300'] [postgres] [archiver (db)] [2019-12-27 15:09:49] query failed: ERROR: Can not connect to gtm when getting gxid, there is a connection error. gs_dump: [port='37300'] [postgres] [archiver (db)] [2019-12-27 15:09:49] query was: RELEASE bfnextval 处理方法： 通过SQL语句连接postgres数据库，执行如下语句，修改sequence seq1的最大值。 gsql -p 37300 postgres -r -c "ALTER SEQUENCE PUBLIC.seq MAXVALUE 10;" 执行dump工具进行备份。 gs_dump -U dbadmin -W {password} -p 37300 postgres -t PUBLIC.seq -f backup/MPPDB_backup.sql gs_dump[port='37300'][postgres][2019-12-27 15:10:53]: The total objects number is 337. gs_dump[port='37300'][postgres][2019-12-27 15:10:53]: [100.00%] 337 objects have been dumped. gs_dump[port='37300'][postgres][2019-12-27 15:10:53]: dump database postgres successfully gs_dump[port='37300'][postgres][2019-12-27 15:10:53]: total time: 230 ms SEQUENCE已经到达最小值或最大值2^63-2 gs_dump不支持该场景下的SEQUENCE数值备份。 SQL端不支持SEQUENCE到达最大值2^63-2后的MAXVALUE修改，不支持SEQUENCE到达最小值后的MINVALUE修改。

语法 gs_dump [OPTION]... [DBNAME] “dbname”前面不需要加短或长选项。“dbname”指定要连接的数据库。 例如： 不需要-d，直接指定“dbname”。 gs_dump -p port_number postgres -f dump1.sql 或者 export PGDATABASE=postgres gs_dump -p port_number -f dump1.sql 环境变量： PGDATABASE

示例 使用gs_dump转储数据库为SQL文本文件或其它格式的操作，如下所示。 示例中“password”表示数据库用户密码，由用户自己设置；“backup/MPPDB_backup.sql”表示导出的文件，其中backup表示相对于当前目录的相对目录；“37300”表示数据库服务器端口；“postgres”表示要访问的数据库名。 导出操作时，请确保该目录存在并且当前的操作系统用户对其具有读写权限。 示例1：执行gs_dump，导出postgres数据库全量信息，导出的MPPDB_backup.sql文件格式为纯文本格式。 gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.sql -p 37300 postgres -F p gs_dump[port='37300'][postgres][2018-06-27 09:49:17]: The total objects number is 356. gs_dump[port='37300'][postgres][2018-06-27 09:49:17]: [100.00%] 356 objects have been dumped. gs_dump[port='37300'][postgres][2018-06-27 09:49:17]: dump database postgres successfully gs_dump[port='37300'][postgres][2018-06-27 09:49:17]: total time: 1274 ms 使用gsql程序从纯文本导出文件中导入数据。 示例2：执行gs_dump，导出postgres数据库全量信息，导出的MPPDB_backup.tar文件格式为tar格式。 gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.tar -p 37300 postgres -F t gs_dump[port='37300'][postgres][2018-06-27 10:02:24]: The total objects number is 1369. gs_dump[port='37300'][postgres][2018-06-27 10:02:53]: [100.00%] 1369 objects have been dumped. gs_dump[port='37300'][postgres][2018-06-27 10:02:53]: dump database postgres successfully gs_dump[port='37300'][postgres][2018-06-27 10:02:53]: total time: 50086 ms 示例3：执行gs_dump，导出postgres数据库全量信息，导出的MPPDB_backup.dmp文件格式为自定义归档格式。 gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup.dmp -p 37300 postgres -F c gs_dump[port='37300'][postgres][2018-06-27 10:05:40]: The total objects number is 1369. gs_dump[port='37300'][postgres][2018-06-27 10:06:03]: [100.00%] 1369 objects have been dumped. gs_dump[port='37300'][postgres][2018-06-27 10:06:03]: dump database postgres successfully gs_dump[port='37300'][postgres][2018-06-27 10:06:03]: total time: 36620 ms 示例4：执行gs_dump，导出postgres数据库全量信息，导出的MPPDB_backup文件格式为目录格式。 gs_dump -U dbadmin -W {password} -f backup/MPPDB_backup -p 37300 postgres -F d gs_dump[port='37300'][postgres][2018-06-27 10:16:04]: The total objects number is 1369. gs_dump[port='37300'][postgres][2018-06-27 10:16:23]: [100.00%] 1369 objects have been dumped. gs_dump[port='37300'][postgres][2018-06-27 10:16:23]: dump database postgres successfully gs_dump[port='37300'][postgres][2018-06-27 10:16:23]: total time: 33977 ms

参数说明 通用参数： -f, --file=FILENAME 将输出发送至指定文件或目录。如果省略该参数，则使用标准输出。如果输出格式为(-F c/-F d/-F t)时，必须指定-f参数。如果-f的参数值含有目录，要求目录对当前用户具有读写权限。 -F, --format=c|d|t|p 选择输出格式。格式如下： p|plain：输出一个文本SQL脚本文件（默认）。 c|custom：输出一个自定义格式的归档，并且以目录形式输出，作为gs_restore输入信息。该格式是最灵活的输出格式，因为能手动选择，而且能在恢复过程中将归档项重新排序。该格式默认状态下会被压缩。 d|directory：该格式会创建一个目录，该目录包含两类文件，一类是目录文件，另一类是每个表和blob对象对应的数据文件。 t|tar：输出一个tar格式的归档形式，作为gs_restore输入信息。tar格式与目录格式兼容；tar格式归档形式在提取过程中会生成一个有效的目录格式归档形式。但是，tar格式不支持压缩且对于单独表有8GB的大小限制。此外，表数据项的相应排序在恢复过程中不能更改。 输出一个tar格式的归档形式，也可以作为gsql输入信息。 -v, --verbose 指定verbose模式。该选项将导致gs_dump向转储文件输出详细的对象注解和启动/停止次数，向标准错误流输出处理信息。 -V, --version 打印gs_dump版本，然后退出。 -Z, --compress=0-9 指定使用的压缩比级别。 取值范围：0~9 0表示无压缩。 1表示压缩比最小，处理速度最快。 9表示压缩比最大，处理速度最慢。 针对自定义归档格式，该选项指定单个表数据片段的压缩，默认方式是以中等级别进行压缩。对于文本输出，设置非零压缩级别将会导致整个输出文件被压缩（类似通过gzip进行压缩），默认不压缩。tar归档格式目前不支持压缩。 --lock-wait-timeout=TIMEOUT 请勿在转储刚开始时一直等待以获取共享表锁。如果无法在指定时间内锁定某个表，就选择失败。可以以任何符合SET statement_timeout的格式指定超时时间。 -?, --help 显示gs_dump命令行参数帮助，然后退出。 转储参数：

背景信息 gs_dump是GaussDB(DWS)用于导出数据库相关信息的工具，用户可以自定义导出一个数据库或其中的对象（模式、表、视图等）。支持导出的数据库可以是默认数据库postgres，也可以是自定义数据库。 gs_dump工具在进行数据导出时，其他用户可以访问集群数据库（读或写）。 gs_dump工具支持导出完整一致的数据。例如，T1时刻启动gs_dump导出A数据库，那么导出数据结果将会是T1时刻A数据库的数据状态，T1时刻之后对A数据库的修改不会被导出。 gs_dump支持将数据库信息导出至纯文本格式的SQL脚本文件或其他归档文件中。 纯文本格式的SQL脚本文件：包含将数据库恢复为其保存时的状态所需的SQL语句。通过gsql运行该SQL脚本文件，可以恢复数据库。即使在其他主机和其他数据库产品上，只要对SQL脚本文件稍作修改，也可以用来重建数据库。 归档格式文件：包含将数据库恢复为其保存时的状态所需的数据，可以是tar格式、目录归档格式或自定义归档格式，详见表1。该导出结果必须与gs_restore配合使用来恢复数据库，gs_restore工具在导入时，系统允许用户选择需要导入的内容，甚至可以在导入之前对等待导入的内容进行排序。

主要功能 gs_dump可以创建四种不同的导出文件格式，通过[-F或者--format=]选项指定，具体如表1所示。 表1 导出文件格式 格式名称 -F的参数值 说明 建议 对应导入工具 纯文本格式 p 纯文本脚本文件包含SQL语句和命令。命令可以由gsql命令行终端程序执行，用于重新创建数据库对象并加载表数据。 小型数据库，一般推荐纯文本格式。 使用gsql工具恢复数据库对象前，可根据需要使用文本编辑器编辑纯文本导出文件。 自定义归档格式 c 一种二进制文件。支持从导出文件中恢复所有或所选数据库对象。 中型或大型数据库，推荐自定义归档格式。 使用gs_restore可以选择要从自定义归档导出文件中导入相应的数据库对象。 目录归档格式 d 该格式会创建一个目录，该目录包含两类文件，一类是目录文件，另一类是每个表和blob对象对应的数据文件。 - tar归档格式 t tar归档文件支持从导出文件中恢复所有或所选数据库对象。tar归档格式不支持压缩且对于单独表大小应小于8GB。 - 可以使用gs_dump程序将文件压缩为纯文本或自定义归档导出文件，减少导出文件的大小。生成纯文本导出文件时，默认不压缩。生成自定义归档导出文件时，默认进行中等级别的压缩。gs_dump程序无法压缩已归档导出文件。

处理数据导入错误 根据获取的错误信息，请对照下表，处理数据导入错误。 表2 处理数据导入错误 错误信息 原因 解决办法 missing data for column "r_reason_desc" 数据源文件中的列数比外表定义的列数少。 对于TEXT格式的数据源文件，由于转义字符（\）导致delimiter（分隔符）错位或者quote（引号字符）错位造成的错误。 示例：目标表存在3列字段，导入的数据如下所示。由于存在转义字符“\”，分隔符“|”被转义为第二个字段的字段值，导致第三个字段值缺失。 BE|Belgium\|1 由于列数少导致的报错，选择下列办法解决： 在数据源文件中，增加列“r_reason_desc”的字段值。 在创建外表时，将参数“fill_missing_fields”设置为“on”。即在导入过程中，若数据源文件中一行数据的最后一个字段缺失，则把最后一个字段的值设置为NULL，不报错。 对由于转义字符导致的错误，需检查报错的行中是否含有转义字符（\）。若存在，建议在创建外表时，将参数“noescaping”（是否不对'\'和后面的字符进行转义）设置为true。 extra data after last expected column 数据源文件中的列数比外表定义的列数多。 在数据源文件中，删除多余的字段值。 在创建外表时，将参数“ignore_extra_data”设置为“on”。即在导入过程中，若数据源文件比外表定义的列数多，则忽略行尾多出来的列。 invalid input syntax for type numeric: "a" 数据类型错误。 在数据源文件中，修改输入字段的数据类型。根据此错误信息，请将输入的数据类型修改为numeric。 null value in column "staff_id" violates not-null constraint 非空约束。 在数据源文件中，增加非空字段信息。根据此错误信息，请增加“staff_id”列的值。 duplicate key value violates unique constraint "reg_id_pk" 唯一约束。 删除数据源文件中重复的行。 通过设置关键字“DISTINCT”，从SELECT结果集中删除重复的行，保证导入的每一行都是唯一的。 1 INSERT INTO reasons SELECT DISTINCT * FROM foreign_tpcds_reasons; value too long for type character varying(16) 字段值长度超过限制。 在数据源文件中，修改字段值长度。根据此错误信息，字段值长度限制为VARCHAR2(16)。

Data Studio用户界面 表1 用户界面简介 界面名称 描述 主菜单 提供使用Data Studio的基本操作。 工具栏 提供常用操作入口。 “SQL终端”页签 用于执行SQL语句和函数/过程。 “PL/SQL Viewer”页签 显示函数/过程信息。 “调用堆栈”窗格 显示执行栈。 “断点”窗格 显示所有设置过的断点。 “变量”窗格 显示变量及其变量值。 “SQL Assistant”页签 显示“SQL终端”和“PL/SQL Viewer”页签中输入信息的建议或参考。 “结果”页签 显示所执行的函数/过程或SQL语句的结果。 “消息”页签 显示进程输出。显示标准输入、标准输出和标准错误。 “对象浏览器”窗格 显示数据库连接的层级树形结构和用户有权访问的相关数据库对象。除公共模式外，所有默认创建的模式均分组在“系统模式”下，用户模式分组在相应数据库的“用户模式”下。 说明： “对象浏览器”仅显示满足当前用户权限要求的对象。 “最小化窗口”窗格 用于打开“调用堆栈”、“断点”和“变量”窗格。该窗格仅在“调用堆栈”、“断点”、“变量”窗格中的一个或多个窗格最小化时显示。 搜索工具栏 用于在“对象浏览器”窗格中搜索对象。

工具简介 本手册介绍 数据仓库 服务的工具使用，提供了客户端工具和服务端工具，客户端工具如表1所示，服务端工具如表2所示。 客户端工具：参见工具下载获取。 服务端工具：位于安装数据库服务器的$GPHOME/script和$GAUSSHOME/bin路径下。 表1 客户端工具 工具名称 工具简介 gsql 一款运行在Linux操作系统的命令行工具，用于连接DWS集群中的数据库，并对数据库进行操作和维护。 Data Studio 用于连接数据库的客户端工具，有着丰富的GUI界面，能够管理数据库和数据库对象，编辑、运行、调试SQL脚本，查看执行计划等。Data Studio工具可运行在32位或64位windows操作系统上，解压软件包后免安装即可使用。 GDS 一款运行在Linux操作系统的命令行工具，通过和外表机制的配合，实现数据的高速导入导出。GDS工具包需要安装在数据源文件所在的服务器上，数据源文件所在的服务器称为数据服务器，也叫GDS服务器。 DSC 用于将Teradata或Oracle数据库中的sql脚本迁移为适用于GaussDB(DWS)的sql脚本，便于在GaussDB(DWS)中重建数据库。DSC工具是运行在Linux操作系统的命令行工具，解压软件包免安装即可使用。 表2 服务端工具 工具名称 简介 gs_dump gs_dump是一款用于导出数据库相关信息的工具，支持导出完整一致的数据库对象（数据库、模式、表、视图等）数据，同时不影响用户对数据库的正常访问。 gs_dumpall gs_dumpall是一款用于导出数据库相关信息的工具，支持导出完整一致的集群数据库所有数据，同时不影响用户对数据库的正常访问。 gs_restore gs_restore是GaussDB(DWS)提供的针对gs_dump导出数据的导入工具。通过此工具可由gs_dump生成的导出文件进行导入。 gds_check gds_check用于对GDS部署环境进行检查，包括操作系统参数、网络环境、磁盘占用情况等，也支持对可修复系统参数的修复校正，有助于在部署运行GDS时提前发现潜在问题，提高执行成功率。 gds_install gds_install是用于批量安装gds的脚本工具，可大大提高GDS部署效率。 gds_uninstall gds_uninstall是用于批量卸载GDS的脚本工具。 gds_ctl gds_ctl是一个批量控制GDS启停的脚本工具，一次执行可以在多个节点上启动/停止相同端口的GDS服务进程，并在启动时为每一个进程设置看护程序，用于看护GDS进程。

查看表属性 右键单击表，选择“属性”查看表属性。 Data Studio在不同页签显示所选表的属性（“一般”、“列”、“约束”和“索引”）。可在每个页签上对指定对象进行编辑，可双击单元格执行编辑操作。 查看表格数据时，Data Studio会自动调整列宽以获得表视图。用户可以根据需要调整列的大小。如果单元格的文本内容超出了可用的显示区域，则调整单元格列的大小可能会导致DS无法响应。 一个表显示一个属性窗口。 如果一个已打开的表格的属性被修改，刷新并重新打开该表格的属性查看更新后的表格属性信息。 如果列的内容包含空格，会在空格处自动断行以适应该列的显示区域。不包含空格的内容不会自动断行。 列的大小取决于内容最长的列的长度。 刷新“属性”页签后，将显示在“对象浏览器”对表属性所做的任何更改。 “Data Type”列不允许粘贴操作。

导出DDL和数据 通过导出表DDL和数据，可导出表的DDL和表的数据。 在“对象浏览器”窗格中，右键单击所选表，选择“导出DDL和数据”。 用户需自定义导出路径。如果需要将数据压缩，勾选“.zip”选项。 “Data Studio安全免责声明”必须勾选“我同意”才可以单击“确定”。用户可关闭安全免责声明，关闭后导出DDL时将不会再出现，详情请参见表1。 单击“确定”，右下角的状态栏会显示操作进度。 如果文件名包含Windows中文件名不支持的字符，则文件名的名称会与模式名称不同。 要执行该操作，需要MS Visual C Runtime文件（msvcrt100.dll）。详情请参阅故障处理。 “导出完成”对话框和状态栏显示已完成操作的状态。 表1 支持导出DDL的编码格式 数据库编码 文件编码 支持导出DDL UTF-8 UTF-8 是 GBK 是 LATIN1 是 GBK GBK 是 UTF-8 是 LATIN1 否 LATIN1 LATIN1 是 GBK 否 UTF-8 是 可从普通表和分区表中选择多个对象，以导出DDL和数据。导出的内容包含列、行、索引、约束和分区。

查看数据 右键单击表，选择“查看数据”查看表数据。Data Studio显示“查看数据”页签，可在该页签查看表数据信息。 “查看数据”页签的工具栏菜单： 工具栏名称 说明 复制 用于从“查看数据”页签将数据复制。快捷键为Ctrl+C。 高级复制 用于将结果窗口中的内容复制。可以复制结果以包含行号和/或列标题。请参阅表1以设置此首选项。快捷键为Ctrl+Shift+C。 显示/隐藏搜索栏 用于显示/隐藏搜索文本区域。单击该按钮可在两种状态间切换。 编码 有关如何选择编码，请参见执行SQL查询。 搜索区域中的图标： 图标名称 描述 搜索 用于根据定义的标准，搜索显示的表数据。搜索内容不区分大小写。 清空搜索内容 用于清空在搜索字段中输入的搜索内容。 有关调整列位置或对列进行排序的具体信息，请参阅执行SQL查询。 “查询提交时间”：提供查询的提交时间。 获取的行数和执行时间同时显示，且会显示默认行数。如果有其他记录待获取，此图标将显示为“更多”。用户可将光标滚至表底部读取并显示所有行。 查看表数据时，Data Studio会自动调整列宽。用户可以根据需要调整列的大小。如果单元格的文本内容超出了可用的显示区域，则调整单元格列的大小可能会导致Data Studio无法响应。 表的单元格最多可显示1000个字符，超出部分显示为“...”。 一个表显示一个表数据窗口。 如果已打开的表数据被修改了，刷新并重新打开该表数据并在同一打开的窗口查看更新后的表数据。 数据在加载过程中，表格下方会出现一条“读取中”的消息。 如果列的内容包含空格，会在空格处自动断行以适应该列的显示区域。不包含空格的内容不会自动断行。 要复制单元格中的部分内容，先选中所需部分，然后按下“Ctrl+C”。 列的大小取决于内容最长的列的长度。

编辑表数据 右键单击表，选择“编辑数据”。页面显示“编辑表数据”页签。 有关复制、搜索工具栏和字符编码下拉列表选项的说明，请参阅查看数据。 Data Studio仅识别单元格中的如下数据类型：Bigint、bit、Boolean、char、date、decimal、double、float、integer、numeric、real、smallint、tinyint和varchar。 不支持编辑数组数据类型、包含时区的时间列和包含时区的时间戳列。 数据库上报的与该操作相关的错误会显示在Data Studio中。