變量

gsql提供類似于Linux的shell命令的變量特性，可以使用gsql的元命令\set設(shè)置一個(gè)變量，格式如下：

\set varname value

刪除由\set命令設(shè)置的變量請(qǐng)使用如下方式：

\unset varname

說(shuō)明

變量只是簡(jiǎn)單的名稱/值對(duì)，這里的值可以是任意長(zhǎng)度。

變量名稱必須由字母（包括非拉丁字母）、數(shù)字和下劃線組成，且對(duì)大小寫敏感。

如果使用\set varname的格式（不帶第二個(gè)參數(shù)），則只是設(shè)置這個(gè)變量而沒(méi)有給變量賦值。

可以使用不帶參數(shù)的\set來(lái)顯示所有變量的值。變量的示例和詳細(xì)說(shuō)明請(qǐng)參見(jiàn)變量。

SQL代換

利用gsql的變量特性，可以將常用的SQL語(yǔ)句設(shè)置為變量，以簡(jiǎn)化操作。

SQL代換的示例和詳細(xì)說(shuō)明請(qǐng)參見(jiàn)SQL代換。

自定義提示符

gsql使用的提示符支持用戶自定義。可以通過(guò)修改gsql預(yù)留的三個(gè)變量PROMPT1、PROMPT2、PROMPT3來(lái)改變提示符。

這三個(gè)變量的值可以用戶自定義，也可以使用gsql預(yù)定義的值。詳細(xì)請(qǐng)參見(jiàn)提示符。

客戶端操作歷史記錄

gsql支持客戶端操作歷史記錄，當(dāng)客戶端連接時(shí)指定“-r”參數(shù)，此功能被打開(kāi)?？梢酝ㄟ^(guò)\set設(shè)置記錄歷史的條數(shù)，例如，\set HISTSIZE 50，將記錄歷史的條數(shù)設(shè)置為50，\set HISTSIZE 0，不記錄歷史。

說(shuō)明

1.客戶端操作歷史記錄條數(shù)默認(rèn)設(shè)置為32條，最多支持記錄500條。當(dāng)客戶端交互式輸入包含中文字符時(shí)，只支持UTF-8 的編碼環(huán)境。

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等字符串（不區(qū)分大小寫）的SQL語(yǔ)句記錄識(shí)別為包含敏感信息的語(yǔ)句，不會(huì)記錄到歷史信息中，即不能通過(guò)上下翻回顯。

PROMPT1

gsql請(qǐng)求一個(gè)新命令時(shí)使用的正常提示符。

PROMPT1的默認(rèn)值為：

%/%R%#

使用變量PROMPT1切換提示符：

l提示符變?yōu)閇local]：

openGauss=> \set PROMPT1 %M

[local:/tmp/gaussdba_mppdb]

l提示符變?yōu)閚ame：

openGauss=> \set PROMPT1 name

name

l提示符變?yōu)?：

openGauss=> \set PROMPT1 %R

=

PROMPT2

在一個(gè)命令輸入期待更多輸入時(shí)（例如，查詢沒(méi)有用一個(gè)分號(hào)結(jié)束或者引號(hào)不完整）顯示的提示符。

使用變量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

當(dāng)執(zhí)行COPY命令，并期望在終端輸入數(shù)據(jù)時(shí)（例如，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，則由此參數(shù)控制wrapped格式的寬度。這個(gè)寬度用于決定在自動(dòng)擴(kuò)展的模式下，是否要把寬輸出模式變成豎線的格式。

PAGER

如果查詢結(jié)果無(wú)法在一頁(yè)顯示，它們就會(huì)被重定向到這個(gè)命令?？梢杂肻pset命令關(guān)閉分頁(yè)器。典型的是用命令more或less來(lái)實(shí)現(xiàn)逐頁(yè)查看。缺省值是平臺(tái)相關(guān)的。

說(shuō)明：less的文本顯示，受系統(tǒng)環(huán)境變量LC_CTYPE影響。

PSQL_EDITOR

\e和\ef命令使用環(huán)境變量指定的編輯器。變量是按照列出的先后順序檢查的。在Unix系統(tǒng)上默認(rèn)的編輯工具是vi。

EDITOR

VISUAL

PSQL_EDITOR_LINENUMBER_ARG

當(dāng)\e和\ef帶上一行數(shù)字參數(shù)使用時(shí)，這個(gè)變量指定的命令行參數(shù)用于向編輯器傳遞起始行數(shù)。像Emacs或vi這樣的編輯器，這只是個(gè)加號(hào)。如果選項(xiàng)和行號(hào)之間需要空白，在變量的值后加一個(gè)空格。例如：

PSQL_EDITOR_LINENUMBER_ARG = '+'  

PSQL_EDITOR_LINENUMBER_ARG='--line '

Unix系統(tǒng)默認(rèn)的是+。

PSQLRC

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

SHELL

使用\!命令跟shell執(zhí)行的命令是一樣的效果。

TMPDIR

存儲(chǔ)臨時(shí)文件的目錄。缺省是/tmp。