gsql工具

gsql是openGauss提供在命令行下运行的数据库连接工具，可以通过此工具连接服务器并对其进行操作和维护，除了具备操作数据库的基本功能，gsql还提供了若干高级特性，便于用户使用。

基本功能

• 连接数据库
• 执行SQL语句
• 执行元命令

高级特性

变量

gsql提供类似于linux的shell命令的变量特性，可以使用gsql的袁明玲\set设置一个变量

\set varname value

删除一个变量

unset varname

说明:

• 变量只是简单的名称/值对，这里的值可以是任意长度。
• 变量名称必须由字母(包括非拉丁字母)、数字和下划线组成，且对大小写敏感。
• 如果使用\set varname的格式，不带第二个参数，则只设置这个变量而没有对这个变量赋值。
• 可以使用不带参数的\set显示所有变量。
• 使用:varname的形式获取变量的值，可以用于sql和元命令。

sql代换

利用gsql的变量特性，可以将常用的sql语句设置为变量，以简化操作。

openGauss=# \set foo 'HR.areaS'
openGauss=# select * from :foo;
 area_id |       area_name        
---------+------------------------
       4 | Middle East and Africa
       3 | Asia
       1 | Europe
       2 | Americas
(4 rows)

执行以上命令，将会查询HR.areaS表。

自定义提示符

gsql使用的提示符支持用户自定义。可以通过修改gsql预留的三个变量PROMPT1、PROMPT2、PROMPT3来改变提示符。这三个变量的值可以用户自定义，也可以使用gsql预定义的值。

• PROMPT1： gsql请求一个新命令时使用的正常提示符。
• PROMPT2： 在一个命令输入期待更多输入时（例如，查询没有用一个分号结束或者引号不完整）显示的提示符。
• PROMPT3： 当执行COPY命令，并期望在终端输入数据时（例如，COPY FROM STDIN），显示提示符。

命令自动补齐

根据openGauss语法规则，gsql支持使用tab键进行命令的自动补齐，当编译时指定了with-readline，且客户端连接时指定"-r"参数，此功能被打开。

说明：

• 支持数据库sql关键字如select、create、table等。
• 支持表明、视图名等自定义标识符的补齐。
• 袁明玲选项'S'、'+'不支持自动补齐。
• 对表进行补齐时，只有前缀时“pg_”才会补齐系统表。
• 不支持建表时字段类型的补齐。
• select后不支持任何补齐。
• 不支持常量与宏的自动补齐。
• select * from a，b... 不支持第二个开始表的自动补齐，insert into t1 (col1, col2, ...)不支持第二个列的自动补齐。
• 不支持create tablespace语句with以及with后参数的自动补齐。
• 创建索引不支持local、 global的自动补齐，修改索引不支持rebuild自动补齐。
• set语句仅支持自动补全user和superuser级别的参数。
• 不支持if exists的自动补齐。
• 不支持表明.列明的自动补齐
• 不支持自定义操作符的自动补齐。使用复制粘贴这种方式输入命令，如果粘贴的命令里面有TAB键有可能会使输入命令的格式错乱，无法正常执行。

客户端操作历史记录

gsql支持客户端操作历史记录，当客户端连接时指定“-r”参数，此功能被打开。可以通过\set设置记录历史的条数，例如，\set HISTSIZE 50，将记录历史的条数设置为50，\set HISTSIZE 0，不记录历史。

说明：

• 客户端操作历史记录条数默认设置为32条，最多支持记录500条。当客户端交互式输入包含中文字符时，只支持UTF-8 的编码环境。
• 出于安全考虑，将包含PASSWORD、IDENTIFIED敏感词的记录识别为敏感信息，不会记录到历史信息中，即不能通过上下翻回显。

常用元命令

连接数据库 使用 -E参数可以显示元命令具体执行的SQL信息

符号	用法
\l	现实数据库中数据库信息
\du同\dg	显示数据库中所有用户和角色
\db	显示数据库中所有表空间信息
\dn	显示数据库中所有schema信息
\d	显示当前数据库下相关数据库对象（包含表、视图、物化视图、序列、外部表、stream、contview）
\d tablename	查看某个表的详细信息
\dt	显示当前数据库中所有的表
\dt+	## 以扩展方式显示当前数据库所有表信息，比起\dt 多了最后一列描述信息
\di	查看当前数据库中索引信息
\di indexname	查看当前数据库某个索引的信息
\dv	查看当前数据库视图信息
\ds	查看当前数据库序列信息
\df	查看当前数据库函数信息
\dx	查看已安装的扩展程序信息
\x [on|off|auto]	设置语句的输出模式，模式为行的方式输出，执行 \x on 切换为以列的方式来显示
\timing [on|off]	控制显示SQL的执行时间，默认为off, on 为显示SQL语句的执行时间
\h	用于获取sql语句的帮助，例如\h merge
?	获取gsql元命令的帮助
!os_command	用于执行操作系统命令
\o filename	用于重定向输出到文件，注意这个不是简单的将屏幕的内容输出到文本，而是将SQL语句正确执行的结果输出到文本
\conninfo	显示gsql中显示会话的连接信息
\c [dbname]	切换数据库
\echo [string]	打印字符串
\q	退出gsql