Help Center/ GaussDB/ Tool Guide(Distributed_2.x)/ Obtaining Help Information
Updated on 2024-06-27 GMT+08:00
View PDF
Share

Obtaining Help Information

Procedure

  • When connecting to the database, run the following command to obtain the help information: 
    gsql --help

    The following help information is displayed:

    ......
Usage:
  gsql [OPTION]... [DBNAME [USERNAME]]

General options:
  -c, --command=COMMAND    run only single command (SQL or internal) and exit
  -d, --dbname=DBNAME      database name to connect to (default: "omm")
  -f, --file=FILENAME      execute commands from file, then exit
......
  • When connecting to the database, run the following command to obtain the help information: 
    help

    The following help information is displayed:

    You are using gsql, the command-line interface to gaussdb.
Type:  \copyright for distribution terms
       \h for help with SQL commands
       \? for help with gsql commands
       \g or terminate with semicolon to execute query
       \q to quit

Examples

  1. Run the following command to connect to the database: 

    gsql -d gaussdb -p 8000

    gaussdb is the name of the database, and 8000 is the port number of the CN.

    If information similar to the following is displayed, the connection succeeds:

    gsql ((GaussDB Kernel VxxxRxxxCxx build 290d125f) compiled at 2020-05-08 02:59:43 commit 2143 last mr 131)
Non-SSL connection (SSL connection is recommended when requiring high-security)
Type "help" for help.

  2. View the gsql help information. For details, see Table 1.

    Table 1 gsql online help

    Description

    Example

    Query the copyright.

    \copyright

    View help information about SQL statements supported by GaussDB.

    View help information about SQL statements supported by GaussDB.

    For example, view all SQL statements supported by GaussDB.

    1
2
3
4
5
6
    		 
    openGauss=# \h
Available help:
  ABORT                            
  ALTER AGGREGATE
  ALTER APP WORKLOAD GROUP                  
... ...

    For example, view parameters of the CREATE DATABASE command:

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    		 
    openGauss=# \help CREATE DATABASE
Command:     CREATE DATABASE
Description: create a new database
Syntax:
CREATE DATABASE database_name
     [ [ WITH ] {[ OWNER [=] user_name ]|
           [ TEMPLATE [=] template ]|
           [ ENCODING [=] encoding ]|
           [ LC_COLLATE [=] lc_collate ]|
           [ LC_CTYPE [=] lc_ctype ]|
           [ DBCOMPATIBILITY [=] compatibility_type ]|
           [ TABLESPACE [=] tablespace_name ]|
           [ CONNECTION LIMIT [=] connlimit ]}[...] ];

    View the help information about gsql commands.

    For example, view commands supported by gsql.

    1
2
3
4
5
6
7
    		 
    openGauss=# \?
General
  \copyright             show openGauss usage and distribution terms
  \g [FILE] or ;         execute query (and send results to file or |pipe)
  \h(\help) [NAME]              help on syntax of SQL commands, * for all commands
  \q                     quit gsql
... ...