Ecological Tools
Doc Menu

Tool Overview

MogDB provides client and server applications (tools) to help users better maintain MogDB. Table 1 lists all the tools provided by MogDB. 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 MogDB 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 multiple Advanced Features for users.
Server tool gs_check gs_check has been enhanced to unify functions of various check tools, such as gs_check and gs_checkos. It helps users fully check MogDB runtime, OS, network, and database running environments; as well as perform comprehensive checks on various environments before major operations in MogDB, ensuring smooth operation.
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 MogDB-level performance (host CPU, Gauss GPU, 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 MogDB load information for users so that they can fine-tune database performance accordingly.
gs_collector When MogDB 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 MogDB database objects without affecting the normal access of users to the database.
gs_guc gs_guc is used to set parameters in MogDB 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_om gs_om, provided by MogDB, helps you maintain MogDB, including starting and stopping MogDB, querying the MogDB status, generating static configuration files, updating dynamic configuration files, replacing SSL certificates, starting and stopping Kerberos authentication, and showing help information and version numbers.
gs_restore gs_restore, provided by MogDB, 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 MogDB, helps users run the same command on multiple nodes in MogDB.