COPY

Name

COPY -- 在表和檔案之間複製資料

Synopsis

COPY tablename [ ( column [, ...] ) ]

FROM { 'filename' | STDIN }

[ [ WITH ]

[ BINARY ]

[ OIDS ]

[ DELIMITER [ AS ] 'delimiter' ]

[ NULL [ AS ] 'null string' ]

[ CSV [ HEADER ]

[ 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）模式。

HEADER

宣告檔案包含一個頭標識行，包含檔案中每個欄位的名字。輸出時，的一行包含表的欄位名，輸入時，第一行被忽略。

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值為該數的字元
\xdigits	反斜槓 x 後面跟著一個或兩個十六進位制位宣告指定數值編碼的字元

目前，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 模式下，所有字元都是有效的。一個被空白包圍的引號包圍數值，或者任何非 DELIMITER 的字元都將會被包含在字元裡。如果你從某些會給 CSV 行填充空白的系統裡輸入資料到定長欄位，那麼可能會導致錯誤。如果出現這種情況，你可能需要先處理一下 CSV 檔案，刪除後面的空白，然後再向 PostgreSQL 裡輸入資料。

注意: CSV 模式可以識別和生成帶有引號包圍的回車和換行的 CVS 檔案。因此這些檔案並不像文字模式的檔案那樣嚴格地每個資料行一行。

注意: 許多程式生成奇怪的並且有時候不正確的 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';

使用一個會被自動刪除的臨時表，把 'A' 開頭的國家名複製到一個檔案裡：

BEGIN;

CREATE TEMP TABLE a_list_countries AS

SELECT * FROM country WHERE country_name LIKE 'A%';

COPY a_list_countries TO '/usr1/proj/bray/sql/a_list_countries.copy';

ROLLBACK;

下面是一個可以從 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' ]

COPY語法

相關文章