华为云用户手册

RDS for SQL Server 2016功能概览 类别 功能 版本 web版 标准版 企业版 单机 单机 主备 单机 主备 实例管理 购买实例 √ √ √ √ √ 重启实例 √ √ √ √ √ 实例续费 √ √ √ √ √ 变更计费方式 按需实例转包周期 包周期实例转按需 √ √ √ √ √ 变更实例的CPU和规格 √ √ √ √ √ 重置密码 √ √ √ √ √ 单机转主备 × √ × √ × 磁盘扩容 √ √ √ √ √ 手动切换主备实例 × × √ × √ 删除按需实例 √ √ √ √ √ 升级引擎版本 √ √ √ √ √ 创建只读实例 × × × × × 修改实例名称 √ √ √ √ √ 修改备注 √ √ √ √ √ 创建指定实例字符集 √ √ √ √ √ 设置可维护时间段 √ √ √ √ √ 购买相同配置实例 √ √ √ √ √ 标签 管理标签 √ √ √ √ √ 任务中心 任务中心 √ √ √ √ √ 数据迁移 DRS备份迁移 √ √ √ √ √ 数据库连接 VPC内访问（内网访问） √ √ √ √ √ 公网访问 √ √ √ √ √ 修改内网地址 √ √ √ √ √ 修改数据库端口 √ √ √ √ √ 备份恢复 全量备份（自动备份） √ √ √ √ √ 增量备份 √ √ √ √ √ 下载备份 √ √ √ √ √ 复制备份 √ √ √ √ √ 自动备份策略 √ √ √ √ √ 通过备份文件恢复到RDS for SQL Server √ √ √ √ √ 恢复实例到指定时间点 √ √ √ √ √ 手动备份 √ √ √ √ √ 恢复到新实例 √ √ √ √ √ 恢复到已有实例 √ √ √ √ √ 设置跨区域备份策略 √ √ √ √ √ 监控与告警 资源监控 √ √ √ √ √ 引擎监控 √ √ √ √ √ 设置告警规则 √ √ √ √ √ 参数管理 创建参数模板 √ √ √ √ √ 比较参数模板 √ √ √ √ √ 应用参数模板 √ √ √ √ √ 查看参数模板应用记录 √ √ √ √ √ 编辑参数模板 √ √ √ √ √ 导出参数模板 √ √ √ √ √ 查看参数修改历史 √ √ √ √ √ 日志管理 查看或下载运行日志 √ √ √ √ √ 查看或下载慢日志 √ √ √ √ √ 安全管理 云审计 服务 √ √ √ √ √ 数据库审计(DBSS) √ √ √ √ √ 服务端加密 √ √ √ √ √ 数据库安全 √ √ √ √ √ 修改实例安全组 √ √ √ √ √ 开启透明 数据加密 （TDE） × × × √ √ 回收站 设置回收站策略 √ √ √ √ √ 重建实例 √ √ √ √ √ 引擎主要功能 账号管理 √ √ √ √ √ 数据库管理 √ √ √ √ √ 加域实例创建与访问 √ √ √ √ √ 分布式事务（MSDTC） √ √ √ √ √ 集成服务（SSIS） × √ √ √ √ 文件流（FileStream） √ √ × √ × 开启CLR集成功能 √ √ √ √ √ 创建和配置Agent Job和Dblink √ √ √ √ √ 存储过程相关 修改自定义数据库名称 √ √ √ √ √ 变更数据捕获（CDC） × √ √ √ √ 收缩数据库 √ √ √ √ √ 数据库复制 √ √ √ √ √ 更新数据库统计信息 √ √ √ √ √ 跟踪标记 √ √ √ √ √ 最佳实践 发布与订阅 √ √ √ √ √ 对接SSRS报表服务 √ √ √ √ √ 添加链接服务器 √ √ √ √ √ 父主题： RDS for SQL Server各版本功能概览

Oracle PACKAGE迁移注意事项 应将包规范(即包头)与包体分置于不同文件、相同输入路径中进行迁移。 应先使用Bulk模式迁移普通DDL语句（包含PACKAGE脚本中引用到的全部表结构信息），以在config/create-types-UDT.properties文件中形成字典信息。之后再使用Blogic模式迁移包规范（即包头）与包体。具体解释如下： 在部分Oracle PACKAGE定义包规范时，使用了"tbName.colName%TYPE"语法以基于其他表对象声明自定义的记录类型。 1 2 3 4 5 6 7 8 9 10 例如 CREATE OR REPLACE PACKAGE p_emp AS --定义RECORD类型 TYPE re_emp IS RECORD( rno emp.empno%TYPE, rname emp.empname%TYPE ); END; GaussDB 暂不支持通过"tbName.colName%TYPE"语法在CREATE TYPE命令中指定列数据类型，DSC工具在迁移时需要构建含有诸如emp表信息的数据库上下文环境。由此需要先使用DSC工具迁移所有的建表脚本(即使用Bulk模式迁移普通DDL语句)，DSC内部会自动生成相应的数据字典。当含有各种表信息的上下文环境构建完成后，可以使用Blogic模式迁移 Oracle PACKAGE，此时re_emp记录类型会根据emp表的列类型完成迁移。 1 2 3 4 5 期望输出 CREATE TYPE p_emp.re_emp AS ( rno NUMBER(4), rname VARCHAR2(10) );

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

示例 特例：执行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" 参数，即导入前删除已存在于待导入数据库中的数据库对象，同时当出现导入错误时，忽略当前错误，继续执行导入任务，并在导入后会显示相应的错误信息。

简介 dws-client是一款基于DWS JDBC实现的高性能、便捷入库工具，用户在使用时必须保证JDBC可以连接。其中使用dws-client入库具备如下优势： dws-client提供对缓存的空间、时间维度的限制，支持攒批提升入库性能，以满足业务在高峰低谷期的入库实时性。 攒批：在实时性要求不严格的场景，对单条数据操作进行缓存，待缓存至多条后批量操作，以提升写入性能。 支持并发入库。 内部实现多种高性能入库方式、主键冲突策略，满足各种场景入库需求。 API方式交互，低门槛使用。

异常处理 异常可分为三类： InvalidException运行时异常不显示抛出，触发在请求参数无效时。 DwsClientException对所有异常的封装，包含被解析的code以及原始异常。 DwsClientRecordException对DwsClientException的扩展，包含写入异常的数据集合以及对应DwsClientException异常。 异常code对照： public enum ExceptionCode { /** * 无效参数 */ INVALID_CONFIG(1), /** * 连接异常 */ CONNECTION_ERROR(100), /** * 只读 */ READ_ONLY(101), /** * 超时 */ TIMEOUT(102), /** * 连接数过多 */ TOO_MANY_CONNECTIONS(103), /** * 加锁异常 */ LOCK_ERROR(104), /** * 认证失败 */ AUTH_FAIL(201), /** * 已经关闭 */ ALREADY_CLOSE(202), /** * 无权限 */ PERMISSION_DENY(203), SYNTAX_ERROR(204), /** * 内部异常 */ INTERNAL_ERROR(205), /** * 中断异常 */ INTERRUPTED(206), /** * 表未发现 */ TABLE_NOT_FOUND(207), CONSTRAINT_VIOLATION(208), DATA_TYPE_ERROR(209), DATA_VALUE_ERROR(210), /** * 解析不到的异常 */ UNKNOWN_ERROR(500); private final int code; }

（可选）准备E CS 作为gsql客户端主机 购买弹性云服务器的操作步骤，请参见《弹性云服务器快速入门》中的购买并登录Linux弹性云服务器章节。 创建的弹性云服务器需要满足如下要求： 弹性云服务器需要与GaussDB(DWS)集群具有相同的区域、可用区。 如果使用GaussDB(DWS)提供的gsql命令行客户端连接GaussDB(DWS)集群，弹性云服务器的镜像必须满足如下要求： 镜像的操作系统必须是gsql客户端所支持的下列Linux操作系统： “Redhat x86_64”客户端工具支持在以下系统中使用： RHEL 6.4~7.6。 CentOS 6.4~7.4。 EulerOS 2.3。 “SUSE x86_64”客户端工具支持在以下系统中使用： SLES 11.1~11.4。 SLES 12.0~12.3。 “Euler Kunpeng_64”客户端工具支持在以下系统中使用： EulerOS 2.8。 “Stream Euler X86_64”客户端工具支持在以下系统中使用： EulerOS 2.2。 “Stream Euler Kunpeng_64”客户端工具支持在以下系统中使用： EulerOS 2.8。 如果客户端通过内网地址访问集群，请确保创建的弹性云服务器与GaussDB(DWS)集群在同一虚拟私有云里。 虚拟私有云相关操作请参见《虚拟私有云用户指南》中虚拟私有云和子网章节。 如果客户端通过公网地址访问集群，请确保创建的弹性云服务器和GaussDB(DWS)集群都要有弹性IP。 购买弹性云服务器时，参数“弹性公网IP”需选择“现在购买”或“使用已有”。 弹性云服务器对应的安全组规则需要确保能与GaussDB(DWS)集群提供服务的端口网络互通。 安全组相关操作请参见《虚拟私有云用户指南》中安全组章节。 请确认弹性云服务器的安全组中存在符合如下要求的规则，如果不存在，请在弹性云服务器的安全组中添加相应的规则： 方向：出方向 协议：必须包含TCP，例如TCP、全部。 端口：需要包含GaussDB(DWS)集群提供服务的数据库端口，例如，设置为“1-65535”或者具体的GaussDB(DWS)数据库端口。 目的地址：设置的IP地址需要包含所要连接的GaussDB(DWS)集群的连接地址。其中0.0.0.0/0表示任意地址。 图1 出方向的规则 GaussDB(DWS)集群的安全组规则需要确保GaussDB(DWS)能接收来自客户端的网络访问。 请确认GaussDB(DWS)集群的安全组中存在符合如下要求的规则，如果不存在，请在GaussDB(DWS)集群的安全组中添加相应的规则。 方向：入方向 协议：必须包含TCP，例如TCP、全部。 端口：设置为GaussDB(DWS)集群提供服务的数据库端口，例如“8000”。 源地址：设置的IP地址需要包含GaussDB(DWS)客户端主机的IP地址，例如“192.168.0.10/32”。 图2 入方向的规则

示例 数据文件存放在“/data” 目录，IP为192.168.0.90，监听端口为5000。 gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 数据文件存放在“/data/” 目录下的任意子目录，IP为192.168.0.90，监听端口为5000。 gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -r 数据文件存放在“/data/ ”目录，IP为192.168.0.90，监听端口为5000，以后台方式运行，将日志保存在“/log/gds_log.txt”文件中，指定并发导入工作线程数目为32。 gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -l /log/gds_log.txt -D -t 32 数据文件存放在“/data/ ”目录，IP为192.168.0.90，监听端口为5000，只允许IP为10.10.0.*的节点进行连接。 gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 数据文件存放在“/data/ ”目录，IP为192.168.0.90，监听端口为5000，只允许IP为10.10.0.*的节点进行连接，设定为使用SSL认证的方式与集群通信，证书文件存放在/certfiles/目录。 gds -d /data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 --enable-ssl --ssl-dir /certfiles/ 1个GDS在同一时刻，只能为1个集群提供导入导出服务； 为满足安全要求，请通过-p显示指定监听ip和监听端口。 证书文件包括根证书文件cacert.pem，以及二级证书文件client.crt和密钥文件client.key。 在加载证书时，需要使用密码保护文件client.key.rand和client.key.cipher。

概述 dws-connector-flink是在dws-client的基础上对接Flink的一个工具，工具为对dws-client的包装，整体入库能力跟dws-client一致。dws-connector-flink为GaussDB(DWS)团队自研工具，后续将根据GaussDB(DWS)数据库持续优化。 dws-flink-connector的DWS-Connector只支持单并发查询存量数据，暂不支持并行读取。

ODBC驱动 GaussDB(DWS) 也支持开源的ODBC驱动程序：PostgreSQL ODBC 09.01.0200或更高版本。 表5 ODBC驱动下载地址 适用操作系统 下载地址 校验文件 Windows dws_9.1.x_odbc_driver_for_windows.zip dws_9.1.x_odbc_driver_for_windows.zip.sha256 dws_8.2.x_odbc_driver_for_windows.zip dws_8.2.x_odbc_driver_for_windows.zip.sha256 dws_8.1.x_odbc_driver_for_windows.zip dws_8.1.x_odbc_driver_for_windows.zip.sha256 Euler ARM dws_9.1.x_odbc_driver_for_arm_euler.zip dws_9.1.x_odbc_driver_for_arm_euler.zip.sha256 dws_8.2.x_odbc_driver_for_arm_euler.zip dws_8.2.x_odbc_driver_for_arm_euler.zip.sha256 dws_8.1.x_odbc_driver_for_arm_euler.zip dws_8.1.x_odbc_driver_for_arm_euler.zip.sha256 Redhat ARM dws_9.1.x_odbc_driver_for_arm_redhat.zip dws_9.1.x_odbc_driver_for_arm_redhat.zip.sha256 dws_8.2.x_odbc_driver_for_arm_redhat.zip dws_8.2.x_odbc_driver_for_arm_redhat.zip.sha256 dws_8.1.x_odbc_driver_for_arm_redhat.zip dws_8.1.x_odbc_driver_for_arm_redhat.zip.sha256 Redhat x86_64 dws_9.1.x_odbc_driver_for_x86_redhat.zip dws_9.1.x_odbc_driver_for_x86_redhat.zip.sha256 dws_8.2.x_odbc_driver_for_x86_redhat.zip dws_8.2.x_odbc_driver_for_x86_redhat.zip.sha256 dws_8.1.x_odbc_driver_for_x86_redhat.zip dws_8.1.x_odbc_driver_for_x86_redhat.zip.sha256 SUSE x86_64 dws_9.1.x_odbc_driver_for_x86_suse.zip dws_9.1.x_odbc_driver_for_x86_suse.zip.sha256 dws_8.2.x_odbc_driver_for_x86_suse.zip dws_8.1.x_odbc_driver_for_x86_suse.zip.sha256 dws_8.1.x_odbc_driver_for_x86_suse.zip dws_8.1.x_odbc_driver_for_x86_suse.zip.sha256

Data Studio图形界面客户端 表2 Data Studio下载地址 适用操作系统 下载地址 校验文件 Windows x64 Data_Studio_9.1.x_64.zip Data_Studio_9.1.x_64.zip.sha256 Data_Studio_8.2.x_64.zip Data_Studio_8.2.x_64.zip.sha256 Data_Studio_8.1.x_64.zip Data_Studio_8.1.x_64.zip.sha256 Windows x86 Data_Studio_9.1.x_32.zip Data_Studio_9.1.x_32.zip.sha256 Data_Studio_8.2.x_32.zip Data_Studio_8.2.x_32.zip.sha256 Data_Studio_8.1.x_32.zip Data_Studio_8.1.x_32.zip.sha256

JDBC驱动 GaussDB(DWS) 支持开源的JDBC驱动程序：PostgreSQL JDBC驱动程序9.3-1103或更高版本。 表4 JDBC驱动下载地址 驱动名称 下载地址 校验文件 DWS JDBC Driver dws_9.1.x_jdbc_driver.zip dws_9.1.x_jdbc_driver.zip.sha256 dws_8.2.x_jdbc_driver.zip dws_8.2.x_jdbc_driver.zip.sha256 dws_8.1.x_jdbc_driver.zip dws_8.1.x_jdbc_driver.zip.sha256 DWS ARM JDBC Driver dws_euler_kunpeng_jdbc.zip dws_euler_kunpeng_jdbc.zip.sha256

命令行客户端（包含GDS工具包） 表1 gsql下载地址 操作系统类别 适用操作系统版本 下载地址 校验文件 Windows Windows x86_64： Windows 7及以上。 Windows Server 2008及以上。 dws_9.1.x_gsql_for_windows.zip dws_9.1.x_gsql_for_windows.zip.sha256 dws_8.2.x_gsql_for_windows.zip dws_8.2.x_gsql_for_windows.zip.sha256 dws_8.1.x_gsql_for_windows.zip dws_8.1.x_gsql_for_windows.zip.sha256 Redhat x86_64 RHEL 6.4~7.6 dws_client_9.1.x_redhat_x64.zip dws_client_9.1.x_redhat_x64.zip.sha256 dws_client_8.2.x_redhat_x64.zip dws_client_8.2.x_redhat_x64.zip.sha256 dws_client_8.1.x_redhat_x64.zip dws_client_8.1.x_redhat_x64.zip.sha256 SUSE x86_64 SLES 11.1~11.4，SLES 12.0~12.3 dws_client_9.1.x_suse_x64.zip dws_client_9.1.x_suse_x64.zip.sha256 dws_client_8.2.x_suse_x64.zip dws_client_8.2.x_suse_x64.zip.sha256 dws_client_8.1.x_suse_x64.zip dws_client_8.1.x_suse_x64.zip.sha256 Euler Kunpeng_64 EulerOS 2.0 SP8 dws_client_9.1.x_euler_kunpeng_x64.zip dws_client_9.1.x_euler_kunpeng_x64.zip.sha256 dws_client_8.2.x_euler_kunpeng_x64.zip dws_client_8.2.x_euler_kunpeng_x64.zip.sha256 dws_client_8.1.x_euler_kunpeng_x64.zip dws_client_8.1.x_euler_kunpeng_x64.zip.sha256 Redhat Kunpeng_64 CentOS-7.6-aarch64和NeoKylin-7.6-aarch64 (适配鲲鹏920处理器) dws_client_9.1.x_redhat_kunpeng_x64.zip dws_client_9.1.x_redhat_kunpeng_x64.zip.sha256 dws_client_8.2.x_redhat_kunpeng_x64.zip dws_client_8.2.x_redhat_kunpeng_x64.zip.sha256 dws_client_8.1.x_redhat_kunpeng_x64.zip dws_client_8.1.x_redhat_kunpeng_x64.zip.sha256

注意事项 禁止修改导出的文件和内容，否则可能无法恢复成功。 为了保证数据一致性和完整性，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。

注意事项 一个gsql元命令的格式是反斜杠后面紧跟一个动词，然后是任意参数。参数命令动词和其他参数以任意个空白字符间隔。 要在参数里面包含空白，必须用单引号把它引起来。要在这样的参数里包含单引号，可以在前面加一个反斜杠。任何包含在单引号里的内容都会被进一步进行类似C语言的替换：\n（新行）、\t（制表符）、\b（退格）、\r（回车）、\f（换页）、\digits（八进制表示的字符）、\xdigits（十六进制表示的字符）。 用""包围的内容被当做一个命令行传入shell。该命令的输出（删除了结尾的新行）被当做参数值。 如果不带引号的参数以冒号（:）开头，它会被当做一个gsql变量，并且该变量的值最终会成为真正的参数值。 有些命令以一个SQL标识的名称（比如一个表）为参数。这些参数遵循SQL语法关于双引号的规则：不带双引号的标识强制转换成小写，而双引号保护字母不进行大小写转换，并且允许在标识符中使用空白。在双引号中，成对的双引号在结果名字中分析成一个双引号。比如，FOO"BAR"BAZ解析成fooBARbaz；而"A weird"" name"解析成A weird" name。 对参数的分析在遇到另一个不带引号的反斜杠时停止。这里会认为是一个新的元命令的开始。特殊的双反斜杠序列（\\）标识参数的结尾并将继续分析后面的SQL语句（如果存在）。这样SQL和gsql命令可以自由地在一行里面混合。但是在任何情况下，一条元命令的参数不能延续超过行尾。

PATTERN 很多\d命令都可以用一个PATTERN参数来指定要被显示的对象名称。在最简单的情况下，PATTERN正好就是该对象的准确名称。在PATTERN中的字符通常会被变成小写形式（就像在SQL名称中那样），例如\dt FOO将会显示名为foo的表。就像在SQL名称中那样，把PATTERN放在双引号中可以阻止它被转换成小写形式。如果需要在一个PATTERN中包括一个真正的双引号字符，则需要把它写成两个相邻的双引号，这同样是符合SQL引用标识符的规则。例如，\dt "FOO""BAR"将显示名为FOO"BAR（不是foo"bar）的表。和普通的SQL名称规则不同，不能只在PATTERN的一部分周围放上双引号，例如\dt FOO"FOO"BAR将会显示名为fooFOObar的表。 不使用PATTERN参数时，\d命令会显示当前schema搜索路径中可见的全部对象——这等价于用*作为PATTERN。所谓对象可见是指可以直接用名称引用该对象，而不需要用schema来进行限定。要查看数据库中所有的对象而不管它们的可见性，可以把*.*用作PATTERN。 如果放在一个PATTERN中，*将匹配任意字符序列（包括空序列），而?会匹配任意的单个字符（这种记号方法就像 Unix shell 的文件名PATTERN一样）。例如，\dt int*会显示名称以int开始的表。但是如果被放在双引号内，*和?就会失去这些特殊含义而变成普通的字符。 包含一个点号（.）的PATTERN被解释为一个schema名称模式后面跟上一个对象名称模式。例如，\dt foo*.*bar*会显示名称以foo开始的schema中所有名称包括bar的表。如果没有出现点号，那么模式将只匹配当前schema搜索路径中可见的对象。同样，双引号内的点号会失去其特殊含义并且变成普通的字符。 高级用户可以使用字符类等正则表达式记法，如[0-9]可以匹配任意数字。所有的正则表达式特殊字符都按照《开发指南》中的POSIX正则表达式所说的工作。以下字符除外： .会按照上面所说的作为一种分隔符。 *会被翻译成正则表达式记号.*。 ?会被翻译成.。 $则按字面意思匹配。 根据需要，可以通过书写?、(R+|)、(R|)和R?来分别模拟PATTERN字符.、R*和R?。$不需要作为一个正则表达式字符，因为PATTERN必须匹配整个名称，而不是像正则表达式的常规用法那样解释（换句话说，$会被自动地追加到PATTERN上）。如果不希望该PATTERN的匹配位置被固定，可以在开头或者结尾写上*。注意在双引号内，所有的正则表达式特殊字符会失去其特殊含义并且按照其字面意思进行匹配。另外，在操作符名称PATTERN中（即\do的PATTERN参数），正则表达式特殊字符也按照字面意思进行匹配。

示例 启动一个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

下载客户端 表1 gsql下载地址 操作系统类别 适用操作系统版本 下载地址 校验文件 Windows Windows x86_64： Windows 7及以上。 Windows Server 2008及以上。 dws_9.1.x_gsql_for_windows.zip dws_9.1.x_gsql_for_windows.zip.sha256 dws_8.2.x_gsql_for_windows.zip dws_8.2.x_gsql_for_windows.zip.sha256 dws_8.1.x_gsql_for_windows.zip dws_8.1.x_gsql_for_windows.zip.sha256 Redhat x86_64 RHEL 6.4~7.6 dws_client_9.1.x_redhat_x64.zip dws_client_9.1.x_redhat_x64.zip.sha256 dws_client_8.2.x_redhat_x64.zip dws_client_8.2.x_redhat_x64.zip.sha256 dws_client_8.1.x_redhat_x64.zip dws_client_8.1.x_redhat_x64.zip.sha256 SUSE x86_64 SLES 11.1~11.4，SLES 12.0~12.3 dws_client_9.1.x_suse_x64.zip dws_client_9.1.x_suse_x64.zip.sha256 dws_client_8.2.x_suse_x64.zip dws_client_8.2.x_suse_x64.zip.sha256 dws_client_8.1.x_suse_x64.zip dws_client_8.1.x_suse_x64.zip.sha256 Euler Kunpeng_64 EulerOS 2.0 SP8 dws_client_9.1.x_euler_kunpeng_x64.zip dws_client_9.1.x_euler_kunpeng_x64.zip.sha256 dws_client_8.2.x_euler_kunpeng_x64.zip dws_client_8.2.x_euler_kunpeng_x64.zip.sha256 dws_client_8.1.x_euler_kunpeng_x64.zip dws_client_8.1.x_euler_kunpeng_x64.zip.sha256 Redhat Kunpeng_64 CentOS-7.6-aarch64和NeoKylin-7.6-aarch64 (适配鲲鹏920处理器) dws_client_9.1.x_redhat_kunpeng_x64.zip dws_client_9.1.x_redhat_kunpeng_x64.zip.sha256 dws_client_8.2.x_redhat_kunpeng_x64.zip dws_client_8.2.x_redhat_kunpeng_x64.zip.sha256 dws_client_8.1.x_redhat_kunpeng_x64.zip dws_client_8.1.x_redhat_kunpeng_x64.zip.sha256 登录GaussDB(DWS)管理控制台，在左侧导航栏中，单击“连接管理”。 在“gsql命令行客户端”的下拉列表中，选择对应版本的GaussDB(DWS)客户端。 图1 下载客户端 客户端CPU架构要和集群一致，如果集群是X86规格，则也应该选择X86客户端。 Windows gsql包选择下拉列表中的“Windows ”，其中包含32位和64位可执行二进制。 单击“下载”可以下载与8.1.x集群版本匹配的gsql。单击“历史版本”可根据集群版本下载相应版本的gsql。 推荐下载使用与集群版本匹配的gsql工具，即8.1.0及以上版本集群使用8.1.x版本gsql、8.2.0及以上版本集群使用8.2.x版。 表2列出了下载的Linux gsql工具包中的文件和文件夹。 表2 Linux gsql工具包目录及文件说明 文件或文件夹 说明 bin 该文件夹中包含了gsql在Linux中的可执行文件。其中包含了gsql客户端工具、GDS并行数据加载工具以及gs_dump、gs_dumpall和gs_restore工具。 gds 该文件夹中包括了GDS数据服务工具的相关文件，GDS工具用于并行数据加载，可将存储在普通文件系统中的数据文件导入到GaussDB(DWS)数据库中。 lib 该文件夹中包括执行gsql所需依赖的lib库。 sample 该文件夹中包含了以下目录或文件： setup.sh：在使用gsql导入样例数据前所需执行的配置AK/SK访问密钥的脚本文件。 tpcds_load_data_from_obs.sql：使用gsql客户端导入TPC-DS样例数据的脚本文件。 query_sql目录：查询TPC-DS样例数据的脚本文件。 gsql_env.sh 在运行gsql前，配置环境变量的脚本文件。 表3列出了下载的Windows gsql工具包中的文件和文件夹。 表3 Windows gsql工具包目录及文件说明 文件或文件夹 说明 x64 该文件夹中包含了64位Windows gsql执行二进制和动态库。 x86 该文件夹中包含了32位Windows gsql执行二进制和动态库。 在“集群管理”页面的集群列表中，单击指定集群的名称，再选择“集群详情”页签，可查看集群版本。

DWS-Connector版本说明 DWS-Connector版本发布包含：dws-client、dws-connector-flink、dws-flink-ingestion组件，入库相关均使用dws-client作业底层入库组件，版本统一使用dws-client版本号； 当前版本分为1.x和2.x版本，1.x版本将不再引入新的功能，仅对已有功能加固；2.x版本为长期演进版本，由于整体设计做了较大重构，部分功能使用会和1.x版本不兼容。 因此1.x版本短期会持续维护修复重要问题，待2.x稳定使用后将停止演进1.x版本。 表1 版本变更记录 版本 变更描述 备注 1.0 初始化版本。 dws-connector-flink仅发布Scala2.11 Flink 1.12版本 1.0.2 dwsclient优化异常重试逻辑，由所有异常重试修改为只重试：连接异常、数据库只读、超时、连接数过多、加锁异常五类异常。 dws-connector-flink支持版本： Scala2.11： Flink 1.12、1.13 Scala2.12：Flink 1.12、1.13、1.15 1.0.3 已知问题修复与性能优化。 支持update写入场景。 支持使用唯一索引。 由于支持update模式，为避免原dwsClient中upsert接口歧义，故后续统一使用write接口承载写入操作，两接口能力一致推荐使用write。 - 1.0.4 增加SQL执行超时时间，避免长时间阻塞。 - 1.0.5 修复无主键表相同数据写入丢失问题。 - 1.0.6 优化攒缓存逻辑代码性能，提升在CPU不足场景的吞吐。 增加临时表复用，避免在copy merge/upsert场景频繁创建临时表。 copy增加CSV格式，避免在数据复杂时受特殊字符干扰无法正常入库。 - 1.0.7 数据库重启中写入数据失败后支持重试。 增加as方式创建临时表，解决在有主键表无法使用copy merge/upsert的问题。 数据库字段适配为默认大小写不敏感。 Flink SQL增加打印主键参数，用于分析数据缺失时排查问题。 - 1.0.8 修复Flink SQL主键配置必须大小写和数据库一致问题。 增加设置sink并发的参数。 - 1.0.9 优化时间类型入库。 - 1.0.10 修复client并发执行delete和insert，导致有概率先执行insert后执行delete，当同主键数据在同一批缓存中先删除后写入会导致丢数据问题。 修复Kafka写dws链路中偶现写DWS异常后丢数据问题。 新增connector参数ignoreUpdateBefore，部分主要参数兼容flink-connector-jdbc。 - 1.0.11 dws client write接口支持传入schema用于检查数据库字段是否和传入schema一致，如果缺少字段将自动新增字段。 支持配置比较字段，必须满足新数据比数据库值大才会被更新。 flink sql支持逻辑删除。 connector-flink新增 Scala2.12：Flink 1.17 1.1.0 dws client 缓存写入性能优化 - 1.1.0.1 client适配bit类型入库。 client适配nvarchar为null时入库。 - 1.1.0.2 修复问题： 表字段大写报错 当使用upsert入库，如果数据库类型为bigint，但是数据源第一条为int类型，后面为long类型并且超过int范围，报错超过int范围。 - 1.1.0.3 修复问题： 修复表名大写时读取binlog报错。 修复copy模式下源数据带\u0000报错问题。 - 2.0.0-r0~r2 2.x版本初始化： 新增直连DN入库能力。 重构缓存模型，表级别下新增分区级别缓存，每个表中可以有多份缓存，缓存通过分布列映射到不同分区中，可实现并发入库。 client初始化支持properties配置文件方式。 upsert、merge等操作强制要求前一批数据完成后才能执行，保证入库顺序和缓存写入顺序一致。 数据类型的转换迁移至写缓存时，copy、upsert均可生效。 - 2.0.0-r3 若干问题修复，主要包括： flink sql binlog读取时，表名称配置为不存在表导致dws集群连接耗尽。 binlog读取时，表字段、schema大写无法读取问题。 flink sql入库过程中如果dws发生故障，有概率触发单条数据丢失。 功能优化增强： flink sql 及API增加入库时延、入库速度指标。 当无主键但是有唯一索引时可自动获取唯一索引。 jdbc连接增加标签。 时间类型字段转换逻辑增强。 DwsInvokeFunction接口context使用Map接口。 - 父主题： DWS-Connector

说明 场景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转储数据库为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

背景信息 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程序无法压缩已归档导出文件。

参数说明 通用参数： -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 [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

客户端和服务器端SSL连接参数组合情况 客户端最终是否使用SSL加密连接方式、是否验证服务器证书，取决于客户端参数sslmode与服务器端（即GaussDB(DWS)集群侧）参数ssl、require_ssl。参数说明如下： ssl（服务器） ssl参数表示是否开启SSL功能。on表示开启，off表示关闭。 对于集群版本高于1.3.1（包括1.3.1）的集群，默认为on，不支持在GaussDB(DWS)管理控制台上设置。 对于集群版本低于1.3.1的集群，默认为on。ssl参数可通过GaussDB(DWS)管理控制台上集群的“安全设置”页面中的“SSL连接”进行设置。 require_ssl（服务器） require_ssl参数是设置服务器端是否强制要求SSL连接，该参数只有当ssl为on时才有效。on表示服务器端强制要求SSL连接。off表示服务器端对是否通过SSL连接不作强制要求。 对于集群版本高于1.3.1（包括1.3.1）的集群，默认为off。require_ssl参数可通过GaussDB(DWS)管理控制台上集群的“安全设置”页面中的“服务器端是否强制使用SSL连接”进行设置。 对于集群版本低于1.3.1的集群，默认为off，不支持在GaussDB(DWS)管理控制台上设置。 sslmode（客户端） 可在SQL客户端工具中进行设置。 在gsql命令行客户端中，为“PGSSLMODE”参数。 在Data Studio客户端中，为“SSL模式”参数。 客户端参数sslmode与服务器端参数ssl、require_ssl配置组合结果如下： 表3 客户端与服务器端SSL参数组合结果 ssl（服务器） sslmode（客户端） require_ssl（服务器） 结果 on disable on 由于服务器端要求使用SSL，但客户端针对该连接禁用了SSL，因此无法建立连接。 disable off 连接未加密。 allow on 连接经过加密。 allow off 连接未加密。 prefer on 连接经过加密。 prefer off 连接经过加密。 require on 连接经过加密。 require off 连接经过加密。 verify-ca on 连接经过加密，且验证了服务器证书。 verify-ca off 连接经过加密，且验证了服务器证书。 off disable on 连接未加密。 disable off 连接未加密。 allow on 连接未加密。 allow off 连接未加密。 prefer on 连接未加密。 prefer off 连接未加密。 require on 由于客户端要求使用SSL，但服务器端禁用了SSL，因此无法建立连接。 require off 由于客户端要求使用SSL，但服务器端禁用了SSL，因此无法建立连接。 verify-ca on 由于客户端要求使用SSL，但服务器端禁用了SSL，因此无法建立连接。 verify-ca off 由于客户端要求使用SSL，但服务器端禁用了SSL，因此无法建立连接。