| PostgreSQL 8.0.0 中文文件(轉譯自 PostgreSQL 中國 製作的簡體中文版本) | ||||
|---|---|---|---|---|
| Prev | Fast Backward | Fast Forward | Next | |
COPY tablename [ ( column [, ...] ) ]
FROM { 'filename' | STDIN }
[ [ WITH ]
[ BINARY ]
[ OIDS ]
[ DELIMITER [ AS ] 'delimiter' ]
[ NULL [ AS ] 'null string' ]
[ CSV [ QUOTE [ AS ] 'quote' ]
[ ESCAPE [ AS ] 'escape' ]
[ FORCE NOT NULL column [, ...] ]
COPY tablename [ ( column [, ...] ) ]
TO { 'filename' | STDOUT }
[ [ WITH ]
[ BINARY ]
[ OIDS ]
[ DELIMITER [ AS ] 'delimiter' ]
[ NULL [ AS ] 'null string' ]
[ CSV [ QUOTE [ AS ] 'quote' ]
[ ESCAPE [ AS ] 'escape' ]
[ FORCE QUOTE column [, ...] ]
COPY 在 PostgreSQL資料表和標準文件系統文件之間交換資料。 COPY TO 把一個資料表的所有內容都拷貝到一個文件, 而 COPY FROM 從一個文件裡拷貝資料到一個資料表裡(把資料附加到資料表中已經存在的內容裡)。
如果聲明了一個字串列資料表,COPY 將只在文件和資料表之間拷貝聲明的字串的資料。 如果資料表中有任何不在字串列資料表裡的字串,那麼 COPY FROM 將為那些字串插入預設值。
帶文件名的 COPY 指示 PostgreSQL 伺服器直接從文件中讀寫資料。 如果聲明了文件名,那麼該文件必須為伺服器可見,而且文件名必須從伺服器的角度聲明。如果聲明的是 STDIN 或 STDOUT,資料透過連接在客戶前端和伺服器之間流動。
現存資料表的名字(可以有模式修飾)。
可選的待拷貝字串列資料表。如果沒有聲明字串列資料表,那麼將使用所有字串。
輸入或輸出文件的絕對路徑名。
聲明輸入是來自客戶端應用。
聲明輸入前往客戶端應用。
使用二進制格式儲存和讀取,而不是以文本的方式。 在二進制模式下,不能聲明 DELIMITERS,NULL 或者 CSV 選項。
聲明為每行拷貝內部對像標識(OID)。 (如果給那些沒有 OID 的資料表聲明了 OIDS 選項,則拋出一個錯誤。)
用於在文件中每行中分隔各個字串的單個字元。 在文本模式下,預設是水平製資料表符(tab),在 CSV 模式下是一個逗號。
個代資料表 NULL 值的字串。在文本模式下預設是 \N (反斜槓-N), 在 CSV 模式下是一個沒有引號的空值。 如果您不想區分空值和空字串,那麼即使在文本模式下可能您也會用一個空字串。
注意: 在使用 COPY FROM 的時候,任何匹配這個字串的字串將被儲存為 NULL 值, 所以您應該確保您用的字串和COPY TO相同。
打開逗號分隔變量(CSV)模式。
聲明 CSV 模式裡的引號字元。預設是雙引號。
聲明在 CSV 模式下應該出現在資料裡 QUOTE 字元值前面的字元。 預設是 QUOTE 值(通常是雙引號)。
在 CSV COPY TO 模式下,強制在每個聲明的字串周圍對所有非 NULL 值都使用引號包圍。 NULL 從不會被引號包圍。
在 CSV COPY FROM 模式下,把聲明的每個字串都當作它們有引號包圍來處理, 因此就沒有 NULL 值。對於在 CSV 模式下的預設空字串(''), 這樣導致一個缺失的數值當作一個零長字串輸入。
COPY 只能用於資料表,不能用於視圖。
BINARY 關鍵字將強制使用二進制對像而不是文本儲存/讀取所有資料。 這樣做在一定程度上比傳統的拷貝命令快,但二進制拷貝文件在不同機器體系間的植性不是很好。
您對任何要COPY TO 出來的資料必須有選取資料的權限,對任何要 COPY FROM 入資料的資料表必須有插入權限。
COPY 命令裡面的文件必須是由伺服器直接讀或寫的文件,而不是由客戶端應用讀寫。 因此,它們必須位於資料庫伺服器上或者可以為資料庫伺服器所訪問,而不是由客戶端做這些事情。 它們必須是PostgreSQL用戶(伺服器執行的用戶 ID)可以訪問到並且可讀或者可寫,而不是客戶端。 COPY 到一個命名文件是只允許資料庫超級用戶進行的,因為它允許讀寫任意伺服器有權限訪問的文件。
不要混淆 COPY 和 psql 指令 \copy。 \copy 調用 COPY FROM STDIN 或者 COPY TO STDOUT, 然後把資料抓取/儲存到一個 psql 客戶端可以訪問的文件中。 因此,使用 \copy 的時候,文件訪問權限是由客戶端而不是伺服器端決定的。
我們建議在 COPY 裡的文件名字總是使用絕對路徑。 在 COPY TO 的時候是由伺服器強制進行的, 但是對於 COPY FROM,您的確有從一個聲明為相對路徑的文件裡讀取的選擇。 該路徑將解釋為相對於伺服器的工作目錄(在資料目錄裡的什麼地方),而不是客戶端的工作目錄。
COPY FROM 會激活所有觸發器和檢查約束。不過,不會激活規則。
COPY 輸入和輸出是被 DateStyle 影響的。 為了和其它 PostgreSQL 安裝移植,(它們可能用的不是預設 DateStyle 設置), 我們應該在使用 COPY 前把 DateStyle 設置為 ISO。
COPY 在第一個錯誤處停下來。這些在 COPY TO中不應該導致問題, 但在 COPY FROM 時目的資料表會已經接收到早先的行, 這些行將不可見或不可訪問,但是仍然會佔據磁盤空間。 如果您碰巧是拷貝很大一塊資料文件的話, 積累起來,這些東西可能會佔據相當大的一部分磁盤空間。您可以調用 VACUUM 來恢復那些磁盤空間。
當不帶 BINARY 或者 CSV 選項使用 COPY 時, 讀寫的文件是一個文本文件,每行代資料表資料表中一個行。 行中的列(字串)用分隔符分開。 字串值本身是由與每個字串類型相關的輸出函數生成的字元串, 或者是輸入函數可接受的字串。 資料中使用特定的空值字串資料表示那些為 NULL 的字串。 如果輸入文件的任意行包含比預期多或者少的字串,那麼 COPY FROM 將拋出一個錯誤。 如果聲明了 OIDS,那麼 OID 將作為第一個字串讀寫, 放在所有用戶字串前面。
資料的結束可以用一個只包含反斜槓和句點(\.)的行資料表示。 如果從文件中讀取資料,那麼資料結束的標記是不必要的, 因為文件結束起的作用就很好了;但是在 3.0 之前的客戶端協議裡,如果在客戶端應用之間拷貝資料, 那麼必須要有結束標記。
反斜槓字元(\)可以用在 COPY 裡給那些會有歧義的字元進行逃逸(否則那些字元會被當做行或者字串分隔符處理)。 特別是下面的字元如果是字串值的一部分時,必須前綴一個反斜槓:反斜槓本身,換行符,回車,以及目前分隔符。
聲明的空字串被 COPY TO 不加任何反斜槓發送;與之相對,COPY FROM 在刪除反斜槓之前拿它的輸入與空字串比較。因此,像 \N 這樣的空字串不會和實際資料值 \N 之間混淆(因為後者會資料表現成 \\N)。
COPY FROM 識別下列特殊反斜槓序列:
| 序列 | 代資料表物 |
|---|---|
| \b | 反斜槓 (ASCII 8) |
| \f | 進紙 (ASCII 12) |
| \n | 換行符 (ASCII 10) |
| \r | 回車 (ASCII 13) |
| \t | Tab (ASCII 9) |
| \v | 垂直製資料表符 (ASCII 11) |
| \digits | 反斜槓後面跟著一到三個八進制數,資料表示ASCII值為該數的字元 |
絕對不要把反斜槓放在一個資料字元N或者句點(.)前面。 這樣的組合將分別被誤認為是空字串或者資料結束標記。 另外一個沒有在上面的資料表中列出的反斜槓字元就是它自己。
我們強烈建議生成 COPY 資料的應用把換行符和回車分別轉換成 \n 和 \r 序列。 目前我們可以用一個反斜槓和一個回車資料表示一個資料回車,以及用一個反斜槓和一個換行符資料表示一個資料換行符。 不過,這樣的資料表示在將來的版本中預設時可能不會被接受。 並且,如果在不同機器之間傳遞 COPY 文件,也是非常容易出錯的 (比如在 Unix 和 Windows 之間)。
COPY TO 將再每行的結尾是用一個 Unix 風格的換行符("\n"), 或者是在 Microsoft Windows 上執行的伺服器上用("\r\n")標記一行終止,但只是用於COPY到伺服器文件裡; 為了在不同平台之間一致,COPY TO STDOUT 總是發送 "\n",不管伺服器平台是什麼。 COPY FROM 可以處理那些以回車符,或者換行符,或者回車換行符作為行結束的資料。 為了減少在資料中出現的未逃逸的新行或者回車導致的錯誤,如果輸入的行結尾不像上面這些符號, COPY FROM 會發出警告。
這個格式用於輸入和輸出逗號分隔數值(CSV)文件格式, 許多其它程序都用這個文件格式,比如電子報資料表。這個模式下生成並識別逗號分隔的 CSV 逃逸機制, 而不是使用 PostgreSQL 標準文本模式的逃逸。
每條記錄的值都是用 DELIMITER 字元分隔的。 如果數值本身包含分隔字元,QUOTE 字元,NULL 字串, 一個回車,或者進行字元,那麼整個數值用 QUOTE 字元前綴和後綴(包圍), 並且數值裡任何 QUOTE 字元或者 ESCAPE 字元都前導逃逸字元。 您也可以使用 FORCE QUOTE 在輸出非 NULL 的指定字串值時強制引號包圍。
CSV 格式沒有標準的辦法區分一個 NULL 值和一個空字串。 PostgreSQL 的 COPY 透過引號包圍來處理這些。 一個當作 NULL 輸出的 NULL 值是沒有引號包圍的, 而匹配 NULL 字串的資料值是用引號包圍的。 因此,使用預設設置時,一個 NULL 是寫做一個無引號包圍的空字串, 而一個空字串寫做雙引號包圍("")。讀取數值也遵循類似的規則。 您可以使用 FORCE NOT NULL 來避免為特定字串進行 NULL 比較。
注意: CSV 模式可以識別和生成帶有引號包圍的回車和進行(hang)的 CVS 文件。 因此這些文件並不像文本模式的文件那樣嚴格地每個資料行一行。 不過,如果任何字串本身包含並不匹配 CVS 文件本身的換行符序列, 那麼 PostgreSQL 會拒絕 COPY 輸入。通常,輸入包含行結束符的資料的時候,用文本或者二進制格式比 CSV 更安全。
注意: 許多程序生成奇怪的並且有時候不正確的 CVS 文件, 所以這個文件格式更像一種慣用格式,而不是一種標準。 因此您可能碰到一些不能使用這個機制輸入的文件,而 COPY 也可能生成一些其它程序不能處理的文件。
在PostgreSQL 7.4 中的 COPY BINARY 的文件格式做了變化。新格式由一個文件頭,零或多條資料, 以及文件尾組成。文件頭和資料現在是網絡字元序。
文件頭由 15 個字元的固定域組成,後面跟著一個變長的頭擴展區。 固定域是:
11-字元的序列 "PGBCOPY\n\377\r\n\0" — 請注意字元零是簽名是要求的一部分。 (使用這個簽名是為了讓我們能夠很容易看出文件是否已經被一個非 8 位安全的轉換器給糟蹋了。 這個簽名會被行結尾轉換過濾器,刪除字元零,刪除高位,或者奇偶的改變而改變。)
32 位整數掩碼資料表示該文件格式的重要方面。 位是從 0(LSB)到 31 (MSB)編碼的 — 請注意這個域是以網絡字元序儲存的(高位在前), 後繼的整數都是如此。位 16 - 31 是保留用做關鍵文件格式訊息的; 如果讀者發現一個不認識的位出現在這個範圍內,那麼它應該退出。 位 0-15 都保留為標誌向後兼容的格式使用;讀者可以忽略這個範圍內的不認識的位。目前只定義了一個標誌位,而其它的必須是零:
如果為 1,那麼在資料中包括了 OID;如果為 0,則沒有
32 位整數,以字元計的頭剩餘長度,不包括自身。目前,它是零, 後面緊跟第一條資料。對該格式的更多的修改都將允許額外的資料出現在頭中。 讀者應該忽略任何它不知道該如何處理的頭擴展資料。
頭擴展資料是一個用來保留一個自定義的資料序列塊用的。這個標誌域無意告訴讀者擴展區的內容是什麼。頭擴展的具體設計內容留給以後的版本用。
這樣設計就允許向下兼容頭附加(增加頭擴展塊,或者設置低位序標誌位)以及非向下兼容修改(設置高位標誌位以標識這樣的修改, 並且根據需要向擴展區域增加支援資料)。
每條資料都以一個 16 位整數計數開頭,該計數是資料中字串的數目。 (目前,在一個資料表裡的每條資料都有相同的計數,但可能不會永遠這樣。) 然後後面不斷出現資料中的各個字串,字串先是一個 32 位的長度字,後面跟著那麼長的字串資料。 (長度字並不包括自己,並且可以為零。)一個特例是:-1 資料表示一個 NULL 字串值。 在 NULL 情況下,後面不會跟著數值字元。
在資料域之間沒有對奇填充或者任何其它額外的資料。
目前,一個 COPY BINARY 文件裡的所有資料值都假設是二進制格式的(格式代碼為一)。 預計將來的擴展可能增加一個頭域,允許為每個字串聲明格式代碼。
為了判斷實際資料資料的正確的二進制格式,您應該閱讀 PostgreSQL 原始碼, 特別是該字串資料類型的 *send 和 *recv 函數(典型的函數可以在原始碼的 src/backend/utils/adt/ 目錄找到)。
如果在文件中包括了 OID,那麼該 OID 域立即跟在字串計數字後面。 它是一個普通的字串,只不過它沒有包括在字串計數。但它包括長度字 --- 這樣就允許我們不用花太多的勁就可以處理 4 字元和 8 字元的 OID,並且如果某個傢伙允許 OID 是可選的話,那麼還可以把 OID 顯示成空。
下面的例子把一個資料表拷貝到客戶端, 使用豎直條(|)作為域分隔符:
COPY country TO STDOUT WITH DELIMITER '|';
從一個 Unix 文件中拷貝資料到一個country資料表中:
COPY country FROM '/usr1/proj/bray/sql/country_data';
下面是一個可以從 STDIN 中拷貝資料到資料表中的例子:
AF AFGHANISTAN AL ALBANIA DZ ALGERIA ZM ZAMBIA ZW ZIMBABWE
請注意在這裡每行裡的空白實際上是一個水平製資料表符 tab。
下面的是同樣的資料,在一台 Linux/i586 機器上以二進制形式輸出。 這些資料是用 Unix 工具 od -c 過濾之後輸出的。 該資料表有三個字串;第一個是 char(2), 第二個是 text, 第三個是integer。所有的行在第三個域都是一個 null 值。
0000000 P G C O P Y \n 377 \r \n \0 \0 \0 \0 \0 \0 0000020 \0 \0 \0 \0 003 \0 \0 \0 002 A F \0 \0 \0 013 A 0000040 F G H A N I S T A N 377 377 377 377 \0 003 0000060 \0 \0 \0 002 A L \0 \0 \0 007 A L B A N I 0000100 A 377 377 377 377 \0 003 \0 \0 \0 002 D Z \0 \0 \0 0000120 007 A L G E R I A 377 377 377 377 \0 003 \0 \0 0000140 \0 002 Z M \0 \0 \0 006 Z A M B I A 377 377 0000160 377 377 \0 003 \0 \0 \0 002 Z W \0 \0 \0 \b Z I 0000200 M B A B W E 377 377 377 377 377 377
在 SQL 標準裡沒有 COPY 語句。
PostgreSQL 7.3 以前使用下面的語法,現在仍然支援:
COPY [ BINARY ] tablename [ WITH OIDS ]
FROM { 'filename' | STDIN }
[ [USING] DELIMITERS 'delimiter' ]
[ WITH NULL AS 'null string' ]
COPY [ BINARY ] tablename [ WITH OIDS ]
TO { 'filename' | STDOUT }
[ [USING] DELIMITERS 'delimiter' ]
[ WITH NULL AS 'null string' ]