GaussDB 100提供多种工具供用户使用，不同的部署形态支持不同的运维工具。这些应用程序可以帮助用户更好地维护GaussDB 100。
支持工具如表1所示，其中，gs_checkclusterinfo和gs_testclustercuid仅支持分布式部署模式下使用。其中，表1位于安装包解压后的script目录下；其他命令行工具都存放在“/opt/gaussdb/app/bin”目录下（其中“/opt/gaussdb/app”表示GaussDB 100的安装目录），针对GaussDB 100提供的命令行工具，指定工具参数值，不能是空字符串(""或'')，空格字符串(" " 或 ' ')。例如 -U "" 或 -U ' '。
工具名称 | 说明 |
|---|---|
数据库一体机会预置一些配置，GaussDB 100提供了gs_allinone工具修改这些配置。 | |
数据库集群部署成功后，在数据库运行的过程中，会遇到各种问题及异常状态。GaussDB 100提供了gs_backup工具帮助集群备份、恢复二进制文件（即程序安装文件，包括可执行文件和动态链接库）及数据库配置文件（即zhba.conf和zengine.ini）。 | |
gs_check工具帮助用户进行集群运行状态（集群、双机和CM状态）、集群部署巡检项（目录权限、数据库版本、环境变量和参数等）、运行巡检项（连接状态、锁数量、游标数量和连接数量等）、管理数据库对象等选项的检查，以确保数据库处于正常可用状态。 | |
GaussDB 100提供了gs_checkclusterinfo脚本收集集群信息，用于集群升级前后的数据一致性检验。仅支持分布式部署模式下使用。 | |
gs_checkos工具来帮助检查操作系统、控制参数、磁盘配置等内容，并对系统控制参数、I/O配置、网络配置和THP服务等信息进行配置。 | |
GaussDB 100提供了gs_checkperf工具以检查每个DN的CPU、内存使用情况，以便用户根据集群DN的负载情况采取对应的改进措施。 | |
当GaussDB 100集群-发生故障时，使用此工具收集集群的OS信息、日志信息以及集群配置文件信息，来定位问题。 | |
GaussDB 100提供了gs_expand工具来帮助用户在业务发展和数据量变更的情况下，增加副本节点、CN节点或DN组，以满足业务需求。 | |
GaussDB 100提供了gs_gucZenith工具来帮助完成在Online状态下对CN和DN的内核参数设置。 | |
数据库的部署是一个复杂的过程，分布式数据库的安装和部署更是复杂。GaussDB 100提供了gs_install工具来帮助完成集群的安装和部署。 | |
GaussDB 100提供了gs_om工具帮助对集群的运行状态进行监控，包括启动集群、停止集群、启动节点、停止节点、启动单az、查询集群状态、启动etcd、停止etcd、切换主备实例、修改IP、显示帮助信息和显示版本号信息等功能。 | |
当一体机磁盘空间不足，希望增大磁盘空间时，使用插盘扩容，将插入的磁盘挂载到指定目录。 | |
GaussDB 100提供了gs_postuninstall工具来帮助清理准备集群环境阶段所做配置，使得卸载后的环境得到清理。 | |
GaussDB 100提供了gs_preinstall工具来帮助完成集群的环境配置，以保证集群安装的正常进行。 | |
在进行数据搬迁之前，需要在每个安装了逻辑复制工具的节点上使用gs_premigration工具在当前环境上完成一系列准备工作。 | |
数据库集群是由多台服务器组成的，当集群中某些服务器故障或者服务器上的某些实例发生故障后，为了使GaussDB 100快速地恢复正常，用户可以使用gs_replace工具将发生故障的服务器替换为正常服务器，将发生故障的实例替换为正常实例。 | |
GaussDB 100提供了gs_shrink工具来帮助用户删除CN及备DN实例，以及删除非分片模式部署下的节点（一组DN）。 | |
集群在安装过程中，需要在集群中的节点间执行命令，传送文件。因此，安装前需要确保互信是连通的。GaussDB 100提供了gs_sshexkey工具来帮助用户建立互信。 | |
GaussDB 100提供了gs_testclustercuid脚本进行数据库拨测。脚本内部执行数据库DDL和DML等操作，以确定其功能是否正常。仅支持分布式部署模式下使用。 | |
GaussDB 100GaussDB 100提供了gs_uninstall工具来帮助完成集群的卸载。 | |
用户会根据GaussDB 100提供的新特性，确定是否对现有系统进行升级。 | |
数据库集群部署成功后，GaussDB 100提供了gs_wsr工具将DN上的WSR报告统一生成并打包返回。 | |
GaussRoach.py工具是GaussDB 100提供的用于备份和灾难恢复的实用工具。可对整个数据库中的数据、WAL归档日志和运行日志进行备份。 | |
zencrypt工具用于密码加密，增强通讯安全，用户不直接感知。 |
使用python工具时，如果在命令行中长参数输入不完整，工具内部在解析命令时会自动补全参数。例如，“gs_preinstall --h”、“gs_preinstall --he”和“gs_preinstall --help”这三条命令的执行结果是一致的，都可以获取gs_preinstall的帮助信息。
使用python工具时，工具内部会使用import导入一些依赖脚本，使用import导入的脚本会生成对应的pyc文件。例如，在gs_install中使用“import GaussLog”导入GaussLog脚本，则GaussLog脚本所在的路径下会生成GaussLog.pyc文件。*.pyc文件是一个字节码文件，不能直接运行。
使用python工具时，对于只需要指定一次的命令行参数，如果在一条命令中对同一个参数重复指定多次，只有后一次指定的该参数及其参数值生效。例如，在如下命令中， -S参数多次指定，只有后一次指定的-S参数及其参数值 'host * 10.xx.xx.3' 生效。
gs_gucZenith -S 'host * 10.xx.xx.1' -S 'host * 10.xx.xx.2' -S 'host * 10.xx.xx.3'使用短参数时，“-”后面要紧跟参数名不能有空格。如果有参数值，可以使用空格分开参数名和参数值，也可以不分开。-t参数是例外，参数名必须和参数值分开。特别需要注意的是，如果使用“=”连接参数名和参数值，“=”会被解析成参数值的一部分。
使用长参数时，“--”和参数名中间不能有空格。如果有参数值，且参数值需要使用"="连接的，“=”前后都不能有空格。
对于参数值中间有空格的情况，可使用引号将参数值引起来，以免解析错误。
