变量

gsql提供类似于Linux的shell命令的变量特性，可以使用gsql的元命令\set设置一个变量，格式如下：

\set varname value

删除由\set命令设置的变量请使用如下方式：

\unset varname

说明

变量只是简单的名称/值对，这里的值可以是任意长度。

变量名称必须由字母（包括非拉丁字母）、数字和下划线组成，且对大小写敏感。

如果使用\set varname的格式（不带第二个参数），则只是设置这个变量而没有给变量赋值。

可以使用不带参数的\set来显示所有变量的值。变量的示例和详细说明请参见变量。

SQL代换

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

SQL代换的示例和详细说明请参见SQL代换。

自定义提示符

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

这三个变量的值可以用户自定义，也可以使用gsql预定义的值。详细请参见提示符。

客户端操作历史记录

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

说明

1.客户端操作历史记录条数默认设置为32条，最多支持记录500条。当客户端交互式输入包含中文字符时，只支持UTF-8 的编码环境。

2.出于安全考虑，将包含PASSWORD、IDENTIFIED、GS_ENCRYPT_AES128、GS_DECRYPT_AES128、GS_ENCRYPT、GS_DECRYPT、PG_CREATE_PHYSICAL_REPLICATION_SLOT_EXTERN、SECRET_ACCESS_KEY、SECRETKEY、CREATE_CREDENTIAL等字符串（不区分大小写）的SQL语句记录识别为包含敏感信息的语句，不会记录到历史信息中，即不能通过上下翻回显。

PROMPT1

gsql请求一个新命令时使用的正常提示符。

PROMPT1的默认值为：

%/%R%#

使用变量PROMPT1切换提示符：

l提示符变为[local]：

openGauss=> \set PROMPT1 %M

[local:/tmp/gaussdba_mppdb]

l提示符变为name：

openGauss=> \set PROMPT1 name

name

l提示符变为=：

openGauss=> \set PROMPT1 %R

=

PROMPT2

在一个命令输入期待更多输入时（例如，查询没有用一个分号结束或者引号不完整）显示的提示符。

使用变量PROMPT2显示提示符：

openGauss=# \set PROMPT2 TEST

openGauss=# select * from HR.areaS TEST;

 area_id |      area_name    

---------+--------------------

      1 | Europe

      2 | Americas

      4 | Middle East and Africa

      3 | Asia

(4 rows))

PROMPT3

当执行COPY命令，并期望在终端输入数据时（例如，COPY FROM STDIN），显示提示符。

使用变量PROMPT3显示COPY提示符：

openGauss=# \set PROMPT3 '>>>>'

openGauss=# copy HR.areaS from STDIN;

Enter data to be copied followed by a newline.

End with a backslash and a period on a line by itself.

>>>>1 aa

>>>>2 bb

>>>>\.

COLUMNS

如果\set columns为0，则由此参数控制wrapped格式的宽度。这个宽度用于决定在自动扩展的模式下，是否要把宽输出模式变成竖线的格式。

PAGER

如果查询结果无法在一页显示，它们就会被重定向到这个命令。可以用\pset命令关闭分页器。典型的是用命令more或less来实现逐页查看。缺省值是平台相关的。

说明：less的文本显示，受系统环境变量LC_CTYPE影响。

PSQL_EDITOR

\e和\ef命令使用环境变量指定的编辑器。变量是按照列出的先后顺序检查的。在Unix系统上默认的编辑工具是vi。

EDITOR

VISUAL

PSQL_EDITOR_LINENUMBER_ARG

当\e和\ef带上一行数字参数使用时，这个变量指定的命令行参数用于向编辑器传递起始行数。像Emacs或vi这样的编辑器，这只是个加号。如果选项和行号之间需要空白，在变量的值后加一个空格。例如：

PSQL_EDITOR_LINENUMBER_ARG = '+'  

PSQL_EDITOR_LINENUMBER_ARG='--line '

Unix系统默认的是+。

PSQLRC

用户的.gsqlrc文件的交互位置。

SHELL

使用\!命令跟shell执行的命令是一样的效果。

TMPDIR

存储临时文件的目录。缺省是/tmp。