PostgreSQL Copy 命令

COPY --  在表和文件之間拷貝數據

Synopsis

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，數據通過連接在客戶前端和服務器之間流動。

參數

tablename

現存表的名字（可以有模式修飾）。

column

可選的待拷貝字段列表。如果沒有聲明字段列表，那么將使用所有字段。

filename

輸入或輸出文件的絕對路徑名。

STDIN

聲明輸入是來自客戶端應用。

STDOUT

聲明輸入前往客戶端應用。

BINARY

使用二進制格式存儲和讀取，而不是以文本的方式。 在二進制模式下，不能聲明 DELIMITERS，NULL 或者 CSV 選項。

OIDS

聲明為每行拷貝內部對象標識（OID）。 （如果給那些沒有 OID 的表聲明了 OIDS 選項，則拋出一個錯誤。）

delimiter

用於在文件中每行中分隔各個字段的單個字符。 在文本模式下，缺省是水平制表符（tab），在 CSV 模式下是一個逗號。

null string

個代表 NULL 值的字串。在文本模式下缺省是 \N （反斜杠-N）， 在 CSV 模式下是一個沒有引號的空值。 如果你不想區分空值和空字串，那么即使在文本模式下可能你也會用一個空字串。

注意: 在使用 COPY FROM 的時候，任何匹配這個字串的字串將被存儲為 NULL 值， 所以你應該確保你用的字串和COPY TO相同。

CSV

打開逗號分隔變量（CSV）模式。

quote

聲明 CSV 模式里的引號字符。缺省是雙引號。

escape

聲明在 CSV 模式下應該出現在數據里 QUOTE 字符值前面的字符。 缺省是 QUOTE 值（通常是雙引號）。

FORCE QUOTE

在 CSV COPY TO 模式下，強制在每個聲明的字段周圍對所有非 NULL 值都使用引號包圍。 NULL 從不會被引號包圍。

FORCE NOT 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值為該數的字符

目前，COPY TO 將絕不會發出一個八進制反斜杠序列， 但是它的確使用了上面列出的其它字符用於控制字符。

絕對不要把反斜杠放在一個數據字符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）文件格式， 許多其它程序都用這個文件格式，比如電子報表。這個模式下生成並識別逗號分隔的 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 都保留為標志向后兼容的格式使用；讀者可以忽略這個范圍內的不認識的位。目前只定義了一個標志位，而其它的必須是零：

Bit 16

如果為 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 顯示成空。

文件尾

文件尾包括保存着 -1 的一個 16 位整數字。這樣就很容易與一條元組的域計數字相區分。

如果一個域計數字既不是 -1 也不是預期的字段的數目，那么讀者應該報錯。 這樣就提供了對丟失與數據的同步的額外的檢查。

例子

下面的例子把一個表拷貝到客戶端， 使用豎直條（|）作為域分隔符：

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' ]

原文來自：http://blog.sina.com.cn/s/blog_73094447010158zr.html