文档首页/ 云数据库 GaussDB/ 主备版_8.x版本/ gsql/ 获取帮助
更新时间：2024-06-07 GMT+08:00
查看PDF

获取帮助

操作步骤

  • 连接数据库时，可以使用如下命令获取帮助信息。
    gsql --help

    显示如下帮助信息：

    ......
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=<FILE_NAME>      execute commands from file, then exit
......
  • 连接到数据库后，可以使用如下命令获取帮助信息。
    help

    显示如下帮助信息：

    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

任务示例

  1. 连接数据库，具体操作请参考《开发者指南》中“使用数据库入门 > 连接数据库 > 使用gsql连接”章节。
  2. 查看gsql的帮助信息。具体执行命令请参见表1。

    表1 使用gsql联机帮助

    描述

    示例

    查看版权信息

    \copyright

    查看GaussDB支持的SQL语句的帮助

    查看GaussDB支持的SQL语句的帮助

    例如，查看GaussDB支持的所有SQL语句：

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

    例如，查看CREATE DATABASE命令的参数可使用下面的命令：

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    		 
    gaussdb=# \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 ]}[...] ];

    查看gsql命令的帮助

    例如，查看gsql支持的命令：

    1
2
3
4
5
6
7
    		 
    gaussdb=# \?
General
  \copyright             show GaussDB Kernel 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
... ...

父主题： gsql