COPY

Name

COPY  --  在表和文件之间拷贝数据

Synopsis

COPY table [ ( column [, ...] ) ]
    FROM { 'filename' | stdin }
    [ [ WITH ]
          [ BINARY ]
          [ OIDS ]
          [ DELIMITER [ AS ] 'delimiter' ]
          [ NULL [ AS ] 'null string' ] ]
COPY table [ ( column [, ...] ) ]
    TO { 'filename' | stdout }
    [ [ WITH ]
          [ BINARY ]
          [ OIDS ]
          [ DELIMITER [ AS ] 'delimiter' ]
          [ NULL [ AS ] 'null string' ] ]
  

输入

table

现存表的名字(可能有大纲修饰).

column

可选的待拷贝字段列表。如果没有声明字段列表, 那么将使用所有字段。

filename

输入或输出的 Unix 文件的绝对路径名.

stdin

声明输入是来自客户端应用.

stdout

声明输入前往客户端应用.

BINARY

使用二进制格式存储和读取, 而不是以文本的方式. 在二进制模式下,不能声明 DELIMITERSNULL

OIDS

声明为每行拷贝内部对象标识(OID)。

delimiter

用于在文件中每行中分隔各个字段的单个字符.

null string

个代表 NULL 值的字串。缺省是 "\N" (反斜杠-N)。 当然,你可以自己挑一个空字串。

注意: 对于拷贝入(copy in),任何匹配这个字串的字串将被存储为 NULL 值, 所以你应该确保你用 的字串和拷贝出(copy out)相同。

输出

COPY

拷贝成功完成.

ERROR: reason

拷贝失败,原因在错误信息里.

描述

COPYPostgreSQL表和标准文件系统文件之间交换数据. COPY TO 把一个表的所有内容都拷贝到一个文件, 而 COPY FROM 从一个文件里拷贝数据到一个表里 (把数据附加到表中已经存在的内容里).

如果声明了一个字段列表,COPY 将只在文件和表之间拷贝声明的 字段的数据。如果表中有任何不在字段列表里的字段,那么 COPY FROM 将为那些字段插入缺省值。

带文件名的 COPY 指示 PostgreSQL 后端直接从文件中读写数据. 如果声明了文件名,那么该文件必须为后 端可见,而且文件名必须从后端的角度声明.如果声明的是 stdinstdout, 数据通过客户前端流到后端.

小提示: 不要把 COPYpsql 指令 \copy 混淆在一起. \copy 调用 COPY FROM stdinCOPY TO stdout,然后抓取/存储 psql 客户端可以访问的一个文件里. 因此,使用 \copy 的时候, 可访问性和访问权限取决于客户端而不是服务器端.

注意

BINARY 关键字将强制使用二进制对象而不是文本存储/读取所有数据. 这样做在一定程度上比传统的拷贝命令快,但二进制拷贝文件在不同机器体系间 的植性不是很好.

缺省地,文本拷贝使用 tab ("\t")字符作为分隔符. 分隔符仍然可以用关键字 DELIMITER 改成任何其它的字符. 在数据中碰巧与分隔符相同的字符将用反斜扛引起.

你对任何要COPY 出来的数据必须有select 权限,对任何要 COPY 入数据的表必须有 insert 或 update 权限. 使用 COPY 时后端同样需要适当的对文件操作的 Unix 权限.

COPY FROM 会激活所有触发器和检查约束。不过,不会激活规则。

COPY 在第一个错误处停下来.这些在 COPY TO中不应该导致问题,但在 COPY FROM 时目的表会已经接收到早先的行, 这些行将不可见或不可访问,但是仍然会占据磁盘空间. 如果你碰巧是拷贝很大一块数据文件的话, 积累起来,这些东西可能会占据相当大的一部分磁盘空间. 你可以调用 VACUUM 来恢复那些磁盘空间.

COPY 命令里面的文件必须是可以由后端直接读或写的 文件,而不是由客户端应用读写. 因此,它们必须位于数据库服务器上或者可以为数据库服务器所访问, 而不是由客户端做这些事情. 它们必须是PostgreSQL用户(服务器运行的用户 ID) 可以访问到并且 可读或者可写,而不是客户端. COPY 到一个命名文件是只允许数据库超级用户进行的, 因为它允许读写任意后端有权限访问的文件.

小技巧: psql 指令 \copy 以客户的权限读或写在客户端的文件,因此不局限于超级用户.

我们建议在 COPY 里的文件名字总是使用 绝对路径.在 COPY TO 的时候是由后端强制 进行的,但是对于 COPY FROM,你的确有从一个 声明为相对路径的文件里读取的选择.该路径将解释为相对于后端的 工作目录(在 $PGDATA 里的什么地方), 而不是客户端的工作目录.

文件格式

文本格式

当不带 BINARY 选项使用 COPY 时, 读写的文件是一个文本文件,每行代表表中一个行. 行中的列(字段)用分隔符分开. 字段值本身是由与每个字段类型相关的输出函数生成的字符串, 或者是输入函数可接受的字串. 数据中使用特定的空值字串表示那些为 NULL 的字段. 如果输入文件的任意行包含比预期多或者少的字段,那么 COPY FROM 将抛出一个错误。

如果声明了 OIDS,那么 OID 将从每行的开头读写, 在用户数据字段之前.(如果给那些没有 OID 的表声明了 OIDS 选项, 那么会抛出一个错误.)

数据的结束可以用一个只包含反斜扛和句点(\.)的行表示. 如果从 Unix 文件中读取数据,那么数据结束的标记是不必要的, 因为文件结束起的作用就很好了;但是如果在客户端应用之间拷贝数据, 那么必须要有结束标记.

反斜扛字符(\)可以用在 COPY 里给那些会有歧义的字符进行逃逸(否则那些字符会被当做行或者字段分隔符 处理).特别是下面的字符如果是字段值的一部分时, 必须前缀一个反斜扛∶反斜扛本身,换行符,以及当前分隔符.

COPY FROM 识别下列特殊反斜扛序列∶

序列代表物
\b反斜扛 (ASCII 8)
\f进纸 (ASCII 12)
\n换行符 (ASCII 10)
\r回车 (ASCII 13)
\tTab (ASCII 9)
\v垂直制表符 (ASCII 11)
\digits反斜扛后面跟着一到三个八进制数,表示ASCII值为该数的字符

目前,COPY TO 将绝不会发出一个八进制反斜扛序列, 但是它的确使用了上面列出的其它字符用于控制字符.

绝对不要把反斜扛放在一个数据字符N或者句点 (.)前面.这样的组合将分别被误认为是空字串或者数据结束标记. 另外一个没有在上面的表中列出的反斜扛字符就是它自己.

我们强烈建议生成 COPY 数据的应用八换行符和回车分别转换成 \n\r 序列. 目前(PostgreSQL 7.2 和更老的版本), 我们可以不用任何特殊的逃逸表示一个数据回车,以及用一个反斜扛和 一个换行符表示一个数据换行符.不过,这样的表示在将来的版本中 缺省时将不会被接受.

请注意每行的结尾是用一个 Unix 风格的换行符("\n")标记的. 目前,如果给出的文件包含 DOS- 或者 Mac 风格的换行符, COPY FROM 将不能按照设想运转. 我们准备在将来的版本中修补这个问题.

二进制格式

PostgreSQLv7.1 中的 COPY BINARY 的文件格式做了变化.新格式由一个文件头,零或多条元组, 以及文件尾组成.

文件头

文件头由 24 个字节的固定域组成,后面跟着一个变长的头扩展区. 固定域是:

签名

12-字节的序列 "PGBCOPY\n\377\r\n\0" --- 请注意空是签名是要求的一部分. (使用这个签名是为了让我们能够很容易看出文件是否已经被一个非 8 位安全 的转换器给糟蹋了.这个签名会被换行符转换过滤器,删除空,删除高位, 或者奇偶的改变而改变.)

整数布局域

以源机器的字节序的 int32 常量 0x1020304. 如果在这里侦测到错误的字节序,那么读者很可能在后面的 字段列造成了字节错位.

标志域

int32 位掩码表示该文件格式的重要方面. 位是从 0(LSB)到 31 (MSB)编码的 --- 请注意这个域是以源机器的端序 存储的,后继的整数都是如此.位 16 - 31 是保留用做关键文件格式的; 如果读者发现一个不认识的位出现在这个范围内,那么它应该退出. 位 0-15 都保留为标志向后兼容的格式使用;读者可以忽略这个范围内的 不认识的位.目前只定义了一个标志位,而其它的必须是零:

Bit 16

如果为 1,那么在倾倒中包括了 OID;如果为 0,则没有

头扩展范围长度

int32 以字节计的头剩余长度,不包括自身.在初始的版本里,它将会是零, 后面紧跟第一条元组.对该格式的更多的修改都将允许额外的数据出现在头中. 读者应该忽略任何它不知道该如何处理的头扩展数据.

头扩展数据是一个用来保留一个自定义的数据训练用的.这个标志域无意告诉读者 扩展区的内容是什么.头扩展的具体设计内容留给以后的版本用.

这样设计就允许向下兼容头附加(增加头扩展块,或者设置低位序标志位) 以及非向下兼容修改(设置高位标志位以标识这样的修改,并且根据需要 向扩展区域增加支持数据).

元组

每条元组都以一个 int16 计数开头,该计数是元组中字段的数目. (目前,在一个表里的每条元组都有相同的计数,但可能不会永远这样.) 然后后面不断出现元组中的各个字段,在字段数据后面可能跟着一个 int16 typlen字. typlen域是这样解释的:

数据域是 NULL.没有数据跟着.

> 0

数据域是定长数据类型.typlen 字后面跟着准确的 N 个字节.

-1

数据域是变长的数据类型.下面四个字节是变长头, 它包含包括其自身在内的所有值长度.

< -1

保留为将来使用.

对于非 NULL 域,读者可以检查这个typlen是否匹配目标列的typlen. 这样就提供了一种简单但有用的检查,核实该数据是否预期数据.

在数据域之间没有对奇填充或者任何其它额外的数据. 还要注意该格式并不区分一种数据类型是传值还是传参. 这些东西都是非常有意的:它们可能可以提高这些文件的移植性 (尽管端序和浮点格式等问题可能仍然不能让你进行跨机器移动二进制数据).

如果在倾倒中包括了 OID,那么该 OID 域立即跟在域计数字后面. 它是一个普通的域,只不过它没有包括在域计数.但它包括typlen --- 这样就允许我们不用花太多的劲就可以处理 4 字节和 8 字节,并且 如果某个家伙允许 OID 是可选的话,那么还可以把 OID 显示成 NULL.

文件尾

文件尾包括一个 int16 字减 1.这样就很容易与一条元组的域计数字 相区分.

如果一个域计数字既不是 -1 也不是预期的字段的数目,那么读者应该报错. 这样就提供了对丢失与数据的同步的额外的检查.

用法

下面的例子把一个表拷贝到标准输出, 使用竖直条(|)作为域分隔符:

COPY country TO stdout WITH DELIMITERS '|';
  

从一个 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   B   C   O   P   Y  \n 377  \r  \n  \0 004 003 002 001
0000020  \0  \0  \0  \0  \0  \0  \0  \0 003  \0 377 377 006  \0  \0  \0
0000040   A   F 377 377 017  \0  \0  \0   A   F   G   H   A   N   I   S
0000060   T   A   N  \0  \0 003  \0 377 377 006  \0  \0  \0   A   L 377
0000100 377  \v  \0  \0  \0   A   L   B   A   N   I   A  \0  \0 003  \0
0000120 377 377 006  \0  \0  \0   D   Z 377 377  \v  \0  \0  \0   A   L
0000140   G   E   R   I   A  \0  \0 003  \0 377 377 006  \0  \0  \0   Z
0000160   M 377 377  \n  \0  \0  \0   Z   A   M   B   I   A  \0  \0 003
0000200  \0 377 377 006  \0  \0  \0   Z   W 377 377  \f  \0  \0  \0   Z
0000220   I   M   B   A   B   W   E  \0  \0 377 377
  

兼容性

SQL92

在 SQL92 里没有 COPY 语句.

7.3 以前的应用使用下面的语法,现在仍然支持:

    COPY [ BINARY ] table [ WITH OIDS ]
        FROM { 'filename' | stdin }
        [ [USING] DELIMITERS 'delimiter' ]
        [ WITH NULL AS 'null string' ]
    COPY [ BINARY ] table [ WITH OIDS ]
        TO { 'filename' | stdout }
        [ [USING] DELIMITERS 'delimiter' ]
        [ WITH NULL AS 'null string' ]