openGauss SQL语法 —COPY（1）

COPY

功能描述

通过COPY命令实现在表和文件之间拷贝数据。

COPY FROM从一个文件拷贝数据到一个表，COPY TO把一个表的数据拷贝到一个文件。

注意事项

• 当参数enable_copy_server_files关闭时，只允许初始用户执行COPY FROM FILENAME或COPY TO FILENAME命令，当参数enable_copy_server_files打开，允许具有SYSADMIN权限的用户或继承了内置角色gs_role_copy_files权限的用户执行，但默认禁止对数据库配置文件、密钥文件、证书文件和审计日志执行COPY FROM FILENAME或COPY TO FILENAME，以防止用户越权查看或修改敏感文件。
• COPY只能用于表，不能用于视图。
• COPY TO需要读取的表的select权限，copy from需要插入的表的insert权限。
• 如果声明了一个字段列表，COPY将只在文件和表之间拷贝已声明字段的数据。如果表中有任何不在字段列表里的字段，COPY FROM将为那些字段插入缺省值。
• 如果声明了数据源文件，服务器必须可以访问该文件；如果指定了STDIN，数据将在客户前端和服务器之间流动，输入时，表的列与列之间使用TAB键分隔，在新的一行中以反斜杠和句点（\.）表示输入结束。
• 如果数据文件的任意行包含比预期多或者少的字段，COPY FROM将抛出一个错误。
• 数据的结束可以用一个只包含反斜杠和句点（\.）的行表示。如果从文件中读取数据，数据结束的标记是不必要的；如果在客户端应用之间拷贝数据，必须要有结束标记。
• COPY FROM中\N为空字符串，如果要输入实际数据值\N ，使用\\N。
• COPY FROM不支持在导入过程中对数据做预处理（比如说表达式运算、填充指定默认值等）。如果需要在导入过程中对数据做预处理，用户需先把数据导入到临时表中，然后执行SQL语句通过运算插入到表中，但此方法会导致I/O膨胀，降低导入性能。
• COPY FROM在遇到数据格式错误时会回滚事务，但没有足够的错误信息，不方便用户从大量的原始数据中定位错误数据。
• COPY FROM/TO适合低并发，本地小数据量导入导出。
• 目标表存在trigger，支持COPY操作。
• COPY命令中，生成列不能出现在指定列的列表中。使用COPY… TO导出数据时，如果没有指定列的列表，则该表的所有列除了生成列都会被导出。COPY… FROM导入数据时，生成列会自动更新，并像普通列一样保存。

语法格式

• 从一个文件复制数据到一个表。

    COPY table_name [ ( column_name [, ...] ) ]
  
    FROM { 'filename' | STDIN }
  
    [ [ USING ] DELIMITERS 'delimiters' ]
  
    [ WITHOUT ESCAPING ]
  
    [ LOG ERRORS ]
  
    [ LOG ERRORS DATA ]
  
    [ REJECT LIMIT 'limit' ]
  
    [ [ WITH ]
  
        ( option [, ...] )
  
        | ( copy_option [, ...] )
  
        | [ TRANSFORM ( { column_name [ data_type ] [ AS transform_expr ] } [, ...] ) ]
  
        | [ FIXED FORMATTER ( { column_name( offset, length ) } [, ...] ) ]
  
    ]
  

  

   说明：

  • 上述语法中fixed formatter与copy_option语法兼容、与option语法不兼容；copy_option与option语法不兼容；transform与copy_option、fixed formatter语法兼容。

• 把一个表的数据拷贝到一个文件。

  COPY table_name [ ( column_name [, ...] ) ]
      TO { 'filename' | STDOUT }
      [ [ USING ] DELIMITERS 'delimiters' ]
      [ WITHOUT ESCAPING ]
      [ [ WITH ] ( option [, ...] ) ]
      | copy_option
      | [ FIXED FORMATTER ( { column_name( offset, length ) } [, ...] ) ];
  
  COPY query
      TO { 'filename' | STDOUT }
      [ WITHOUT ESCAPING ]
      [ [ WITH ] ( option [, ...] ) ]
      | copy_option
      | [ FIXED FORMATTER ( { column_name( offset, length ) } [, ...] ) ];
  

  

   说明：

  1. COPY TO语法形式约束如下： (query)与[USING] DELIMITER不兼容，即若COPY TO的数据来自于一个query的查询结果，那么COPY TO语法不能再指定[USING] DELIMITERS语法子句。
  2. 对于FIXED FORMATTTER语法后面跟随的copy_option是以空格进行分隔的。
  3. copy_option是指COPY原生的参数形式，而option是兼容外表导入的参数形式。
  4. 语法中的FIXED FORMATTER ( { column_name( offset, length ) } [, …] )以及 [ ( option [, …] ) | copy_option [ …] ] 可以任意排列组合。

  其中可选参数option子句语法为：

  FORMAT format_name
  | OIDS [ boolean ]
  | DELIMITER 'delimiter_character'
  | NULL 'null_string'
  | HEADER [ boolean ]
  | FILEHEADER 'header_file_string'
  | FREEZE [ boolean ]
  | QUOTE 'quote_character'
  | ESCAPE 'escape_character'
  | EOL 'newline_character'
  | NOESCAPING [ boolean ]
  | FORCE_QUOTE { ( column_name [, ...] ) | * }
  | FORCE_NOT_NULL ( column_name [, ...] )
  | ENCODING 'encoding_name'
  | IGNORE_EXTRA_DATA [ boolean ]
  | FILL_MISSING_FIELDS [ boolean ]
  | COMPATIBLE_ILLEGAL_CHARS [ boolean ]
  | DATE_FORMAT 'date_format_string'
  | TIME_FORMAT 'time_format_string'
  | TIMESTAMP_FORMAT 'timestamp_format_string'
  | SMALLDATETIME_FORMAT 'smalldatetime_format_string'
  

  其中可选参数copy_option子句语法为：

  OIDS
  | NULL 'null_string'
  | HEADER
  | FILEHEADER 'header_file_string'
  | FREEZE
  | FORCE NOT NULL column_name [, ...]
  | FORCE QUOTE { column_name [, ...] | * }
  | BINARY
  | CSV
  | QUOTE [ AS ] 'quote_character'
  | ESCAPE [ AS ] 'escape_character'
  | EOL 'newline_character'
  | ENCODING 'encoding_name'
  | IGNORE_EXTRA_DATA
  | FILL_MISSING_FIELDS
  | COMPATIBLE_ILLEGAL_CHARS
  | DATE_FORMAT 'date_format_string'
  | TIME_FORMAT 'time_format_string'
  | TIMESTAMP_FORMAT 'timestamp_format_string'
  | SMALLDATETIME_FORMAT 'smalldatetime_format_string'