Tool Overview

openGauss provides client and server applications (tools) to help users better maintain openGauss. Table 1 lists all the tools provided by openGauss. The tools are stored in $GPHOME/script and $GAUSSHOME/bin where database servers are installed.

Table 1 Tool overview

Category	Name	Description
Client tool	gsql	gsql is a database connection tool provided by openGauss and runs in the command-line interface (CLI). Users can use gsql to connect to a server and perform operations and maintenance on the server. In addition to basic functions for performing operations on a database, gsql provides several advanced features for users.
Server tool	gs_cgroup	gs_cgroup is a load management tool provided by openGauss. It can create default Cgroups and user-defined Cgroups, delete default and user-defined Cgroups, update resource quotas and limits, display the configuration files of Cgroups and the Cgroup tree, and delete all Cgroups.
	gs_check	gs_check has been enhanced to incorporate various check tools, such as gs_check and gs_checkos. It helps users fully check openGauss runtime, OS, network, and database running environments, as well as perform comprehensive checks on various environments before major operations in openGauss, ensuring smooth operations.
	gs_checkos	gs_checkos checks OS information, control parameters, and disk configurations, and configures control parameters, I/O parameters, network parameters, and THP services.
	gs_checkperf	gs_checkperf routinely checks openGauss-level performance (host CPU, Gauss CPU, and I/O usage), node-level performance (CPU, memory, and I/O usage), session-/process-level performance (CPU, memory, and I/O usage), and SSD performance (read and write performance). It provides openGauss load information for users so that they can fine-tune database performance accordingly.
	gs_collector	When openGauss is faulty, gs_collector collects OS information, log information, and configuration file information to locate the fault.
	gs_dump	gs_dump exports database information. It can export complete, consistent data of database objects (such as databases, schemas, tables, and views) without affecting the normal access of users to the databases.
	gs_dumpall	gs_dumpall exports database information. It can export complete, consistent data of openGauss without affecting the normal access of users to the database.
	gs_guc	gs_guc is used to set parameters in openGauss configuration files (postgresql.conf or pg_hba.conf). The default parameter values in a configuration file are consistent with those for a standalone database.
	gs_encrypt	gs_encrypt is used to encrypt entered plaintext strings.
	gs_om	gs_om, provided by openGauss, helps you maintain openGauss, including starting and stopping openGauss, querying the openGauss status, generating static configuration files, updating dynamic configuration files, replacing SSL certificates, starting and stopping Kerberos authentication, and displaying help information and version numbers.
	gs_plan_simulator	gs_plan_simulator collects data related to execution plans and reproduces execution plans in other environments to locate execution plan problems.
	gs_restore	gs_restore, provided by openGauss, is used to import data that was exported using gs_dump. It can also be used to import files exported by gs_dump.
	gs_ssh	gs_ssh, provided by openGauss, helps users run the same command on multiple nodes in openGauss.
	gs_sdr	openGauss gs\_sdr, provided by openGauss, implements cross-region remote DR without using additional storage media. The tool provides functions such as streaming DR establishment, DR switchover, planned primary/standby switchover, DR removal, DR status monitoring, and displaying the help information and version number.