获取帮助
操作步骤
连接数据库时，可以使用如下命令获取帮助信息。
[gbase@gbasehost ~]$ 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: "gbase")
-f, --file=FILENAME
execute commands from file, then exit
-l, --list
list available databases, then exit
-v, --set=, --variable=NAME=VALUE
set gsql variable NAME to VALUE
-V, --version
output version information, then exit
-X, --no-gsqlrc
do not read startup file (~/.gsqlrc)
-1 ("one"), --single-transaction
execute command file as a single transaction
-?, --help
show this help, then exit
Input and output options:
-a, --echo-all
echo all input from script
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
16
-e, --echo-queries
echo commands sent to server
-E, --echo-hidden
display queries that internal commands generate
-k, --with-key=KEY
the key for decrypting the encrypted file
-L, --log-file=FILENAME
send session log to file
-m, --maintenance
can connect to cluster during 2-pc transaction
recovery
-n, --no-libedit
disable enhanced command line editing (libedit)
-o, --output=FILENAME
send query results to file (or |pipe)
-q, --quiet
run quietly (no messages, only query output)
-C, --enable-client-encryption
enable client encryption feature
-s, --single-step
single-step mode (confirm each query)
-S, --single-line
single-line mode (end of line terminates SQL command)
Output format options:
-A, --no-align
unaligned table output mode
-F, --field-separator=STRING
set field separator (default: "|")
-H, --html
HTML table output mode
-P, --pset=VAR[=ARG]
set printing option VAR to ARG (see \pset command)
-R, --record-separator=STRING
set record separator (default: newline)
-r
if this parameter is set,use libedit
-t, --tuples-only
print rows only
-T, --table-attr=TEXT
set HTML table tag attributes (e.g., width, border)
-x, --expanded
turn on expanded table output
-z, --field-separator-zero
set field separator to zero byte
-0, --record-separator-zero
set record separator to zero byte
-2, --pipeline
use pipeline to pass the password, forbidden to use
in terminal
must use with -c or -f
Connection options:
-h, --host=HOSTNAME
database server host or socket directory (default:
"/home/gbase/gbase_db/tmp")
-p, --port=PORT
database server port (default: "5432")
-U, --username=USERNAME
database user name (default: "gbase")
-W, --password=PASSWORD
the password of specified database user
For more information, type "\?" (for internal commands) or "\help" (for SQL
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
17
commands) from within gsql, or consult the gsql section in the GaussDB Kernel
documentation.
连接到数据库后，可以使用如下命令获取帮助信息。
gbase=# 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 -d postgres -p 5432
连接成功后，系统显示类似如下信息：
gsql ((multiple_nodes GBase8cV5 3.0.0B52 build 0b9407bc) compiled at 2022-11-18
16:09:02 commit 0 last mr 874 )
Non-SSL connection (SSL connection is recommended when requiring high-security)
Type "help" for help.
步骤2 查看gsql 的帮助信息。具体执行命令请参见表2-6。
表2-6 使用gsql 联机帮助
描述
示例
查看版权信息
gbase=# \copyright
查看GBase 8c 支持的
SQL 语句的帮助
查看GBase 8c 支持的SQL 语句的帮助
例如，查看所有支持的SQL 语句：
gbase=# \h
例如，查看CREATE DATABASE 命令的参数可使用下面的命令：
gbase=# \help CREATE DATABASE
查看gsql 命令的帮助
例如，查看gsql 支持的命令：
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
18
gbase=# \?