openGuass之工具简述

---

前言

openGauss提供客户端和服务器端应用程序（工具），帮助用户更好地维护openGauss。

客户端工具：数据库在部署成功后，需要通过一些工具来便捷地连接数据库，对数据库进行各种操
作和调试。openGauss提供了一些数据库连接工具。通过这些工具可以方便地连接数
据库并对数据库进行数据操作。

服务端工具：在使用openGauss过程中，经常需要对openGauss进行安装、卸载以及健康管理。为
了简单、方便的维护openGauss，openGauss提供了一系列的管理工具。

---

一、工具一览表

二、客户端工具

1.gsql

gsql基本功能

• 连接数据库
• 执行SQL语句：支持交互式地键入并执行SQL语句，也可以执行一个文件中指定的
  SQL语句。
• 执行元命令：元命令可以帮助管理员查看数据库对象的信息、查询缓存区信息、
  格式化SQL输出结果，以及连接到新的数据库等。

三.用户端工具

1.gs_check

背景信息

gs_check改进增强，统一化当前系统中存在的各种检查工具，例如gs_check，gs_checkos等，帮助用户在openGauss运行过程中，全量的检查openGauss运行环境，操作系统环境，网络环境及数据库执行环境，也有助于在openGauss重大操作之前对各类环境进行全面检查，有效保证操作执行成功。

2. gs_checkos

背景信息

gs_checkos工具来帮助检查操作系统、控制参数、磁盘配置等内容，并对系统控制参数、I/O配置、网络配置和THP服务等信息进行配置。

3.gs_checkperf

背景信息

openGauss提供了gs_checkperf工具来帮助对openGauss级别（主机CPU占用率、Gauss CPU占用率、I/O使用情况等）、节点级别（CPU使用情况、内存使用情况、I/O使用情况）、会话/进程级别（CPU使用情况、内存使用情况、I/O使用情况）、SSD性能（写入、读取性能）进行定期检查，让用户了解openGauss的负载情况，采取对应的改进措施。

4.gs_clean

背景信息

数据库异常宕机后可能会有临时表残留，gs_clean可以用来清理残留的临时表。

5.gs_collector

背景信息

当openGauss发生故障时，使用此工具收集OS信息、日志信息以及配置文件等信息，来定位问题。

6.gs_dump

背景信息

gs_dump是openGauss用于导出数据库相关信息的工具，用户可以自定义导出一个数据库或其中的对象（模式、表、视图等）。支持导出的数据库可以是默认数据库postgres，也可以是自定义数据库。
gs_dump工具由操作系统用户omm执行。
gs_dump工具在进行数据导出时，其他用户可以访问openGauss数据库（读或写）。
gs_dump工具支持导出完整一致的数据。例如，T1时刻启动gs_dump导出A数据库，那么导出数据结果将会是T1时刻A数据库的数据状态，T1时刻之后对A数据库的修改不会被导出。
gs_dump支持将数据库信息导出至纯文本格式的SQL脚本文件或其他归档文件中。

• 纯文本格式的SQL脚本文件：包含将数据库恢复为其保存时的状态所需的SQL语句。通过gsql运行该SQL脚本文件，可以恢复数据库。即使在其他主机和其他数据库产品上，只要对SQL脚本文件稍作修改，也可以用来重建数据库。
• 归档格式文件：包含将数据库恢复为其保存时的状态所需的数据，可以是tar格式、目录归档格式或自定义归档格式。该导出结果必须与gs_restore配合使用来恢复数据库，gs_restore工具在导入时，系统允许用户选择需要导入的
  内容，甚至可以在导入之前对等待导入的内容进行排序。

7.gs_dumpall

背景信息

gs_dumpall是openGauss用于导出所有数据库相关信息工具，它可以导出openGauss数据库的所有数据，包括默认数据库postgres的数据、自定义数据库的数据、以及openGauss所有数据库公共的全局对象。
gs_dumpall工具由操作系统用户omm执行。
gs_dumpall工具在进行数据导出时，其他用户可以访问openGauss数据库（读或写）。
gs_dumpall工具支持导出完整一致的数据。例如，T1时刻启动gs_dumpall导出openGauss数据库，那么导出数据结果将会是T1时刻该openGauss数据库的数据状态，T1时刻之后对openGauss的修改不会被导出。
gs_dumpall在导出openGauss所有数据库时分为两部分：

• gs_dumpall自身对所有数据库公共的全局对象进行导出，包括有关数据库用户和组，表空间以及属性（例如，适用于数据库整体的访问权限）信息。

• gs_dumpall通过调用gs_dump来完成openGauss中各数据库的SQL脚本文件导出，该脚本文件包含将数据库恢复为其保存时的状态所需要的全部SQL语句。
  以上两部分导出的结果为纯文本格式的SQL脚本文件，使用gsql运行该脚本文件可以恢复openGauss数据库。

8.gs_guc

背景信息

目前openGauss配置文件（“postgresql.conf”、“pg_hba.conf”）中的参数默认值都是单机的配置模式。应用程序可以通过调用gs_guc来设置适合自己的参数。gs_guc工具由操作系统用户omm执行。

• “gs_guc-current.log”
  这个文件记录gs_guc产生的日志。
  默认路径：$GAUSSLOG/bin/gs_guc。
• “gs_guc-年-月-日_HHMMSS.log”
  当“gs_guc-current.log”文件大小满16M后，会根据当前时刻生成一个备份文件。
• “server.key.cipher”，“server.key.rand”
  使用gs_guc encrypt命令加密用户密码时，如果指定的-M的值为server，则会生成这两个文件。其中“server.key.cipher”存储用户密码的密文，“server.key.rand”存储的是加密因子。
• client.key.cipher”，“client.key.rand”
  使用gs_guc encrypt命令加密用户密码时，如果指定的-M的值为client，则会生成这两个文件。其中“client.key.cipher”存储用户密码的文，“client.key.rand”存储的是加密因子。

9. gs_om

背景信息

openGauss提供了gs_om工具帮助对openGauss进行维护，包括启动openGauss、停止openGauss、查询openGauss状态、查询静态配置、生成静态配置文件、查询openGauss状态详细信息、生成动态配置文件、SSL证书替换、显示帮助信息和显示版本号信息等功能。

10. gs_restore

背景信息

gs_restore是openGauss提供的针对gs_dump导出数据的导入工具。通过此工具可由gs_dump生成的导出文件进行导入。
gs_restore工具由操作系统用户omm执行。
主要功能包含：

• 导入到数据库
  如果连接参数中指定了数据库，则数据将被导入到指定的数据库中。其中，并行
  导入必须指定连接的密码。
• 导入到脚本文件
  如果未指定导入数据库，则创建包含重建数据库所必须的SQL语句脚本并写入到
  文件或者标准输出。等效于直接使用gs_dump导出为纯文本格式。

11. gs_ssh

背景信息

openGauss提供了gs_ssh工具帮助用户在openGauss各节点上执行相同的命令。

---