Arch manual pages

PSQL(1) PostgreSQL Client Applications PSQL(1)

psql - PostgreSQL 交互終端

psql [option...] [dbname [username]]

psql 是一個以終端爲基礎的 PostgreSQL 前端。它允許你交互地鍵入查詢,把它們發出給 PostgreSQL, 然後看看查詢的結果。另外,輸入可以來自一個文件。還有, 它提供了一些元命令和多種類 shell 地特性來實現書寫腳本以及對大量任務的自動化。

-a
--echo-all
在讀取行時向屏幕打印所有內容。 這個選項在腳本處理時比交互模式時更有用。這個選項等效於設置變量 ECHO 爲 all。
-A
--no-align
切換爲非對齊輸出模式。(缺省輸出模式是對齊的。)
-ccommand
--commandcommand
聲明 psql 將執行一條查詢字串, command,然後退出。這一點在 shell 腳本里很有用。 command 必須是一條完全可以被服務器分析的查詢字串(也就是說,它不包含 psql特有的特性), 或者是一個反斜槓命令。這樣你就不會混合 SQL 和 psql 元命令。要想混合使用,你可以把字串定向到psql 裏,象這樣: echo "\x\ select * from foo;" | psql。

如果命令字串包含多個 SQL 命令,那麼他們在一個事務裏處理, 除非在字串裏包含了明確的 BEGIN/COMMIT 命令把他們分成多個事務。 這個和從 psql 的標準輸入裏給它填充相同字串不同。

-ddbname
--dbnamedbname
聲明想要聯接的數據庫名稱。等效於在命令行行上把 dbname 聲明爲第一個非選項參數。
-e
--echo-queries
顯示所由發送給服務器的查詢。 等效於把變量 ECHO 設置爲 queries。
-E
--echo-hidden
回顯由\d 和其他反斜槓命令生成的實際查詢。 如果你希望在你自己的程序裏包含類似的功能, 你就可以使用這個選項。這等效於在psql裏設置變量ECHO_HIDDEN。
-ffilename
--filefilename
使用 filename作爲命令的語句源而不是交互式讀入查詢。 在處理完文件後,psql 結束。這個選項在很多方面等效於內部命令\i

如果filename 是- (連字符),則從標準輸入讀取。

使用這個選項與用 psql < filename 有微小的區別。通常,兩者都回按照你預期那樣運行,但是使用 -f打開了一些很好的特性, 比如帶行號的錯誤信息。而且,使用這個選項還有可能有減小啓動負荷的機會。 另一方面,如果你把所有內容手工輸入, 使用 shell 輸入定向的方式(理論上)能保證生成和你已經得到的完全一樣的輸出(譯註:重複運行命令)。

-Fseparator
--field-separatorseparator
使用 separator 作爲域分隔符。等效於 \pset fieldsep\f
-hhostname
--hosthostname
聲明正在運行服務器的主機名。 如果主機名以斜扛開頭,則它被用做到 Unix 域套接字的路徑。
-H
--html
打開HTML格式輸出。等效於\pset format html 或\H 命令。
-l
--list
列出所有可用的數據庫,然後退出。其他非聯接選項將被忽略。類似於內部命令 \list
-ofilename
--outputfilename
將所有查詢輸出定向到文件 filename。這個選項等效於命令\o
-pport
--portport
聲明被服務器偵聽的 TCP 端口或使用的缺省本地 Unix 主控套接字文件句柄。 缺省的是環境變量PGPORT的值,如果沒有設置的話是編譯是聲明的端口,通常是 5432。
-Passignment
--psetassignment
允許你在命令行上以\pset 的風格設置打印選項。 要注意的是你在這裏用等號分割名稱和值,而不能用空格。 因此要把輸出格式設置爲 LaTeX,你可以敲入 -P format=latex。
-q
--quiet
聲明 psql 將安靜地執行處理任務。 缺省時psql將打印歡迎和許多其他輸出信息。 如果使用了此選項,這些都不出現。這在和 -c 選項一起使用時很有效。在 psql 裏,你可以通過設置 QUIET 變量實現同樣效果。
-Rseparator
--record-separatorseparator
使用 separator 做爲記錄分隔符。 等效於\pset recordsep 命令。
-s
--single-step
進入單步模式運行。意味着每個查詢在發往服務器之前都要提示用戶, 用這個選項也可以取消執行。此選項主要用於調試腳本。
-S
--single-line
進入單行運行模式,這時每個命令都將由換行符結束,象分號那樣。

Note: 注意: 注意這個模式是給那些堅持要這個特性的人的,我們不鼓勵你這麼用。 實際上,如果你在一行裏混合使用 SQL 和元命令,執行的順序對不熟練的用戶而言不總是清晰的。

-t
--tuples-only
關閉打印列名稱和結果行計數腳註等信息。完全等效於元命令\t
-Ttable_options
--table-attrtable_options
允許你聲明放在 HTML table 標記裏的選項。 參閱\pset 獲取細節。
-u
讓 psql 在和數據庫聯接之提示輸入用戶的用戶名和口令。

這個選項已經廢棄了,因爲它在概念上有漏洞。 (提示輸入非缺省用戶名和提示輸入服務器要求的口令是完全兩碼事。)我們鼓勵你用 -U 和 -W 選項取代。

-Uusername
--usernameusername
以用戶 username 代替缺省用戶與數據庫聯接。(當然,你必須有這麼做的權限。)
-vassignment
--setassignment
--variableassignment
進行一次變量分配,象內部命令\set 那樣。 注意,如果有變量名和值的話,你必須在命令行上用等號分隔它們。要重置一個變量, 去掉等號。這個分配是在啓動的很早的階段進行的,所以爲內部使用保留的變量可能被再次覆蓋。
-V
--version
顯示psql版本。
-W
--password
要求 psql 在與一個數據庫聯接前提示輸入口令。 這個選項將在整個會話過程中有效,即使你用元命令 \connect 改變了所聯接的數據庫。

在當前版本里,如果服務器要求口令認證,psql 自動提出一個口令提示符。因爲目 前這個特性是以一個“hack”爲基礎, 自動識別有可能奇怪地失效,因此用這個選項 強制一個提示符。 如果沒有聲明口令提示符而服務器要求口令認證,那麼聯接企圖 將失敗。

-x
--expanded
打開擴展表格式模式。等效於\x
-X,
--no-psqlrc
不讀取啓動文件 ~/.psqlrc
-?
--help
顯示關於psql命令行參數的幫助。

如果正常結束,那麼psql 向 shell 返回 0,如果自身發生致命錯誤,則返回 1(內存用盡,未找到文件等), 如果和數據庫的連接失效而且會話不再活躍則返回 2,如果腳本中發生錯誤並且設置了 ON_ERROR_STOP 則返回 3。

psql 是一個普通的 PostgreSQL 客戶端應用。爲了與一個數據庫聯接,你需要知道你的目標數據庫, 服務器的主機名和端口號以及你希望以哪個用戶的身份進行聯接等信息。 我們可以通過命令行參數告訴 psql 這些信息,分別是 -d, -h,-p,和 -U。 如果有個參數不屬於任何選項開關,那麼它會被解釋成數據庫名(或者是用戶名-如果數據庫名稱也給出了。)。 不是所有這些選項都是必須的,缺省的也可以。如果你省略主機名, psql 將通過 Unix 域套接字與本地主機的服務器相聯。 缺省的端口號是編譯時確定的。因爲數據庫服務器使用同樣的缺省值, 所以在大多數設置下,你可能不需要聲明端口號。缺省的用戶名是你的 Unix 用戶名,與數據庫同名。 要注意的是你不能用任意用戶名與任何數據庫相聯。你的數據庫管理員應該告訴你你的訪問權限。 你可以通過設置幾個環境變量 PGDATABASE, PGHOST,PGPORT 和 PGUSER 爲對應的值的方法節約幾次敲擊。

如果因爲任何原因而無法與數據庫相聯(例如,權限不夠,服務器沒有運行等), psql 將返回一個錯誤並退出。

通常狀況下,psql 提供一個帶有 psql 正在與之聯接的接數據庫名的,後綴 =>的提示符。例如,

$psql testdb
Welcome to psql 7.4beta5, the PostgreSQL interactive terminal.
Type: \copyright for distribution terms
      \h for help with SQL commands
      \? for help on internal slash commands
      \g or terminate with semicolon to execute query
      \q to quit
testdb=>

用戶可以在這個提示符下鍵入SQL 查詢。 通常,輸入的行將在命令終止分號出現時送到服務器。 一行的終止並不結束命令!因此命令可以因清晰起見跨越好幾行。如果命令發送出去而且沒有錯誤, 命令結果會顯示在屏幕上。

當命令正在進行時,psql 同樣還輪詢由 LISTEN [listen(7)] 和 NOTIFY [notify(7)] 生成的異步通知信號。

你在 psql 裏輸入的任何以不帶引號的反斜槓('\')開頭的東西都是 psql 元命令,這些命令是由 psql 自己處理的。這些命令也是令 psql 可用於管理或書寫腳本的原因。 元命令更常見的叫法是斜槓或反斜槓命令。

一個 psql 命令的格式是反斜槓後面緊跟一個命令動詞,然後是任意參數。 參數與命令動詞和其他參數以任意個空白字符間隔。

要在參數裏面包含空白,你必須用單引號把它包圍起來。 要在這樣的參數裏包含單引號,前面加一個反斜槓。 任何包含在單引號裏的東西會被進一步進行類 C 的替換,把 \n (new line),\t (tab), \digits, \0digits, 和 \0xdigits (給出的十進制,八進制,或十六進制碼的字符)替換掉。

如果一個不帶引號的參數以冒號(:)開頭, 它會被當作一個psql 變量,並且該變量的值會最終成爲真正的參數值。 (譯註:類似 ecpg 和 pl/pgsql 的變量用法。)

用反引號 ("backticks" `) 包圍的內容被當作一個命令行傳入 shell。 該命令的輸出(刪除了結尾的新行)被當作參數值。上面描述的逃逸(字符)序列在反引號裏也生效。

有些命令以一個 SQL 標識的名稱(如,一個表名)爲參數。 這些參數遵循 SQL 語法關於雙引號的規則: 不帶雙引號的標識強制成小寫, 而雙引號保護字母不受大小寫轉換,並且允許在標識符中使用空白。 在雙引號中,成對的雙引號在結果名字中分析成一個雙引號。比如, FOO"BAR"BAZ 解析成 fooBARbaz,而 "A weird"" name" 變成 A weird" name。 name.

對參數的分析在碰到另一個不帶引號的反斜槓時停止。 這裏會認爲是一個新的元命令的開始。特殊序列 \\ (雙反斜槓)標識參數的結尾並將繼續分析後面的 SQL 命令(如果存在的話)。這樣 SQL 和 psql命令可以自由的在一行裏面混合。 但是在任何情況下,一條元命令的參數不能延續超過行尾。

下列元命令是已定義的:

\a
如果目前的表輸出格式是不對齊的,切換成對齊的。 如果是對齊的,切換成不對齊。這條命令是爲了向後兼容。參閱\pset 獲取一個通用的解決方法。
\cd [directory]
把當前工作目錄改變到 directory。 沒有參數是則改變到當前用戶的家目錄。

Tip: 提示: 要打印出你的當前工作目錄,使用\!pwd.

\C [title ]
把正在打印的表的標題設置爲一個查詢的結果或者取消這樣的設置。 這條命令等效於 \pset titletitle. (這條命令的名稱源於 "caption",因爲以前只是用於在一個 HTML 表裏面設置標題。)
\connect (or\c) [dbname [username ] ]
與一個新的數據庫建立一個聯接,使用/不用一個用戶名。 前面的聯接將關閉。如果 dbname 是 -,那麼就假設是當前數據庫名稱。

如果省略 username,則假設是當前用戶名。

作爲一條特殊規則,不帶任何參數運行\connect 將以缺省用戶身份與缺省數據庫連接(正如你不帶任何參數運行 psql 一樣。)

如果聯接失敗(用戶名錯,訪問拒絕等),那麼將保留前面的聯接--當且僅當在 psql 處於交互模式下如此。 如果運行的是非交互的腳本,處理會馬上停止,並返回一個錯誤。 選擇這樣的區別是一方面爲用戶使用方便考慮,另一方面爲保證腳本不會碰巧操作了錯誤的數據庫的安全機制考慮的。

\copytable
執行前端(客戶端)拷貝。這是一個運行 SQL COPY 命令的操作, 不同的是 SQL COPY 是服務器在讀寫指明的文件,而 psql 讀寫文件並作爲本地的文件系統和服務器之間的路由取出或寫入數據。 這意味着文件訪問性和權限都是本地用戶的,而不是服務器的,因此不需要 SQL 超級用戶權限。

這條命令的語法是模擬 SQL COPY 命令的。(參考它的描述獲取細節。) 要注意的是由此而來,有一些特殊的分析規則應用於\copy 命令。 尤其是變量替換規則和反斜槓代換規則不起作用。

Tip: 提示: 此操作不象 SQL COPY 命令這樣高效, 因爲所有數據必須通過客戶端/服務器聯接。對於大數據量的操作,另一種方法更可行。

Note: 注意: 注意在客戶端和服務器拷貝時對 stdin 和 stdout 的解釋的區別:在前端拷貝時,這些總是指 psql的輸入和輸出流。在服務器拷貝時 stdin 來自 COPY 本身的標準輸入(比如,一個帶有 -f 選項的腳本), 而 stdout 指的是查詢輸出流(參閱下面的\o 元命令)。

\copyright
顯示 PostgreSQL 的版權和版本信息。
\d [pattern ]
對於每個匹配pattern的關係(表,視圖,索引或者序列), 顯示所有列,它們的類型,和任何特殊屬性,象NOT NULL或缺省等--只要存在。 如果實際上這個關係是一個表,任何已定義的索引,主鍵,唯一約束相關的索引,規則,約束,和觸發器也同樣顯示出來, 如果關係是一個視圖,還顯示視圖的定義。 ("匹配模式"在下面定義。)

從\d+ 來的命令也是一樣的,只不過還顯示與表的列關聯的註解。

Note: 注意: 如果如果不帶任何pattern調用\d , 等效於\dtvs,將顯示一個所有表,視圖和序列的列表。 這完全是出於方便的考慮。

\da [pattern ]
列出所有可用聚集函數,以及它們操作的數據類型。如果聲明瞭 pattern,那麼只顯示匹配(正則表達式)的聚集函數。
\dc [pattern ]
列出所有字符集之間的可用轉換。如果聲明瞭 pattern, 則只列出那些匹配模式的轉換。
\dC
列出所有類型轉換。
\dd [pattern ]
顯示所有匹配 pattern 的描述,如果沒有給出參數,顯示所有可視對象。 但是不管怎樣,只有那些有描述內容的對象才顯示出來。 ("對象"包括聚集,函數,操作符,類型, 關係(表,視圖,索引,序列,大對象),規則和觸發器。)例如:

=>\dd version
                     Object descriptions
   Schema   |  Name   |  Object  |        Description
------------+---------+----------+---------------------------
 pg_catalog | version | function | PostgreSQL version string
(1 row)

    

可以用COMMENT SQL 命令生成對對象的描述。

\dD [pattern ]
列出所有可用域。如果聲明瞭 pattern,那麼只顯示匹配的域。
\df [pattern ]
列出所有可用函數,以及它們的參數和返回的數據類型。如果聲明瞭 pattern,那麼只顯示匹配(正則表達式)的函數。如果使用了\df+ 的形式,每個函數的附加信息,包括語言和描述也會顯示出來。

Note: 注意: 爲了減少混亂,\df 並不顯示數據類型的 I/O 函數。 這樣是通過忽略那些接受或者返回類型 cstring 的函數實現的。

\distvS [pattern ]
這不是一個實際上的命令名稱:字母 i,s,t,v,S 分別代表索引(index), 序列(sequence),表(table),視圖(view)和系統表(system table)。 你可以以任意順序聲明任意或者所有這些字母獲得這些對象的一個列表。 字幕 S 把列表限制於系統對象;如果沒有 S,則只顯示非系統對象。 如果在命令名上附加了 +,那麼還會列出和每個對象相關聯的描述,如果有的話。

如果聲明瞭 pattern,那麼只列出匹配模式的對象。

\dl
這是\lo_list 的別名,顯示一個大對象的列表。
\dn [pattern ]
列出所有可用模式(名字空間)。如果聲明瞭 pattern (一個正則表達式),那麼只列出匹配模式的模式名。
\do [pattern ]
列出所有可用操作符,以及它們的操作數和返回的數據類型。 如果聲明瞭 pattern,那麼只顯示匹配模式的操作符。
\dp [pattern ]
生成一列可用的表和它們相關的權限。 如果聲明瞭 pattern, 那麼只列出名字可以匹配模式的表。

命令grant(7)revoke(7) 用於設置訪問權限。參閱grant(7) 獲取更多信息。

\dT [pattern ]
列出所有數據類型或只顯示那些匹配 pattern的。這條命令的\dT+ 形式顯示更多信息。
\du [pattern ]
列出所有已配置用戶或者只列出那些匹配 pattern 的用戶。
\edit (or\e) [filename ]
如果聲明瞭 filename, 則編輯此文件並且在編輯器退出後將其內容拷貝回查詢緩 衝區。 如果沒有給出參數,則把當前查詢緩衝區內容拷貝到一個臨時文件然後以相 同方式編輯。

然後根據一般的psql規則重新分析查詢緩衝區, 這時整個緩衝區當作一個單行。 (因此你無法用這個方法制作“腳本”,用\i 做腳本。) 這還意味着 如果該查詢以分號結尾(或者包含分號),它就會馬上被執行。否則它只是在查詢 緩衝區裏等待。

Tip: 提示: psql 搜索環境變量 PSQL_EDITOR,EDITOR 和 VISUAL(以此順序)查找要用到哪個編輯器。如果上面的都沒有設置,使用/bin/vi

\echotext [ ... ]
向標準輸出打印參數,用一個空格分隔並且最後跟着一個新行。 這個特性在顯示腳本的輸出時會有用。例如:

=>\echo `date`
Tue Oct 26 21:40:57 CEST 1999

    
果第一個參數是一個無引號的 -n,那麼不會寫出結尾的新行。

Tip: 提示: 如果你使用\o 命令重定向你的查詢的輸出,你可能會用\qecho 取代這條命令。

\encoding [encoding ]
設置客戶端字符編碼方式。不帶參數時,這條命令顯示當前的編碼方式。
\f [string ]
爲不對齊的查詢輸出設置域分隔符。缺省時是豎條(|)。 參閱\pset 獲取設置輸出選項的通用方法。
\g [ {filename | |command } ]
把當前的查詢輸入緩衝區的內容發送給服務器並且把輸出輸出到可選的 filename 或者把輸出定向到一個獨立的 Unix shell 執行 command。 單獨一個\g 實際上等效於一個分號。一個帶有參數的\g 是"一次性"的\o 命令的代用品。
\help (or\h) [command ]
給出指定 SQL 命令的語法幫助。如果沒有給出 command ,那麼 psql 將列出可獲得語法幫助的所有命令。如果 command 是一個星號("*"),則顯示所有 SQL 命令的語法幫助。

Note: 注意: 爲簡化敲擊,包含多個單字的命令不需要引用。因此鍵入\help alter table 是正確的。

\H
打開 HTML 查詢輸出格式。如果 HTML 格式已經打開,則切換回缺省的對齊的文本格式。 這個命令是爲了兼容和方便,參閱\pset 獲取設置其他輸出選項的內容。
\ifilename
從文件filename中讀取並把其內容當作從鍵盤輸入的那樣執行查詢。

Note: 注意: 如果你想在屏幕上看到讀入的行,你必須對所有行設置變量 ECHO 爲 all。

\l (or\list)
列出服務器上所有數據庫的名字和它們的所有者以及字符集編碼。在命令名稱後面加一個 "+" 還可以看到對數據庫的描述。
\lo_exportloidfilename
從數據庫裏讀取 OID 爲 loid 的大對象並把她寫到 filename裏。 注意這個功能與服務器函數 lo_export 有些微小的區別, lo_export 運行時帶着運行數據庫服務器的用戶權限, 而且是在服務器的文件系統上。

Tip: 提示: 使用\lo_list 查看大對象的 OID。 OID.

\lo_importfilename [comment ]
把文件存儲爲一個 PostgreSQL 大對象。可以帶着一個該對象的註解選項。例如:

foo=>\lo_import '/home/peter/pictures/photo.xcf' 'a picture of me'
lo_import 152801

    
響應表明此大對象得到一個對象標識 152801,如果你還想訪問該對象,就應該把這個對象標識記住。 因此,我們建議總是給每個對象關聯一個人類可讀的註解。那樣就可以用\lo_list 命令看到這些註解。

注意這條命令與服務器端的 lo_import 有一些區別,因爲這條命令是本地用戶在本地文件系統上操作, 而不是以服務器用戶在服務器文件系統上操作。

\lo_list
顯示一個目前存儲在該數據庫裏的所有 PostgreSQL 大對象和它們的所有者的列表。
\lo_unlinkloid
從數據庫裏刪除OID爲loid 的大對象。

Tip: 提示: 使用\lo_list 查找大對象的 OID。 OID.

\o [ {filename | |command} ]
把後面的查詢結果保存到文件 filename 裏或者把後面的查詢結果定向到一個獨立的 Unix shell 執行 command。 如果沒有聲明參數,查詢輸出重置爲標準輸出。

"查詢結果"包括所有表,命令響應和從數據庫服務器來的提示, 同樣還有各種各樣查詢數據庫的反斜槓命令的輸出(如\d),但是沒有錯誤信息。

Tip: 提示: 要用文本分散查詢結果之間的輸出,用\qecho

\p
打印當前查詢緩衝區到標準輸出。
\psetparameter [value ]
這條命令設置影響查詢結果表輸出的選項。parameter 描述要設置的選項是哪一個。value 的語意也取決於它。

可調節的打印選項有:

format
設置輸出格式爲 unaligned,aligned,html, 或 latex之一。允許使用唯一的縮寫。(這也意味着一個字母就夠了。)

"Unaligned" (不對齊)把一條記錄的所有字段都輸出到一行, 用當前有效的域分隔符分隔。這主要用於生成那些要被其他程序讀取的輸出(tab分隔,逗號分隔)。 "Aligned" (對齊)模式是標準的,人類可讀的,格式化好了的文本輸出,也是缺省。 "HTML" 和 "LaTeX" 模式把表輸出爲可用於文檔裏的對應標記語言。它們還不是完整的文檔! (可能對於 HTML 變化還不是太大,但是在 LaTeX 裏,你必須有一個完整的文檔包裝器。)

border
第二個參數必須是一個數字。通常,數字越大,表就有越寬的邊界和越多的線, 但是這個參數取決於實際的格式。在HTML模式裏, 這個參數會直接翻譯成border=...屬性,在其他的模式裏, 只有值 0 (無邊界),1 (內部分隔線)和 2 (表框架)有意義。
expanded (or x)
在正常和擴展格式之間切換。當打開擴展格式時,所有的輸出都是兩列, 字段名稱在左,數據在右。 這個模式在數據無法放進通常的"水平"模式的屏幕時很有用。

所有四種輸出模式都支持擴展格式。

null
第二個參數是一個字串,用以代表字段的值爲 null 時的打印輸出。 缺省是什麼都不打,這樣很容易和類似一個空字串混淆。 因此,我們可能選擇\pset null '(null)'。
fieldsep
聲明在非對齊模式時的域分隔符。 這樣我們就可以創建其他程序希望的tab或逗號分隔的輸出。要設置 tab 域分隔符, 鍵入\pset fieldsep ''。缺省域分隔符是 '|' (一個豎條符號)。
footer
切換默認足標的顯示 (x rows)。
recordsep
聲明在非對齊模式時的記錄分隔符。缺省是換行符。
tuples_only (或 t)
在完全顯示和只顯示記錄之間切換。 完全顯示將顯示象列頭,標題和各種腳註等信息。 只顯示記錄模式將只顯示實際的表數據。
title [text ]
爲任何隨後打印的表設置標題。 這個參數可以用於給你的輸出一個描述性標記。 如果不帶參數,重置標題。
tableattr (or T) [text ]
允許你聲明放在 HTML table 標記裏的任何屬性。例如,可以是 cellpadding 或 bgcolor。注意你可能不需要在這裏聲明 border ,因爲已經在\pset border 裏用過了。
pager
控制查詢和psql幫助輸出的分頁器。如果設置了環境變量 PAGER, 輸出被定向到指定程序,否則使用系統缺省(比如 more)。

如果關閉了分頁器,則不使用它,如果打開了,程序只在需要的時候使用分頁器,也就是說, 輸出是到終端,而且那個表很可能無法與屏幕匹配。 (psql 在決定何時分頁時不是很完美。)\pset pager 開關分頁器。我們也可以把分頁器設置爲 always,導致我們在任何情況下都使用分頁器。

可以在 "Examples 例子" 節看到這些不同格式輸出的示例。

Tip: 提示: 有很多用於\pset 的快速命令。參閱 \a,\C,\H, \t,\T, 和\x

Note: 注意: 無參數運行\pset 是錯誤的。 以後這樣調用將顯示當前打印選項狀態。

\q
退出 psql 程序。
\qechotext [ ... ]
這條命令等效於\echo ,區別是所有輸出將寫入由\o 設置的輸出通道。
\r
重置(清空)查詢緩衝區。
\s [filename ]
將命令行歷史打印出或是存放到 filename。 如果省略 filename, 歷史將輸出到標準輸出。這個選項只有在 psql 配置成使用 GNU 歷史庫後才生效。

Note: 注意: 在當前版本里,這個( GNU 歷史庫)不再是必須的了, 實際上,在程序結束時自動保存命令行歷史。每次 psql 啓動都會裝載命令行歷史。

\set [name [value [ ... ]]]
設置內部變量 name 爲 value 或着如果給出了多於一個值, 設置爲所有這些值的聯接結果。如果沒有給出第二個參數,只設變量不設值。要重置一個變量,使用\unset 命令。

有效的變量名可以包含字符,數字和下劃線。 參閱下面的 "Variables 變量" 獲取細節。

儘管你可以設置任何變量爲任意值, psql對一些變量特殊對待。它們在關於變量的節裏面有文檔。

Note: 注意: 這條命令是完全和 SQL 命令 SET [set(7)] 不一樣的。

\t
切換輸出的列/字段名的信息頭和行記數腳註。 這條命令等效於\pset tuples_only,提供主要爲了方便。
\Ttable_options
允許你在使用HTML輸出模式時聲明放在 table 標記裏的屬性。 這條命令等效於\pset tableattr table_options。
\timing
切換每個 SQL 語句使用的時間,單位是毫秒。
\w {filename ||command}
將當前查詢緩衝區輸出到文件 filename 或者定向到 Unix 命令 command。
\x
切換擴展行格式。等效於\pset expanded。
\z [pattern ]
生成一個帶有訪問權限列表的數據庫中所有表的列表。 如果給出任何pattern,則被當成一個規則表達式, 只顯示匹配的表。

命令grant(7)revoke(7) 用於設置訪問權限。 參閱grant(7) 獲取更多信息。

這是\dp("顯示權限")的別名。

\! [command ]
返回到一個獨立的 Unix shell 或者執行 Unix 命令 command。 參數不會被進一步解釋,shell 將看到全部參數。
\?
獲得關於反斜槓命令的幫助信息。

各種\d 命令都接受一個 pattern 參數,聲明要顯示的對象名字。* 表示"任何字符序列", 而 ? 表示"任何單個字符"。(這個表示法和 Unix 的 shell 文件名模式兼容。) 高級用戶也可以使用正則表達式表示法,比如字符表,[0-9] 這樣的東西來匹配"任意數字"。 要讓任何這些模式匹配字符可以安字面方式解析,那就應該用雙引號包圍它們。

一個包含(無引號的)句點的模式會被解析承一個模式名的模式後面跟着一個對象名的模式。 比如,\dt foo*.bar* 顯示所有以foo 開頭的模式裏的以 bar 開頭的表名字。 如果沒有出現句點,那麼這個模式只匹配在當前模式搜索路徑中可見的對象。

如果完全省略 pattern 參數, 那麼\d 命令顯示所有在當前模式搜索路徑中可見的對象。 要查閱在數據庫中的所有對象,使用模式 *.*。

psql 提供類似通常 Unix 命令 shell 那樣的變量替換特性。 變量只是簡單的名稱/數值對, 這裏的值可以是任何長度的任何值。要設置一個變量,使用 psql 元命令 \set

testdb=>\set foo bar

把變量"foo" 設置爲值 "bar"。 要檢索變量的內容,在變量名前面放上冒號然後把它用在任意斜槓命令裏:

testdb=>\echo :foo
bar

Note: 注意: \set 的參數服從和其他命令一樣的替換規則。 因此你可以構造有趣的引用,象\set :foo 'something' 這樣, 獲得分別象Perl或 PHP那樣有名的"軟連接(soft links)"或"變量 變量"。 不幸的是(或者 萬幸的?),用這些構造不能做任何有用的事情。另一方面,\set bar :foo 是一個非常有效的拷貝變量的方法。

如果你不帶第二個參數調用\set, 那麼只是設置這個變量而沒有值。 要重置(或刪除)一個變量,使用命令\unset

psql 的內部變量可以包括任意順序, 任意數量的字母,數字和下劃線。 有一些常用變量被 psql 另眼相待。它們是一些選項設置, 這些選項在運行時可以通過改變變量的值或者改變一些應用的表現狀態而改變。 儘管你可以把這些變量用於其他用途,但是我們不鼓勵這麼做,因爲程序的特性可能會很快變得非常奇怪。 通常,所有特殊對待的變量都是由大寫字母組成(可能還有數字和下劃線)。 爲了保證和未來的最大限度的兼容性,請避免使用這樣的變量。 下面是一個所有特殊對待的變量列表。

AUTOCOMMIT
如果是 on(缺省),那麼每個 SQL 命令都在成功完成後自動提交。 要推遲這種模式下的提交,你必須輸入一個 BEGIN 或者 START TRANSACTION SQL 命令。 如果是 off 或者未設置,SQL 命令不會提交,知道你明確地發出 COMMIT 或者 END。 關閉自動提交的模式是通過爲你明確發出一個 BEGIN 實現的, 它是放在任何尚未在一個事務塊中並且自己不是 BEGIN 或者其它事務控制命令的前面。

Note: 注意: 在關閉自動提交的模式下,你必須明確放棄任何失敗的事務,方法是執行 ABORT 或者 ROLLBACK。 還要注意如果你不提交就退出會話,你的工作會丟失。

Note: 注意: 自動提交打開方式是 PostgreSQL 傳統的行爲, 但是關閉自動提交更接近 SQL 規範。如果你喜歡關閉自動提交,你應該在你的.psqlrc 文件裏設置它。

DBNAME
你正在聯接着的數據庫名稱。 每次你與一個數據庫聯結都會設置這個值(包括程序啓動),但是可以刪除。
ECHO
如果置爲 all, 輸入的或者來自一個腳本的所有行在分析或執行前都寫到標準輸出。 要在程序啓動時聲明這些,使用 -a如果設置爲 queries, psql 只是在查詢發送給服務器之前打印出來。 實現這個功能的命令行選項是 -e。
ECHO_HIDDEN
當設置了這個變量並且一個反斜槓命令查詢數據庫時,首先顯示查詢。 這樣你可以學習 PostgreSQL 內部的東西並且在你自己的程序裏提供類似功能。如果你設置該變量的值爲 "noexec",查詢只是顯示出來但是實際上不發送到服務器和執行。
ENCODING
當前的客戶端字符集編碼。
HISTCONTROL
如果這個變量設置爲 ignorespace, 以空格開始的行將不會進入歷史列表。 如果設置爲變量 ignoredups, 與以前歷史記錄裏匹配的行也不會進入歷史記錄。值 ignoreboth是上面兩個的結合。 如果刪除此變量或者其值爲任何與上面的值不同的東西, 所有交互模式讀入的行都被保存入歷史列表。

Note: 注意: 這個特性是無恥地從bash 裏剽竊來的。

HISTSIZE
存在命令歷史裏的命令的個數。缺省值是 500。

Note: 注意: 這個特性是無恥地從bash 裏剽竊來的。

HOST
當前你正聯接的數據庫服務器主機。 這是在每次你與數據庫聯接時(包括程序啓動)設置的,但是可以刪除。
IGNOREEOF
如果刪除此變量,向一個交互的 psql會話發送一個 EOF (通常是Control+D)將終止應用。如果設置爲一個數字值,那麼在應用終止前該數值的 EOF 字符將被忽略。 如果設置了此變量但是沒有數字值,缺省是 10。

Note: 注意: 這個特性是無恥地從bash 裏剽竊來的。

LASTOID
最後影響的oid值,即爲從一條 INSERT 或 lo_insert 命令返回的值。 此變量只保證在下一條 SQL 命令的結果顯示之前有效。
ON_ERROR_STOP
缺省時,如果非交互的腳本碰到一個錯誤,象一條錯誤的 SQL 命令或者內部元命令,處理會繼續進行。 這是 psql 的傳統特性, 但是有時候我們不太希望這樣。如果設置了這個變量,腳本處理將馬上停止。 如果該腳本是從另外一個腳本調用的,那個腳本也會按同樣的方式停止。 如果最外層的腳本不是從一次交互的 psql 會話中調用的而是用 -f 選項調用的,psql 將返回錯誤代碼 3,以示這個情況與致命錯誤條件的區別(錯誤代碼 1)。
PORT
當前你正在聯接的數據庫服務器的端口。 這是在每次你與數據庫聯接時(包括程序啓動)設置的,但是可以刪除。
PROMPT1
PROMPT2
PROMPT3
這些指明psql 顯示的提示符看上去象什麼。 參閱下面的 "Prompting 提示符"。
QUIET
這個變量等效於命令行選項 -q。 可能在交互模式下沒有什麼用。
SINGLELINE
這個變量等效於設置命令行選項 -S。你可以在運行時刪除或設置它。
SINGLESTEP
這個變量等效於命令行選項-s
USER
當前你正用於聯接的數據庫用戶。 這是在每次你與數據庫聯接時(包括程序啓動)設置的,但是可以刪除/重置。
VERBOSITY
這個選項可以設置爲值 default,verbose,或者 terse 以控制錯誤報告的冗餘行。

一個附加的 psql 變量的有用特性是你可以把它們替換("代換")成正規的 SQL 語句。這樣做的語法同樣還是變量名前面加一個冒號(:)。

testdb=>\set foo 'my_table'
testdb=>SELECT * FROM :foo;

將會查詢表my_table。變量的值是逐字拷貝的, 所以它甚至可以包含不對稱的引號或反斜槓命令。你必須保證你輸入的東西是有意義的。 變量替換將不會在引號引起來的 SQL 語句裏面發生。

利用這個功能的一個時髦的應用是通過使用一個隨後的語句中最後插入的 OID 建立一個外鍵仿真場景。 另一個可能用到這個機制的地方是把一個文件的內容拷貝到一個字段裏面去。 首先把文件裝載到一個變量然後象上面那樣處理。

testdb=>\set content '\'' `cat my_file.txt` '\''
testdb=>INSERT INTO my_table VALUES (:content);

這樣處理的一個可能問題是 my_file.txt 可能包含單引號。這些需要被逃逸以免在處理第三行時不會導致語法錯誤。 可以使用程序 sed 來做這個處理:

testdb=>\set content '\'' `sed -e "s/'/\\\\\\'/g" < my_file.txt` '\''

觀察正確數量的反斜槓(6)!你可以這樣解釋它:在 psql 分析完這行後,它把 sed -e "s/'/\\\'/g" < my_file.txt 傳遞給shell。 shell 將對雙引號裏的東西做其處理然後用參數 -e 和 s/'/\\'/g 執行 sed。當 sed分析這些時, 它將把雙反斜槓替換爲單個反斜槓然後進行替換。 可能有時候你認爲所有 Unix 命令使用同一個逃逸字符是個好事。 但具有諷刺意味的事實是你可能不得不逃逸所有反斜槓,因爲 SQL 文本常量同樣也慘遭這種解釋。 這種情況下你可能最好在外部準備文件。

因爲冒號也可以合法的出現在 SQL 命令裏,便有下面規則的應用: 如果沒有設置變量,字符序列 "冒號+名稱" 不會被改變。 在任何情況下你都可以用反斜槓逃逸冒號以保護它免於被解釋。 (變量的冒號語法是 SQL 用於嵌入查詢語言的標準,如 ECPG。用於數組片段和類型轉換的冒號語法是 PostgreSQL 擴展,因此有衝突。)

psql 使用的提示符可以根據你的喜好客戶化。三個變量 PROMPT1,PROMPT2,和 PROMPT3 包含描述提示符的外觀的字串和特殊逃逸序列。Prompt 1 是 psql 請求一個新命令時的使用的正常提示符。 Prompt 2 是在一個命令輸入期待更多輸入時(因爲查詢沒有用一個分號結束或者引號沒有關閉)顯示的提示符。 Prompt 3 在你運行一個 SQL COPY 命令和等待你在終端上鍵入記錄時使用。

相應的提示符變量的值是按字面打印的,除非碰到一個百分號(%)。這時某些其他的文本被替換, 替換爲何物取決於下一個字符。已定義的替換是:

%M
數據庫服務器主機名全名(帶着域名),如果聯接是通過 Unix 域套接字進行的就是 [local], 或者如果 Unix 域套接字不是編譯的缺省位置,就是 [local:/dir/name]。
%m
數據庫服務器的主機名刪去第一個點後面的部分剩下的東西。 或者如果聯接是通過 Unix 域套接字,就是 [local]。
%>
數據庫服務器正在偵聽的端口號。
%n
數據庫會話的用戶名。 (這個值的擴展可能在一個數據庫會話過程中因爲SET SESSION AUTHORIZATION 命令而改變。)
%/
當前數據庫名稱。
%~
類似 %/, 但如果數據庫是你的缺省數據庫輸出是"~" (波浪線(tilde))。
%#
如果會話用戶是數據庫超級用戶,使用 "#",否則用">"。 (這個值的擴展可能在一個數據庫會話過程中因爲SET SESSION AUTHORIZATION 命令而改變。)
%R
對於 prompt 1 通常是 =,但是如果是單行模式則是 ^,而如果會話與數據庫斷開(如果onnect 失敗可能發生)是 !。對於 prompt 2 該序列被 -,*,一個單引號或者一個雙引號代替, 這取決於 psql是否等待更多的輸入(因爲查詢沒有終止,或着正在一個 /* ... */註釋裏面,或者因爲你在引號裏面)。對於 prompt 3 該序列不解釋成任何東西。
%x
事務狀態:如果不在事務塊裏,是一個空字串,如果在事務塊裏,是 *, 如果在一個失敗的事務塊裏是 !,或者無法判斷事務狀態時爲 ? (比如,因爲沒有連接)。
%digits
如果 digits 以 0x 開頭, 那麼其餘字符被解釋成一個十六進制數字並且替換爲對應(十六進制碼)的字符。 如果第一個數字是 0,該字符被解釋成一個八進制數字並且替換爲對應的(八進制碼)的字符。 否則認爲是一個十進制數字。
%:name:
psql變量name的值。參閱 "Variables 變量" 節獲取細節。
%`command`
command的輸出, 類似於通常的反引號(back-tick)替換。

要在提示符裏插入百分號,鍵入%%。缺省提示符等效於 '%/%R%# ' 用於 prompts 1 和 2,以及'>> ' 用於 prompt 3。

Note: 注意: 這個特性是無恥地從tcsh 裏剽竊來的。

psql 爲了編輯和檢索命令行的方便支持 readline 和歷史庫。 命令歷史存放在你的家目錄的一個叫 .psql_history 的文件裏, 並且當 psql 啓動的時候會裝載進來。 還支持 Tab 補齊,儘管該補齊邏輯並不是一個 SQL 分析器必備的。 如果因某些原因你不喜歡 tab 補齊,你可以把下面幾行放在你的家目錄的一個叫.inputrc 的文件裏關閉這個特性:

$if psql
set disable-completion on
$endif

(這不是 psql 的特性, 是Readline 的。參考它的文檔獲取更多細節。)

HOME
初始化文件(.psqlrc)和命令歷史文件(.psql_history)的目錄。
PAGER
如果查詢結果在一頁裏放不下,那麼它們被定向到這個命令。 典型的值是 more 或者 less。 缺省的是平臺相關的。我們可以用\pset 命令關閉分頁器。
PGDATABASE
缺省連接的數據庫
PGHOST
PGPORT
PGUSER
缺省連接參數
PSQL_EDITOR
EDITOR
VISUAL
\e 命令使用的編輯器。這些變量是按照上面的順序檢查的;設置最早的最先使用。
SHELL
\! 命令執行的命令。
TMPDIR
存儲臨時文件的目錄。缺省是/tmp

在啓動之前,psql 視圖讀取並 執行來自文件$HOME/.psqlrc 的命令。 它將用於設置客戶端或者服務器的風格(使用\setSET 命令)。
命令行歷史存儲在$HOME/.psql_history

一些 psql的早期版本允許一個單字母的反斜槓命令(元命令)的第一個參數直接跟在命令後面, 而不用空白間隔。出於兼容性原因,這個特性仍然在某些程度上被支持,但是我不準備在這裏詳細解釋,因爲我不鼓勵這樣使用。 不過如果你收到莫名其妙的信息,想想這個用法。例如

testdb=>\foo
Field separator is "oo".

    
可能不是你想要的東西。
psql 只能與同版本的服務器平穩地工作。 這不意味着其他組合會完全失敗,但是可能有微小的或者不那麼微小的問題。 如果服務器的版本不同,反斜槓命令是特別容易失效的。

第一個例子演示瞭如何把一個查詢分成多個行進行輸入。注意提示符的變化:

testdb=>CREATE TABLE my_table (
testdb(> first integer not null default 0,
testdb(> second text
testdb->);
CREATE TABLE

現在再看看錶定義:

testdb=>\d my_table
             Table "my_table"
 Attribute |  Type   |      Modifier
-----------+---------+--------------------
 first     | integer | not null default 0
 second    | text    |

把提示符變成更有趣的東西:

testdb=>\set PROMPT1 '%n@%m %~%R%# '
peter@localhost testdb=>

假設你用數據填充了表並且想看一眼:

peter@localhost testdb=> SELECT * FROM my_table;
 first | second
-------+--------
     1 | one
     2 | two
     3 | three
     4 | four
(4 rows)

你可以用\pset 命令讓這個查詢看起來不一樣:

peter@localhost testdb=>\pset border 2
Border style is 2.
peter@localhost testdb=>SELECT * FROM my_table;
+-------+--------+
| first | second |
+-------+--------+
|     1 | one    |
|     2 | two    |
|     3 | three  |
|     4 | four   |
+-------+--------+
(4 rows)
peter@localhost testdb=>\pset border 0
Border style is 0.
peter@localhost testdb=>SELECT * FROM my_table;
first second
----- ------
    1 one
    2 two
    3 three
    4 four
(4 rows)
peter@localhost testdb=>\pset border 1
Border style is 1.
peter@localhost testdb=>\pset format unaligned
Output format is unaligned.
peter@localhost testdb=>\pset fieldsep ","
Field separator is ",".
peter@localhost testdb=>\pset tuples_only
Showing only tuples.
peter@localhost testdb=>SELECT second, first FROM my_table;
one,1
two,2
three,3
four,4

還可以用短(縮寫)命令:

peter@localhost testdb=>\a\t\x
Output format is aligned.
Tuples only is off.
Expanded display is on.
peter@localhost testdb=>SELECT * FROM my_table;
-[ RECORD 1 ]-
first  | 1
second | one
-[ RECORD 2 ]-
first  | 2
second | two
-[ RECORD 3 ]-
first  | 3
second | three
-[ RECORD 4 ]-
first  | 4
second | four

Postgresql 中文網站 何偉平 <laser@pgsqldb.org>

本頁面中文版由中文 man 手冊頁計劃提供。
中文 man 手冊頁計劃:https://github.com/man-pages-zh/manpages-zh
2003-11-02 Application