CONNECTING TO A DATABASE 與一個數據庫聯接¶

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

ENTERING SQL COMMANDS 輸入 SQL 命令¶

$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)] 生成的異步通知信號。

META-COMMANDS 元命令¶

一個 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。 沒有參數是則改變到當前用戶的家目錄。

\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 命令。 尤其是變量替換規則和反斜槓代換規則不起作用。

\copyright

顯示 PostgreSQL 的版權和版本信息。

\d [pattern ]

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

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

\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+ 的形式，每個函數的附加信息，包括語言和描述也會顯示出來。

\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 做腳本。） 這還意味着 如果該查詢以分號結尾（或者包含分號），它就會馬上被執行。否則它只是在查詢 緩衝區裏等待。

\echotext [ ... ]

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

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

    

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

\encoding [encoding ]

設置客戶端字符編碼方式。不帶參數時，這條命令顯示當前的編碼方式。

\f [string ]

爲不對齊的查詢輸出設置域分隔符。缺省時是豎條（|）。 參閱\pset 獲取設置輸出選項的通用方法。

\g [ {filename | |command } ]

把當前的查詢輸入緩衝區的內容發送給服務器並且把輸出輸出到可選的 filename 或者把輸出定向到一個獨立的 Unix shell 執行 command。 單獨一個\g 實際上等效於一個分號。一個帶有參數的\g 是"一次性"的\o 命令的代用品。

\help (or\h) [command ]

給出指定 SQL 命令的語法幫助。如果沒有給出 command ，那麼 psql 將列出可獲得語法幫助的所有命令。如果 command 是一個星號（"*"），則顯示所有 SQL 命令的語法幫助。

\H

打開 HTML 查詢輸出格式。如果 HTML 格式已經打開，則切換回缺省的對齊的文本格式。 這個命令是爲了兼容和方便，參閱\pset 獲取設置其他輸出選項的內容。

\ifilename

從文件filename中讀取並把其內容當作從鍵盤輸入的那樣執行查詢。

\l (or\list)

列出服務器上所有數據庫的名字和它們的所有者以及字符集編碼。在命令名稱後面加一個 "+" 還可以看到對數據庫的描述。

\lo_exportloidfilename

從數據庫裏讀取 OID 爲 loid 的大對象並把她寫到 filename裏。 注意這個功能與服務器函數 lo_export 有些微小的區別， lo_export 運行時帶着運行數據庫服務器的用戶權限， 而且是在服務器的文件系統上。

\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 的大對象。

\o [ {filename | |command} ]

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

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

\p

打印當前查詢緩衝區到標準輸出。

\psetparameter [value ]

這條命令設置影響查詢結果表輸出的選項。parameter 描述要設置的選項是哪一個。value 的語意也取決於它。

可調節的打印選項有：

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

\q

退出 psql 程序。

\qechotext [ ... ]

這條命令等效於\echo ，區別是所有輸出將寫入由\o 設置的輸出通道。

\r

重置（清空）查詢緩衝區。

\s [filename ]

將命令行歷史打印出或是存放到 filename。 如果省略 filename， 歷史將輸出到標準輸出。這個選項只有在 psql 配置成使用 GNU 歷史庫後才生效。

\set [name [value [ ... ]]]

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

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

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

\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 命令顯示所有在當前模式搜索路徑中可見的對象。 要查閱在數據庫中的所有對象，使用模式 *.*。

ADVANCED FEATURES 高級特性¶

VARIABLES 變量¶

testdb=>\set foo bar

testdb=>\echo :foo
bar

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

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

AUTOCOMMIT

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

DBNAME

你正在聯接着的數據庫名稱。 每次你與一個數據庫聯結都會設置這個值（包括程序啓動），但是可以刪除。

ECHO

如果置爲 all， 輸入的或者來自一個腳本的所有行在分析或執行前都寫到標準輸出。 要在程序啓動時聲明這些，使用 -a如果設置爲 queries， psql 只是在查詢發送給服務器之前打印出來。 實現這個功能的命令行選項是 -e。

ECHO_HIDDEN

當設置了這個變量並且一個反斜槓命令查詢數據庫時，首先顯示查詢。 這樣你可以學習 PostgreSQL 內部的東西並且在你自己的程序裏提供類似功能。如果你設置該變量的值爲 "noexec"，查詢只是顯示出來但是實際上不發送到服務器和執行。

ENCODING

當前的客戶端字符集編碼。

HISTCONTROL

如果這個變量設置爲 ignorespace， 以空格開始的行將不會進入歷史列表。 如果設置爲變量 ignoredups， 與以前歷史記錄裏匹配的行也不會進入歷史記錄。值 ignoreboth是上面兩個的結合。 如果刪除此變量或者其值爲任何與上面的值不同的東西， 所有交互模式讀入的行都被保存入歷史列表。

HISTSIZE

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

HOST

當前你正聯接的數據庫服務器主機。 這是在每次你與數據庫聯接時（包括程序啓動）設置的，但是可以刪除。

IGNOREEOF

如果刪除此變量，向一個交互的 psql會話發送一個 EOF （通常是Control+D）將終止應用。如果設置爲一個數字值，那麼在應用終止前該數值的 EOF 字符將被忽略。 如果設置了此變量但是沒有數字值，缺省是 10。

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 以控制錯誤報告的冗餘行。

SQL INTERPOLATION 代換¶

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

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

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

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

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

PROMPTING 提示符¶

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

%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。

COMMAND-LINE EDITING 命令行編輯¶

$if psql
set disable-completion on
$endif