华为云用户手册

示例 将tpcds.ship_mode中的数据拷贝到/home/omm/ds_ship_mode.dat文件中： 1 COPY tpcds.ship_mode TO '/home/omm/ds_ship_mode.dat'; 将tpcds.ship_mode输出到stdout： 1 COPY tpcds.ship_mode TO stdout; 创建tpcds.ship_mode_t1表： 1 2 3 4 5 6 7 8 9 10 11 CREATE TABLE tpcds.ship_mode_t1 ( SM_SHIP_MODE_SK INTEGER NOT NULL, SM_SHIP_MODE_ID CHAR(16) NOT NULL, SM_TYPE CHAR(30) , SM_CODE CHAR(10) , SM_CARRIER CHAR(20) , SM_CONTRACT CHAR(20) ) WITH (ORIENTATION = COLUMN,COMPRESSION=MIDDLE) DISTRIBUTE BY HASH(SM_SHIP_MODE_SK ); 从stdin拷贝数据到表tpcds.ship_mode_t1： 1 COPY tpcds.ship_mode_t1 FROM stdin; 从/home/omm/ds_ship_mode.dat文件拷贝数据到表tpcds.ship_mode_t1： 1 COPY tpcds.ship_mode_t1 FROM '/home/omm/ds_ship_mode.dat'; 从/home/omm/ds_ship_mode.dat文件拷贝数据到表tpcds.ship_mode_t1，使用参数如下：导入格式为TEXT（format 'text'），分隔符为'\t'（delimiter E'\t'），忽略多余列（ignore_extra_data 'true'），不指定转义（noescaping 'true'）： 1 COPY tpcds.ship_mode_t1 FROM '/home/omm/ds_ship_mode.dat' WITH(format 'text', delimiter E'\t', ignore_extra_data 'true', noescaping 'true'); 从/home/omm/ds_ship_mode.dat文件拷贝数据到表tpcds.ship_mode_t1，使用参数如下：导入格式为FIXED（FIXED），指定定长格式（FORMATTER(SM_SHIP_MODE_SK(0, 2), SM_SHIP_MODE_ID(2,16), SM_TYPE(18,30), SM_CODE(50,10), SM_CARRIER(61,20), SM_CONTRACT(82,20))），忽略多余列（ignore_extra_data），有数据头（header）： 1 COPY tpcds.ship_mode_t1 FROM '/home/omm/ds_ship_mode.dat' FIXED FORMATTER(SM_SHIP_MODE_SK(0, 2), SM_SHIP_MODE_ID(2,16), SM_TYPE(18,30), SM_CODE(50,10), SM_CARRIER(61,20), SM_CONTRACT(82,20)) header ignore_extra_data; 从/home/omm/ds_ship_mode.dat文件拷贝数据到表tpcds.ship_mode_t1，使用参数如下：导入格式为FIXED（FIXED），指定定长格式（FORMATTER(SM_SHIP_MODE_SK(0, 2), SM_SHIP_MODE_ID(2,16), SM_TYPE(18,30), SM_CODE(50,10), SM_CARRIER(61,20), SM_CONTRACT(82,20))），忽略多余列（ignore_extra_data），有数据头（header），保留末尾\t字符： COPY tpcds.ship_mode_t1 FROM '/home/omm/ds_ship_mode.dat' (FORMAT 'fixed', FORMATTER (SM_SHIP_MODE_SK(0,2), SM_SHIP_MODE_ID(2,16), SM_TYPE(18,30), SM_CODE(50,10), SM_CARRIER(61,20), SM_CONTRACT(82,20)), PRESERVE_BLANKS‘true', HEADER 'true', IGNORE_EXTRA_DATA 'true'); 将tpcds.ship_mode_t1导出为OBS的 '/bucket/path/'路径上的TEXT格式文件ds_ship_mode.dat。需要指定包含OBS访问信息的“server”option参数： 1 COPY tpcds.ship_mode_t1 TO '/bucket/path/ds_ship_mode.dat' WITH (format 'text', encoding 'utf8', server 'obs_server'); 将tpcds.ship_mode_t1导出为OBS的 '/bucket/path/'路径上的 CS V格式文件。需要指定包含OBS访问信息的“server”option参数。其中文件包含标题行，包含BOM头，单文件最大行数1000行（超出1000行生成新的文件），自定义文件名前缀为“justprefix”： 1 COPY (select * from tpcds.ship_mode_t1 where SM_SHIP_MODE_SK=1060) TO '/bucket/path/' WITH (format 'csv', header 'on', encoding 'utf8', server 'obs_server', bom 'on', maxrow '1000', fileprefix 'justprefix'); 删除tpcds.ship_mode_t1： 1 DROP TABLE tpcds.ship_mode_t1;

语法格式 从一个文件拷贝数据到一个表： 1 2 3 4 5 6 7 8 9 10 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 | FIXED FORMATTER ( { column_name( offset, length ) } [, ...] ) [ ( option [, ...] ) | copy_option [ ...] ] ]; 语法中的FIXED FORMATTER ( { column_name( offset, length ) } [, ...] )以及 [ ( option [, ...] ) | copy_option [ ...] ] 可以任意排列组合。 把一个表的数据拷贝到一个文件： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 COPY table_name [ ( column_name [, ...] ) ] TO { 'filename' | STDOUT } [ [ USING ] DELIMITERS 'delimiters' ] [ WITHOUT ESCAPING ] [ [ WITH ] ( option [, ...] ) ] | copy_option | FIXED FORMATTER ( { column_name( offset, length ) } [, ...] ) [ ( option [, ...] ) | copy_option [ ...] ] ]; COPY query TO { 'filename' | STDOUT } [ WITHOUT ESCAPING ] [ [ WITH ] ( option [, ...] ) ] | copy_option | FIXED FORMATTER ( { column_name( offset, length ) } [, ...] ) [ ( option [, ...] ) | copy_option [ ...] ] ]; COPY TO语法形式约束如下： (query)与[USING] DELIMITER不兼容，即若COPY TO的数据来自于一个query的查询结果，那么COPY TO语法不能再指定[USING] DELIMITERS语法子句。 对于FIXED FORMATTER语法后面跟随的copy_option是以空格进行分隔的。 copy_option是指COPY原生的参数形式，而option是兼容外表导入的参数形式。 语法中的FIXED FORMATTER ( { column_name( offset, length ) } [, ...] )以及 [ ( option [, ...] ) | copy_option [ ...] ] 可以任意排列组合。 其中可选参数option子句语法为： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 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 ] | PRESERVE_BLANKS [ boolean ] | DATE_FORMAT 'date_format_string' | TIME_FORMAT 'time_format_string' | TIMESTAMP_FORMAT 'timestamp_format_string' | SMALLDATETIME_FORMAT 'smalldatetime_format_string' | SERVER 'obs_server_string' | BOM [ boolean ] | MAXROW [ integer ] | FILEPREFIX 'file_prefix_string' 其中可选参数copy_option子句语法为： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 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 | PRESERVE_BLANKS | DATE_FORMAT 'date_format_string' | TIME_FORMAT 'time_format_string' | TIMESTAMP_FORMAT 'timestamp_format_string' | SMALLDATETIME_FORMAT 'smalldatetime_format_string'

注意事项 禁止使用COPY FROM FILENAME或COPY TO FILENAME语法，可采用\copy的方式进行规避，请参考如何使用\copy导入导出中的示例。 COPY只能用于表，不能用于视图。 对任何要插入数据的表必须有插入权限。 如果声明了一个字段列表，COPY将只在文件和表之间拷贝已声明字段的数据。如果表中有任何不在字段列表里的字段，COPY FROM将为这些字段插入缺省值。 如果声明了数据源文件，服务器必须可以访问该文件；如果指定了STDIN，数据将在客户前端和服务器之间流动，输入时，表的列与列之间使用TAB键分隔，在新的一行中以反斜杠和句点（\.）表示输入结束。 如果数据文件的任意行包含比预期多或者少的字段，COPY FROM将抛出一个错误。 数据的结束可以用一个只包含反斜杠和句点（\.）的行表示。如果从文件中读取数据，数据结束的标记是不必要的；如果在客户端应用之间拷贝数据，必须要有结束标记。 COPY FROM中\N为空字符串，如果要输入实际数据值\N ，使用\\N。

参数说明 表2 LOCK参数说明 参数 描述 取值范围 name 要锁定的表的名字，可以有模式修饰。 LOCK TABLE命令中声明的表的顺序就是上锁的顺序。 已存在的表名。 ONLY 如果指定ONLY只有该表被锁定，如果没有指定，该表和其所有子表将都被锁定。 - AC CES S SHARE ACCESS锁只允许对表进行读取，而禁止对表进行修改。所有对表进行读取而不修改的SQL语句都会自动请求这种锁。例如，SELECT命令会自动在被引用的表上请求一个这种锁。 - ROW SHARE ROW SHARE锁允许对表进行并发读取，禁止对表进行其他操作。 SELECT FOR UPDATE和SELECT FOR SHARE命令会自动在目标表上请求ROW SHARE锁（且所有被引用但不是FOR SHARE/FOR UPDATE的其他表上，还会自动加上ACCESS SHARE锁）。 - ROW EXCLUSIVE 与ROW SHARE锁不同，ROW EXCLUSIVE允许并发读取表，也允许修改表中的数据。UPDATE，DELETE，INSERT命令会自动在目标表上请求这个锁（且所有被引用的其他表上还会自动加上的ACCESS SHARE锁）。通常情况下，所有会修改表数据的命令都会请求表的ROW EXCLUSIVE锁。 - SHARE UPDATE EXCLUSIVE 这个模式保护一个表的模式不被并发修改，以及禁止在目标表上执行垃圾回收命令（VACUUM ）。 VACUUM（不带FULL选项），ANALYZE，CREATE INDEX CONCURRENTLY命令会自动请求这样的锁。 - SHARE SHARE锁允许并发的查询，但是禁止对表进行修改。 CREATE INDEX（不带CONCURRENTLY选项）语句会自动请求这种锁。 - SHARE ROW EXCLUSIVE SHARE ROW EXCLUSIVE锁禁止对表进行任何的并发修改，而且是独占锁，因此一个会话中只能获取一次。 任何SQL语句都不会自动请求这个锁模式。 - EXCLUSIVE EXCLUSIVE锁允许对目标表进行并发查询，但是禁止任何其他操作。 这个模式只允许并发加ACCESS SHARE锁，也就是说，只有对表的读动作可以和持有这个锁模式的事务并发执行。 任何SQL语句都不会在用户表上自动请求这个锁模式。然而在某些操作的时候，会在某些系统表上请求它。 - ACCESS EXCLUSIVE 这个模式保证其所有者（事务）是可以访问该表的唯一事务。 ALTER TABLE，DROP TABLE，TRUNCATE，REINDEX，CLUSTER，VACUUM FULL命令会自动请求这种锁。 在LOCK TABLE命令没有明确声明需要的锁模式时，为缺省锁模式。 UPDATE EXCLUSIVE UPDATE EXCLUSIVE锁允许并发（AUTO）VACUUM和（AUTO）ANALYZE，但不允许多个（AUTO）VACUUM并发。 说明： 该参数仅8.2.1.200及以上集群版本支持。 UPDATE EXCLUSIVE锁模式仅在VACUUM语法中使用。 - NOWAIT 声明LOCK TABLE不去等待任何冲突的锁释放，如果无法立即获取该锁，该命令退出并且发出一个错误信息。 在不指定NOWAIT的情况下获取表级锁时，如果有其他互斥锁存在的话，则等待其他锁的释放。 - LOCAL COORDINATOR ONLY 声明LOCK TABLE只在接收当前会话请求的CN上执行，而不会下发给其他CN和所有DN。该选项仅针对元数据的操作，以提高效率。 须知： 该参数仅8.2.0.100以上集群版本支持。 当前仅支持ACCESS SHARE锁模式，其他锁模式会报错。 -

语法格式 1 2 3 LOCK [ TABLE ] {[ ONLY ] name [, ...]| {name [ * ]} [, ...]} [ IN {ACCESS SHARE | ROW SHARE | ROW EXCLUSIVE | SHARE UPDATE EXCLUSIVE | SHARE | SHARE ROW EXCLUSIVE | EXCLUSIVE | ACCESS EXCLUSIVE | UPDATE EXCLUSIVE} MODE ] [ NOWAIT ] [LOCAL COORDINATOR ONLY];

注意事项 LOCK TABLE只能在一个事务块的内部有用，因为锁在事务结束时就会被释放。出现在任意事务块外面的LOCK TABLE都会报错。 如果没有声明锁模式，缺省为最严格的模式ACCESS EXCLUSIVE。 LOCK TABLE ... IN ACCESS SHARE MODE需要在目标表上有SELECT权限。所有其他形式的LOCK需要UPDATE和/或DELETE权限。 没有UNLOCK TABLE命令，锁总是在事务结束时释放。 LOCK TABLE只处理表级的锁，因此那些带“ROW”字样的锁模式都是有歧义的。这些模式名字通常可理解为用户试图在一个被锁定的表中获取行级的锁。同样，ROW EXCLUSIVE模式也是一个可共享的表级锁。注意，只要是涉及到LOCK TABLE ，所有锁模式都有相同的语意，区别仅在于规则中锁与锁之间是否冲突，规则请参见锁等级与冲突关系。

锁等级与冲突关系 在 GaussDB (DWS)中，锁模式用于管理并发事务对资源的访问，以防止数据不一致和丢失。 表1列出了GaussDB(DWS)支持的8种常规锁模式及其锁冲突关系： 表1 锁模式间的冲突关系 锁模式名称 锁等级 锁用途 冲突关系 访问共享锁（AccessShareLock） 1 SELECT语句，允许其他事务读取数据。 8 行共享锁（RowShareLock） 2 SELECT FOR UPDATE或FOR SHARE，允许其他事务读取但阻止写入。 7|8 行排他锁（RowExclusiveLock） 3 INSERT、UPDATE、DELETE语句，阻止其他事务读取和写入。 5|6|7|8 共享更新排他锁（ShareUpdateExclusiveLock） 4 VACUUM（非FULL）、ANALYZE、CREATE INDEX CONCURRENTLY，允许其他事务读取但阻止写入。 4|5|6|7|8 共享锁（ShareLock） 5 CREATE INDEX（非CONCURRENTLY），阻止其他事务读取和写入。 3|4|6|7|8 共享行排他锁（ShareRowExclusiveLock） 6 类似RowExclusiveLock，但允许RowShareLock。 3|4|5|6|7|8 排他锁（ExclusiveLock） 7 阻止RowShareLock或SELECT ... FOR UPDATE操作。 2|3|4|5|6|7|8 访问排他锁（AccessExclusiveLock） 8 ALTER TABLE、DROP TABLE、VACUUM FULL，完全阻止其他事务读取和写入。 1|2|3|4|5|6|7|8

功能描述 LOCK TABLE获取表级锁。 当自动获取引用表的命令的锁时，GaussDB(DWS)会始终使用限制最小的锁模式。如果用户需要一种更为严格的锁模式，可以使用LOCK命令。例如，某个应用是在Read Committed隔离级别上运行事务，并且需要保证表中的数据在事务运行期间保持稳定。为实现这个目的，则可以在查询之前对表使用SHARE锁模式进行锁定。这样将防止并发数据更改，并确保后续的查询可以读到已提交的持久化的数据。因为SHARE锁模式与任何写操作需要的ROW EXCLUSIVE模式冲突，并且LOCK TABLE name IN SHARE MODE语句将等到所有当前持有ROW EXCLUSIVE模式锁的事务提交或回滚后才能执行。因此，一旦获得该锁，就不会存在未提交的写操作，此外其他操作也只能等到该锁释放之后才能开始。

test_tsc_info(time float8, loops int) 描述：测试当前节点通过TSC（TimeStamp-Counter）换算时间的准确性。该函数仅8.2.1及以上集群版本支持。 输入参数含义如下： time：测试的时间差（单位s），测试时长需要小于或者等于60s loops：测试次数，范围值[1，10] 返回值类型：record 返回值字段： id：循环次数。 real_time_diff：通过gettimeofday获取的时间差（单位us）。 est_time_scalar：通过TSC换算信息转换得到的时间差（单位us）。 est_time_frequency：通过TSC频率转换得到的时间差（单位us）。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 SELECT * FROM test_tsc_info(0.01,10); id | real_time_diff | est_time_scalar | est_time_frequency ----+----------------+-----------------+-------------------- 1 | 10057 | | 10056.9 2 | 10057 | | 10057.4816666667 3 | 10056 | | 10055.2841666667 4 | 10054 | | 10054.4908333333 5 | 10055 | | 10054.2875 6 | 10055 | | 10054.7483333333 7 | 10055 | | 10054.4725 8 | 10054 | | 10054.0766666667 9 | 10058 | | 10058.1016666667 10 | 10057 | | 10056.3733333333 (10 rows)

get_tsc_info() 描述：重新获取当前数据库节点的TSC（TimeStamp-Counter）信息。该函数仅8.2.1及以上集群版本支持。 返回值类型：record 表5 返回值字段 名称 类型 描述 node_name text 节点名称。 tsc_mult bigint TSC换算乘数。 tsc_shift bigint TSC换算位移数。 tsc_frequency float8 TSC频率。 tsc_use_frequency boolean 是否使用TSC频率进行时间换算。 tsc_ready boolean 是否可以使用TSC频率进行时间换算。 tsc_scalar_error_info text 获取TSC换算信息的错误信息。 tsc_freq_error_info text 获取TSC频率的错误信息。

show_tsc_info() 描述：查询当前数据库节点已获取的TSC（TimeStamp-Counter）信息。该函数仅8.2.1及以上集群版本支持。 返回值类型：record 表4 返回值字段 名称 类型 描述 node_name text 节点名称。 tsc_mult bigint TSC换算乘数。 tsc_shift bigint TSC换算位移数。 tsc_frequency float8 TSC频率。 tsc_use_frequency boolean 是否使用TSC频率进行时间换算。 tsc_ready boolean 是否可以使用TSC频率进行时间换算。 tsc_scalar_error_info text 获取TSC换算信息的错误信息。 tsc_freq_error_info text 获取TSC频率的错误信息。 示例： 1 2 3 4 SELECT * FROM show_tsc_info(); node_name | tsc_mult | tsc_shift | tsc_frequency | tsc_use_frequency | tsc_ready | tsc_scalar_error_info | tsc_freq_error_info --------------+----------+-----------+---------------+-------------------+-----------+-------------------------------+--------------------- coordinator1 | | | 2400 | t | t | TSC scalar is not initialized |

get_all_col_cu_info(row_count int8) 描述：查询全库所有列存表的CU信息。该函数仅8.2.0.100及以上集群版本支持。 参数：小CU的行数阈值（可选，默认值200，取值范围为1~60000。） 返回值类型：record 返回值字段： node_name：DN节点名。 schema_name：模式名。 table_name：表名。 zero_size_cu_count：cuSize=0，且行数小于等于row_count的CU数。 small_cu_count：cuSize=ALIGNOF_CUSIZE(8192)，且行数小于等于row_count的CU数。 total_cu_count：总CU数。 small_cu_size：8kCU的总大小。 total_cu_size：总CU大小。 示例： 1 2 3 4 5 6 7 8 9 10 SELECT * FROM get_all_col_cu_info(200); node_name | schema_name | table_name | zero_size_cu_count | small_cu_count | total_cu_count | small_cu_size | total_cu_size -----------+-------------+----------------------+--------------------+----------------+----------------+---------------+--------------- datanode1 | public | udi_48076 | 5 | 1 | 6 | 8192 bytes | 8192 bytes datanode1 | public | udi_48077 | 5 | 1 | 6 | 8192 bytes | 8192 bytes datanode2 | public | udi_48076 | 5 | 1 | 6 | 8192 bytes | 8192 bytes datanode2 | public | udi_48077 | 5 | 1 | 6 | 8192 bytes | 8192 bytes datanode3 | public | udi_48076 | 5 | 1 | 6 | 8192 bytes | 8192 bytes datanode3 | public | udi_48077 | 5 | 1 | 6 | 8192 bytes | 8192 bytes (6 rows)

get_all_col_file_vacuum_info(force_get_rewritten_file_num bool) 描述：查询全库所有列存表的文件vacuum相关信息。该函数仅8.2.0.100及以上集群版本支持。 参数：是否强制获取准确的可清理文件数（必选，true或false） 返回值类型：record 返回值字段： node_name：DN节点名。 schema_name：模式名。 table_name：表名。 total_file_num：总CU文件数。 rewritable_file_num：可重写，但还未重写的文件数。 rewritten_file_num：已重写未清理文件数，此值来源于内存态ClearCache，若由于重启等原因ClearCache丢失，可通过设置force_get_rewritten_file_num=true，消耗额外的时间，强制获取准确的可清理文件数。 empty_file_num：已清理文件数。 示例： 1 2 3 4 5 6 7 8 9 SELECT * FROM get_all_col_file_vacuum_info(false); node_name | schema_name | table_name | total_file_num | rewritable_file_num | rewritten_file_num | empty_file_num -----------+-------------+----------------------+----------------+---------------------+--------------------+---------------- datanode1 | public | udi_57373 | 2 | 0 | 0 | 1 datanode1 | public | udi_57374 | 2 | 0 | 0 | 1 datanode2 | public | udi_57373 | 2 | 0 | 0 | 1 datanode2 | public | udi_57374 | 2 | 0 | 0 | 1 datanode3 | public | udi_57373 | 2 | 0 | 0 | 1 datanode3 | public | udi_57374 | 2 | 0 | 0 | 1

get_col_file_vacuum_info(schema_name text, table_name text, force_get_rewritten_file_num bool) 描述：查询某张列存表的文件vacuum相关信息，每个分区单独统计。该函数仅8.2.0.100及以上集群版本支持。 参数：模式名（必选），表名（必选），是否强制获取准确的可清理文件数（必选，默认为false） 返回值类型：record 返回值字段： node_name：DN节点名。 part_name：分区名，普通表此列为空。 total_file_num：总CU文件数。 rewritable_file_num：可重写，但还未重写的文件数。 rewritten_file_num：已重写未清理文件数，此值来源于内存态ClearCache，若由于重启等原因ClearCache丢失，可通过设置force_get_rewritten_file_num=true，消耗额外的时间，强制获取准确的可清理文件数。 empty_file_num：已清理文件数。 示例： 1 2 3 4 5 6 7 8 9 10 SELECT * FROM get_col_file_vacuum_info('public','pa',false); node_name | part_name | total_file_num | rewritable_file_num | rewritten_file_num | empty_file_num -----------+-----------+----------------+---------------------+--------------------+---------------- datanode1 | pa1 | 1 | 0 | 0 | 0 datanode1 | pa2 | 1 | 0 | 0 | 0 datanode2 | pa1 | 1 | 0 | 0 | 0 datanode2 | pa2 | 1 | 0 | 0 | 0 datanode3 | pa1 | 1 | 0 | 0 | 0 datanode3 | pa2 | 1 | 0 | 0 | 0 (6 rows)

get_col_file_vacuum_info(schema_name text, table_name text, colvacuum_threshold_scale_factor int) 描述：查询某张列存表的文件vacuum相关信息，每个分区单独统计。该函数仅8.2.0.100及以上集群版本支持。 参数：模式名（必选），表名（必选），colvacuum_threshold_scale_factor（必选，0-100为dead tuple的比例值） 返回值类型：record 返回值： node_name：DN节点名。 part_name：分区名，普通表此列为空。 total_file_num：总CU文件数。 rewritable_file_num：可重写，但还未重写的文件数。 rewritten_file_num：已重写未清理文件数，此值来源于内存态ClearCache，若由于重启等原因ClearCache丢失，可通过设置force_get_rewritten_file_num=true，消耗额外的时间，强制获取准确的可清理文件数。 empty_file_num：已清理文件数。 示例： 1 2 3 4 5 6 7 8 9 10 SELECT * FROM get_col_file_vacuum_info('public','pa',10); node_name | part_name | total_file_num | rewritable_file_num | rewritten_file_num | empty_file_num -----------+-----------+----------------+---------------------+--------------------+---------------- datanode1 | pa1 | 1 | 0 | 0 | 0 datanode1 | pa2 | 1 | 0 | 0 | 0 datanode2 | pa1 | 1 | 0 | 0 | 0 datanode2 | pa2 | 1 | 0 | 0 | 0 datanode3 | pa1 | 1 | 0 | 0 | 0 datanode3 | pa2 | 1 | 0 | 0 | 0 (6 rows)

get_volatile_pg_attribute(relname text, attrname text) 描述：获取当前会话中指定volatile临时表相关的pg_attribute元数据。该函数仅8.2.0及以上集群版本支持。 参数： relname：表名(必须在当前会话中)。 attrname：列名。 返回值类型：record 返回值字段： oid：返回该列信息的oid。 其他字段：同pg_attribute系统表中的基础字段（不包括系统隐藏字段）。 示例： 1 2 3 4 5 6 7 8 SELECT * FROM get_volatile_pg_attribute('tx1', 'b'); attrelid | attname | atttypid | attstattarget | attlen | attnum | attndims | attcacheoff | atttypmod | attbyval | attstorage | attalign | attnotnull | atthasdef | attisdropped | attislocal | attcmprmode | attinhcount | attcollation | attacl | attoptions | attfdwoptions | attinitdefval | attkvtype ----------+---------+----------+---------------+--------+--------+----------+-------------+-----------+----------+------------+----------+------------+-----------+--------------+------------+ -------------+-------------+--------------+--------+------------+---------------+---------------+----------- 16772 | b | 25 | -1 | -1 | 2 | 0 | -1 | -1 | f | x | i | f | f | f | t | 127 | 0 | 100 | | | | | 0 (1 row)

pg_relation_is_publishable(relname regclass) 描述：检查一个表是否可以发布。该函数仅8.2.0.100及以上集群版本支持。 参数：relname 返回值类型：boolean 示例： 1 2 3 4 5 SELECT * FROM pg_relation_is_publishable('t1'); pg_relation_is_publishable ---------------------------- t (1 row)

pg_get_publication_tables(pubname text) 描述：根据发布的名称，返回对应发布要发布的表的relid列表。该函数仅8.2.0.100及以上集群版本支持。 参数：pubname 返回值类型：set of oid 示例： 1 2 3 4 5 6 SELECT * FROM pg_get_publication_tables('mypub'); relid ------- 16757 16776 (2 rows)

get_col_cu_info(schema_name text, table_name text, row_count int8, dirty_percent int8) 描述：查询某张列存表的CU信息，每个分区单独统计。该函数仅8.2.0.100及以上集群版本支持。 参数：模式名（必选），表名（必选），小CU的行数阈值（可选，默认200，取值范围为1~60000）, 脏CU的删除百分比阈值（可选，默认70，取值范围1~100）。 返回值类型：record 返回值字段： node_name：DN节点名。 part_name：分区名，普通表此列为空。 zero_size_cu_count：cuSize=0，且行数小于等于row_count的CU数。 small_cu_count：cuSize=ALIGNOF_CUSIZE(8192)，且行数小于等于row_count的CU数。 dirty_cu_count: 因delete，deadtupe占比超过dirty_percent的CU数。 total_cu_count：总CU数。 small_cu_size：8kCU的总大小。 total_cu_size：总CU大小。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 SELECT * FROM get_col_cu_info('public','hs_part'); node_name | part_name | zero_size_cu_count | small_cu_count | dirty_cu_count | total_cu_count | small_cu_size | total_cu_size -----------+-----------+--------------------+----------------+----------------+----------------+---------------+--------------- dn_1 | p1 | 3 | 0 | 0 | 3 | 0 bytes | 0 bytes dn_1 | p2 | 3 | 0 | 0 | 3 | 0 bytes | 0 bytes dn_1 | p3 | 3 | 0 | 0 | 3 | 0 bytes | 0 bytes (3 rows) SELECT * FROM get_col_cu_info('public','hs_part', 200, 90); node_name | part_name | zero_size_cu_count | small_cu_count | dirty_cu_count | total_cu_count | small_cu_size | total_cu_size -----------+-----------+--------------------+----------------+----------------+----------------+---------------+--------------- dn_1 | p1 | 3 | 0 | 0 | 3 | 0 bytes | 0 bytes dn_1 | p2 | 3 | 0 | 0 | 3 | 0 bytes | 0 bytes dn_1 | p3 | 3 | 0 | 0 | 3 | 0 bytes | 0 bytes (3 rows)

pg_get_bucket_epoch(relid) 描述：查询v3表在当前节点上的epoch值。对于分区表，需要输入父表oid，将打印所有子分区的epoch值。该函数只支持在写VW上执行。该函数仅9.1.0.200及以上集群版本支持。 返回值类型：record 返回值字段： relfilenode oid：列存非分区表的relfilenode。对于分区表，此值为0。 partfilenode oid：列存分区表的relfilenode。对于非分区表，此值为0。 epoch xid：当前节点上该表对应的epoch值。 示例： 1 2 3 4 5 select * from pg_get_bucket_epoch(2147483732); relfilenode | partfilenode | epoch -------------+--------------+-------- 2137383742 | 0 | 1000001 (1 row)

pg_get_bucket_epoch(tablespaceid, databaseid, relfilenode) 描述：查询v3表在当前节点上的epoch值。输入v3表所在的表空间oid，数据库oid和表对应的relfilenode。该函数在写VW或读VW上均可执行。该函数仅9.1.0.200及以上集群版本支持。 返回值类型：xid 返回值字段： epoch xid：当前节点上该表对应的epoch值。 示例： 1 2 3 4 5 select * from pg_get_bucket_epoch(2147483729, 16792, 2147483732); epoch ------- 1000001 (1 row)

get_all_col_file_info() 描述：查询所有列存表的空CU文件数和总CU文件数，该函数仅8.2.0及以上集群版本支持。 返回值类型：record 返回值字段： space_name text：列存表所属schema table_name text：列存表名 total_file_num int：总CU文件数，范围为-1~INT_MAX，返回-1时表示表类型不支持等原因的失败，0~INT_MAX为总文件数。 empty_file_num int：空CU文件数，范围为-1~INT_MAX，返回-1时表示表类型不支持等原因的失败，0~INT_MAX为空文件数。 示例： 1 2 3 4 5 6 7 call get_all_col_file_info(); space_name | table_name | total_file_num | empty_file_num ------------+------------+----------------+---------------- public | t4 | 10 | 7 public | t2 | 1 | 1 public | t1 | 3 | 0 (3 rows)

pgxc_get_bucket_epoch(tablespaceid, databaseid, relfilenode) 描述：查询v3表在所有dn节点上的epoch值。输入v3表所在的表空间oid，数据库oid和表对应的relfilenode。该函数在写VW或读VW上均可执行。该函数仅9.1.0.200及以上集群版本支持。 返回值类型：record 返回值字段： nodename text：节点名称。 epoch xid：当前节点上该表对应的epoch值。 示例： 1 2 3 4 5 6 7 select * from pgxc_get_bucket_epoch(2147483729, 16792, 2147483732); nodename | epoch -----------+--------- datanode3 | 1000001 datanode1 | 0 datanode2 | 0 (1 row)

current_temp_schema() 描述：返回当前会话的临时schema。如果当前会话没有临时schema，则返回空。该函数仅8.2.1.220及以上集群版本支持。 返回值类型：name 示例： 1 2 3 4 5 select current_temp_schema(); current_temp_schema --------------------- (1 row) 1 2 3 4 5 6 7 create temp table tmp1(a int,b int) distribute by hash(a); CREATE TABLE select current_temp_schema(); current_temp_schema ------------------------------------------ pg_temp_coordinator1_2_2_140718823485088 (1 row)

get_col_file_info(table_name) 描述：查询指定列存表的空CU文件数和总CU文件数，该函数仅8.2.0及以上集群版本支持。 参数：列存表名。 返回值类型：int 返回值字段： total_file_num int：总CU文件数，范围为-1~INT_MAX，返回-1时表示表类型不支持等原因的失败，0~INT_MAX为总文件数。 empty_file_num int：空CU文件数，范围为-1~INT_MAX，返回-1时表示表类型不支持等原因的失败，0~INT_MAX为空文件数。 示例： 1 2 3 4 5 call get_col_file_info('t4'); total_file_num | empty_file_num ----------------+---------------- 10 | 7 (1 row)

get_volatile_pg_class(relname text) 描述：获取当前会话中指定volatile临时表相关的pg_class元数据。该函数仅8.2.0及以上集群版本支持。 参数：当前会话中volatile临时表的表名。 返回值类型：record 返回值字段： oid：返回volatile临时表的oid。 其他字段：同pg_class系统表中的基础字段(不包括系统隐藏字段)。 示例： 1 2 3 4 5 6 7 8 9 10 11 SELECT * FROM get_volatile_pg_class('tx1'); oid | relname | relnamespace | reltype | reloftype | relowner | relam | relfilenode | reltablespace | relpages | reltuples | relallvisible | reltoastrelid | reltoastidxid | reldeltarelid | reldeltaidx | relcudescrelid | relcudescidx | relhasindex | relisshared | relpersistence | relkind | relnatts | relchecks | relhasoids | relhaspkey | relhasrules | relhastriggers | relhassub class | relcmprs | relhasclusterkey | relrowmovement | parttype | relfrozenxid | relacl | reloptions | relreplident | relfrozenxid64 -------+---------+--------------+---------+-----------+----------+-------+-------------+---------------+----------+-----------+---------------+---------------+---------------+---------------+ -------------+----------------+--------------+-------------+-------------+----------------+---------+----------+-----------+------------+------------+-------------+----------------+---------- ------+----------+------------------+----------------+----------+--------------+--------+----------------------------------+--------------+---------------- 16772 | tx1 | 16770 | 16774 | 0 | 10 | 0 | 16772 | 1665 | 0 | 0 | 0 | 16775 | 0 | 0 | 0 | 0 | 0 | f | f | v | r | 2 | 0 | f | f | f | f | f | 1 | f | f | n | 11815 | | {orientation=row,compression=no} | d | 11815 (1 row)

copy_error_log_create() 描述：创建COPY FROM容错机制所需要的错误表（public.pgxc_copy_error_log）。 返回值类型：boolean 此函数会尝试创建public.pgxc_copy_error_log表，表的详细信息请参见表3。 在relname列上创建B-tree索引，并REVOKE ALL on public.pgxc_copy_error_log FROM public对错误表进行权限控制（与COPY语句权限一致）。 由于尝试创建的public.pgxc_copy_error_log定义是一张行存表，因此集群上必须支持行存表的创建才能够正常运行此函数，并使用后续的COPY容错功能。需要特别注意的是，enable_hadoop_env这个GUC参数开启后会禁止在集群内创建行存表（GaussDB(DWS)默认为off）。 此函数自身权限为Sysadmin及以上（与错误表、COPY权限一致）。 若创建前public.pgxc_copy_error_log表已存在或者copy_error_log_relname_idx索引已存在，则此函数会报错回滚。 表3 错误表public.pgxc_copy_error_log信息 列名称 类型 描述 relname varchar 表名称。以模式名.表名形式显示。 begintime timestamp with time zone 出现数据格式错误的时间。 filename varchar 出现数据格式错误的数据源文件名。 rownum bigint 在数据源文件中，出现数据格式错误的行号。 rawrecord text 在数据源文件中，出现数据格式错误的原始记录。为了防止字段长度过大，限制字段的长度不超过1024 byte。 detail text 详细错误信息。 columnname varchar 在数据源文件中，出现数据格式错误的字段名称。仅8.2.1.100及以上版本支持。 errcode varchar 出错信息对应的错误码，使用sqlstate错误码。仅8.2.1.100及以上版本支持。 queryid bigint 执行copy的sql语句id，用于唯一标识一条sql语句。仅8.2.1.100及以上版本支持。

wdr_xdb_query(db_name text, snapshot_id bigint, view_name text) 描述：查询指定数据库下的指定视图。有的视图在不同数据库中查询结果不同，例如global_table_stat视图用于查询表格的统计信息，由于不同数据库下表格不同，在不同数据库中查询该视图得到的结果也不同。wdr_xdb_query函数可以在当前连接中访问db_name指定的数据库，并在该数据库中查询view_name指定的视图。输入参数含义如下： db_name：指定的数据库名称，text型。 snapshot_id：快照ID，bigint型，参见“性能视图快照”。 view_name：指定视图名称，text型。视图名称必须在如下白名单中： global_table_stat global_table_change_stat global_column_table_io_stat global_row_table_io_stat 返回值类型：record，其第一列为snapshot_id bigint，第二列为db_name text，其他列的名称、类型和顺序与view_name指定的视图相同。 示例： 1 2 select snapshot_id, db_name, schemaname, relname, distribute_mode, seq_scan ,seq_tuple_read ,index_scan ,index_tuple_read ,tuple_inserted ,tuple_updated ,tuple_deleted ,tuple_hot_updated ,live_tuples ,dead_tuples from wdr_xdb_query('postgres'::text, 1, 'global_table_stat'::text) as i(snapshot_id bigint, db_name text, schemaname name, relname name, distribute_mode char, seq_scan bigint, seq_tuple_read bigint, index_scan bigint, index_tuple_read bigint, tuple_inserted bigint, tuple_updated bigint, tuple_deleted bigint, tuple_hot_updated bigint, live_tuples bigint, dead_tuples bigint); 该函数仅8.1.2及以上版本支持。 该函数只有数据库管理员SYSADMIN才有权执行，非管理员执行会提示无权限。 该函数只能查询白名单中的视图，如果查询其他视图，会报错：“Input view name is invalid.”。

create_wdr_snapshot() 描述：创建性能数据快照。 返回值类型：text 该函数只有数据库管理员SYSADMIN才可以执行，非管理员执行会提示无权限。 该函数只能在CN上执行，在DN上执行会返回：“WDR snapshot can only be created on coordinator.”。 执行该函数前需确认enable_wdr_snapshot参数处于开启状态。如果enable_wdr_snapshot为off，执行该函数会返回：“WDR snapshot request can't be executed, because GUC parameter 'enable_wdr_snapshot' is off.”。 如果执行该函数时，快照线程由于节点重启等原因尚未启动，会提示错误：“WDR snapshot request can not be accepted, please retry later.”。 如果执行该函数失败，会提示：“Cannot respond to WDR snapshot request.”。 如果执行成功，会返回：“WDR snapshot request has been submitted.”。该提示表明创建快照请求已发送至后台快照线程，但不代表创建快照成功。

kill_snapshot(scope cstring) 描述：中止后台快照线程。该函数向后台快照线程发送中止信号并等待线程结束。 输入参数scope：表示操作范围。该参数取值范围为local和global。 local表示中止当前CN上的快照线程。 global表示不仅会中止当前CN上的快照线程，还会向集群中所有其他CN发送中止快照线程的请求，即中止集群中所有CN上的快照线程。 如果输入其他值，则报错“Scope is invalid, use "local" or "global".”。 输入参数可为空，表示默认取值为local。 返回值类型：无 该函数只有数据库管理员SYSADMIN才有权执行，非管理员执行会提示无权限。 该函数只能在CN上执行，在DN上执行会提示：“kill_snapshot can only be executed on coordinator.”； 执行该函数会向后台快照线程发送中止信号并等待其结束。如果100s内快照线程仍未中止则会报错：“Kill snapshot thread failed”；