CNDBA社区
1 工具路径
openGauss在安装之后会提供客户端和服务器端工具，用以维护 openGauss。工具位于安装数据库服务器的$GPHOME/script和$GAUSSHOME/bin路径下。
[dave@www.cndba.cn bin]# pwd
/data/openGauss/install/app/bin
[dave@www.cndba.cn bin]# ll
total 243996
-rwx------ 1 omm dbgrp 203 Jan 10 22:41 alarmConfig.conf
-rw------- 1 omm dbgrp 7352 Feb 19 16:37 alarmItem.conf
-rw------- 1 omm dbgrp 51101 Jan 10 22:50 cluster_guc.conf
-rw------- 1 omm dbgrp 0 Feb 19 16:37 cluster_manual_start
-rw------- 1 omm dbgrp 40960 Feb 19 16:37 cluster_static_config
-rwx------ 1 omm dbgrp 529944 Jan 10 22:52 cm_agent
-rwx------ 1 omm dbgrp 512280 Jan 10 22:52 cm_ctl
-rwx------ 1 omm dbgrp 695800 Jan 10 22:52 cm_server
drwx------ 11 omm dbgrp 4096 Jan 10 22:49 dbmind
-rwx------ 1 omm dbgrp 85088 Jan 10 22:49 encrypt
-rwx------ 1 omm dbgrp 133405368 Jan 10 22:49 gaussdb
-rwx------ 1 omm dbgrp 175152 Jan 10 22:49 gs_basebackup
-rwx------ 1 omm dbgrp 178800 Jan 10 22:49 gs_cgroup
-rwx------ 1 omm dbgrp 376800 Jan 10 22:49 gs_ctl
-rwx------ 1 omm dbgrp 3794 Jan 10 22:49 gs_dbmind
-rwx------ 1 omm dbgrp 605200 Jan 10 22:49 gs_dump
-rwx------ 1 omm dbgrp 256504 Jan 10 22:49 gs_dumpall
lrwxrwxrwx 1 omm dbgrp 7 Jan 10 22:49 gs_encrypt -> gaussdb
-rwx------ 1 omm dbgrp 290528 Jan 10 22:49 gs_guc
-rwx------ 1 omm dbgrp 205248 Jan 10 22:49 gs_initdb
-rwx------ 1 omm dbgrp 30468 Jan 10 22:49 gs_plan_simulator.sh
-rwx------ 1 omm dbgrp 479752 Jan 10 22:49 gs_probackup
-rwx------ 1 omm dbgrp 747872 Jan 10 22:49 gsql
-rwx------ 1 omm dbgrp 305400 Jan 10 22:49 gs_restore
lrwxrwxrwx 1 omm dbgrp 13 Jan 10 22:49 gs_tar -> gs_basebackup
-rwx------ 1 omm dbgrp 123904 Jan 10 22:49 gstrace
-rwx------ 1 omm dbgrp 120936 Jan 10 22:49 kadmind
-rwx------ 1 omm dbgrp 100480 Jan 10 22:49 kadmin.local
-rwx------ 1 omm dbgrp 117944 Jan 10 22:49 kdb5_util
-rwx------ 1 omm dbgrp 14280 Jan 10 22:49 kdestroy
-rwx------ 1 omm dbgrp 30672 Jan 10 22:49 kinit
-rwx------ 1 omm dbgrp 30664 Jan 10 22:49 klist
-rwx------ 1 omm dbgrp 186632 Jan 10 22:49 krb5kdc
-rwx------ 1 omm dbgrp 288800 Jan 10 22:49 lz4
-rwx------ 1 omm dbgrp 236208 Jan 10 22:52 om_monitor
-rwx------ 1 omm dbgrp 105467379 Feb 19 16:33 openGauss-Package-bak_46134f73.tar.gz
-rwx------ 1 omm dbgrp 3690864 Jan 10 22:49 openssl
-rwx------ 1 omm dbgrp 71856 Jan 10 22:49 pg_config
-rwx------ 1 omm dbgrp 80048 Jan 10 22:49 pg_controldata
-rwx------ 1 omm dbgrp 117600 Jan 10 22:49 pg_recvlogical
-rwx------ 1 omm dbgrp 96432 Jan 10 22:49 pg_resetxlog
-rw------- 1 omm dbgrp 126 Jan 10 22:49 retry_errcodes.conf
drwx------ 10 omm dbgrp 4096 Feb 19 16:37 script
-rw------- 1 omm dbgrp 56 Feb 19 16:37 server.key.cipher
-rw------- 1 omm dbgrp 24 Feb 19 16:37 server.key.rand
-rwx------ 1 omm dbgrp 6603 Jan 10 22:52 transfer.py
-rw------- 1 omm dbgrp 22 Feb 19 16:37 upgrade_version
[dave@www.cndba.cn bin]# cd script/
[dave@www.cndba.cn script]# pwd
/data/openGauss/install/app/bin/script
[dave@www.cndba.cn script]# ll
total 292
drwx------ 3 omm dbgrp 171 Feb 19 16:31 base_diff
drwx------ 8 omm dbgrp 146 Feb 19 16:31 base_utils
drwx------ 2 omm dbgrp 65 Jan 10 22:52 config
drwx------ 8 omm dbgrp 170 Feb 19 16:31 domain_utils
-rwx------ 1 omm dbgrp 8916 Jan 10 22:52 gs_backup
-rwx------ 1 omm dbgrp 65239 Jan 10 22:52 gs_check
-rwx------ 1 omm dbgrp 11131 Jan 10 22:52 gs_checkperf
-rwx------ 1 omm dbgrp 16485 Jan 10 22:52 gs_collector
-rwx------ 1 omm dbgrp 14714 Jan 10 22:52 gs_dropnode
-rwx------ 1 omm dbgrp 12400 Jan 10 22:52 gs_install
-rwx------ 1 omm dbgrp 33165 Jan 10 22:52 gs_om
drwx------ 12 omm dbgrp 217 Feb 19 16:31 gspylib
-rwx------ 1 omm dbgrp 4041 Jan 10 22:52 gs_sdr
-rwx------ 1 omm dbgrp 9048 Jan 10 22:52 gs_ssh
-rwx------ 1 omm dbgrp 55108 Jan 10 22:52 gs_sshexkey
-rwx------ 1 omm dbgrp 6347 Jan 10 22:52 gs_uninstall
-rwx------ 1 omm dbgrp 19461 Jan 10 22:52 gs_upgradectl
drwx------ 15 omm dbgrp 314 Feb 19 16:31 impl
-rwx------ 1 omm dbgrp 0 Jan 10 22:52 __init__.py
-rwx------ 1 omm dbgrp 6110 Jan 10 22:52 killall
drwx------ 2 omm dbgrp 4096 Jan 10 22:52 local
drwx------ 3 omm dbgrp 240 Feb 19 16:31 os_platform
-rwx------ 1 omm dbgrp 3853 Jan 10 22:52 py_pstree.py
[dave@www.cndba.cn script]#
OpenGauss 不同版本的工具会有一些出入，本文描述的工具是OpenGauss 3.0.0 版本中的工具清单。
openGauss 版本编号 和 生命周期 说明
https://www.cndba.cn/dave/article/116445
2 客户端工具
gsql
gsql是openGauss提供在命令行下运行的数据库连接工具，可以通过此工具连接服务器并对其进行操作和维护，除了具备操作数据库的基本功能，gsql还提供了若干高级特性，便于用户使用。
gs_loader
gs_loader工具用于进行数据导入。gs_loader将控制文件支持的语法转换为/COPY语法，然后利用已有的/COPY功能，做主要数据导入工作，同时gs_loader将/COPY结果记录到日志中。
3 服务端工具
gs_cgroup
gs_cgroup是openGauss提供的负载管理工具。负责创建默认控制组、创建用户自定义控制组、删除用户自定义控制组、更新用户自定义组的资源配额和资源限额、显示控制组配置文件内容、显示控制组树形结构和删除用户的所有控制组。
gs_check
gs_check改进增强，统一化当前系统中存在的各种检查工具，例如gs_check、gs_checkos等，帮助用户在openGauss运行过程中，全量的检查openGauss运行环境，操作系统环境，网络环境及数据库执行环境，也有助于在openGauss重大操作之前对各类环境进行全面检查，有效保证操作执行成功。
gs_checkos
gs_checkos用于检查操作系统、控制参数、磁盘配置等内容，并对系统控制参数、I/O配置、网络配置和THP服务等信息进行配置。
gs_checkperf
gs_checkperf工具可定期对openGauss级别（主机CPU占用率、Gauss CPU占用率、I/O使用情况等）、节点级别（CPU使用情况、内存使用情况、I/O使用情况）、会话/进程级别（CPU使用情况、内存使用情况、I/O使用情况）、SSD性能（写入、读取性能）进行检查，让用户了解openGauss的负载情况，采取对应的改进措施。
gs_collector
gs_collector在openGauss发生故障时，收集OS信息、 日志信息以及配置文件信息，来定位问题。
gs_dump
gs_dump是一款用于导出数据库相关信息的工具，支持导出完整一致的数据库对象（数据库、模式、表、视图等）数据，同时不影响用户对数据库的正常访问。
gs_dumpall
gs_dumpall是一款用于导出数据库相关信息的工具， 支持导出完整一致的openGauss数据库所有数据，同时不影响用户对数据库的正常访问。
gs_guc
gs_guc用于设置openGauss配置文件（“postgresql.conf”、“pg_hba.conf”）中的参
数，配置文件中参数的默认值是单机的配置模式，您可以使用gs_guc来设置适合的参数值。
gs_encrypt
gs_encrypt是一款用于为输入的明文字符串进行加密操作。
gs_om
openGauss提供了gs_om工具帮助对openGauss进行维护，包括启动openGauss、停止openGauss、查询openGauss状态、生成静态配置文件、刷新动态配置文件、SSL证书替换、启停kerberos认证、显示帮助信息和显示版本号信息的功能。
gs_plan_simulator
gs_plan_simulator工具用于收集与执行计划相关的数据并能够在其它环境上进行执行计划的复现，从而定位执行计划类相关问题。
gs_restore
gs_restore是openGauss提供的针对gs_dump导出数据的导入工具。通过此工具可由gs_dump生成的导出文件进行导入。
gs_ssh
openGauss提供了gs_ssh工具帮助用户在openGauss各节点上执行相同的命令。
版权声明：本文为博主原创文章，未经博主允许不得转载。
