华为云用户手册

示例 修改函数示例： --创建函数。 gaussdb=# CREATE OR REPLACE FUNCTION test_func(a int) RETURN int IS proc_var int; BEGIN proc_var := a; return 1; END; / --将函数test_func(a int)的名称修改为test_func_tk(a int)。 gaussdb=# ALTER FUNCTION test_func(a int) RENAME TO test_func_tk; --创建jim用户。 gaussdb=# CREATE USER jim PASSWORD '********'; --新建模式test。 gaussdb=# CREATE SCHEMA test; --将函数的所有者改为jim。 gaussdb=# ALTER FUNCTION test_func_tk(a int) OWNER TO jim; --将函数模式改为test。 gaussdb=# ALTER FUNCTION test_func_tk(a int) SET SCHEMA test; --删除函数。 gaussdb=# DROP FUNCTION test.test_func_tk(a int); --删除jim用户。 gaussdb=# DROP USER jim; --删除SCHEMA。 gaussdb=# DROP SCHEMA test;

语法格式 修改自定义函数的附加参数。 1 2 ALTER FUNCTION function_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] ) action [ ... ] [ RESTRICT ]; 其中附加参数action子句语法为： 1 2 3 4 5 6 7 8 9 10 11 {CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT} | {IMMUTABLE | STABLE | VOLATILE} | {SHIPPABLE | NOT SHIPPABLE} | {NOT FENCED | FENCED} | [ NOT ] LEAKPROOF | { [ EXTERNAL ] SECURITY INVOKER | [ EXTERNAL ] SECURITY DEFINER } | AUTHID { DEFINER | CURRENT_USER } | COST execution_cost | ROWS result_rows | SET configuration_parameter { { TO | = } { value | DEFAULT }| FROM CURRENT} | RESET {configuration_parameter | ALL} 修改自定义函数的名称。 1 2 ALTER FUNCTION function_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] ) RENAME TO new_name; 修改自定义函数的所有者。 1 2 ALTER FUNCTION function_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] ) OWNER TO new_owner; 修改自定义函数的模式。 1 2 ALTER FUNCTION function_name ( [ { [ argname ] [ argmode ] argtype} [, ...] ] ) SET SCHEMA new_schema;

参数说明 function_name 要修改的函数名称。 取值范围：已存在的函数名。 argmode 标识该参数是输入、输出参数。 取值范围： IN：声明入参。 OUT：声明出参。 INOUT：声明出入参。 VARIADIC：声明数组类型的参数。 argname 参数名称。 取值范围：字符串，符合标识符命名规范。 argtype 参数类型。 取值范围：有效的类型，请参考数据类型。 CALLED ON NULL INPUT 表明该函数的某些参数是NULL的时候可以按照正常的方式调用。缺省时与指定此参数的作用相同。 RETURNS NULL ON NULL INPUT STRICT STRICT用于指定如果函数的某个参数是NULL，此函数总是返回NULL。如果声明了这个参数，则如果存在NULL参数时不会执行该函数，而只是自动假设一个NULL结果。 RETURNS NULL ON NULL INPUT和STRICT的功能相同。 IMMUTABLE 表示该函数在给出同样的参数值时总是返回同样的结果。 STABLE 表示该函数不能修改数据库，对相同参数值，在同一次表扫描里，该函数的返回值不变，但是返回值可能在不同SQL语句之间变化。 VOLATILE 表示该函数值可以在一次表扫描内改变，不会做任何优化。 SHIPPABLE NOT SHIPPABLE 表示该函数是否可以下推到DN上执行。 对于IMMUTABLE类型的函数，函数始终可以下推到DN上执行。 对于STABLE/VOLATILE类型的函数，仅当函数的属性是SHIPPABLE的时候，函数可以下推到DN执行。 LEAKPROOF 表示该函数没有副作用，指出参数只包括返回值。LEAKPROOF只能由系统管理员设置。 EXTERNAL （可选）目的是和SQL兼容，这个特性适合于所有函数，而不仅是外部函数 SECURITY INVOKER AUTHID CURRENT_USER 表明该函数将以调用它的用户的权限执行。缺省时与指定此参数的作用相同。 SECURITY INVOKER和AUTHID CURRENT_USER的功能相同。 SECURITY DEFINER AUTHID DEFINER 声明该函数将以创建它的用户的权限执行。 AUTHID DEFINER和SECURITY DEFINER的功能相同。 COST execution_cost 用来估计函数的执行成本。 execution_cost以cpu_operator_cost为单位。 取值范围：正数。 ROWS result_rows 估计函数返回的行数。用于函数返回的是一个集合。 取值范围：正数，默认值是1000行。 configuration_parameter value 把指定的数据库会话参数值设置为给定的值。如果value是DEFAULT或者RESET，则在新的会话中使用系统的缺省设置。OFF关闭设置。 取值范围：字符串。 DEFAULT OFF RESET 用户指定的值：需要满足修改参数的取值限制。 FROM CURRENT 取当前会话中的值设置为configuration_parameter的值。 new_name 函数的新名称。要修改函数的所属模式，必须拥有新模式的CREATE权限。 取值范围：字符串，符合标识符命名规范。 new_owner 函数的新所有者。要修改函数的所有者，新所有者必须拥有该函数所属模式的CREATE权限。需要注意注意的是：仅有初始化用户才可以将函数的owner设置为初始化用户。 取值范围：已存在的用户角色。 new_schema 函数的新模式。 取值范围：已存在的模式。

注意事项 只有函数的所有者或者被授予了函数ALTER权限的用户才能执行ALTER FUNCTION命令，系统管理员默认拥有该权限。针对所要修改属性的不同，对其还有以下权限约束： 如果函数中涉及对临时表相关的操作，则无法使用ALTER FUNCTION。 修改函数的所有者或修改函数的模式，当前用户必须是该函数的所有者或者系统管理员，且该用户是新所有者角色的成员。 只有系统管理员和初始化用户可以将function的schema修改成public。

示例 gaussdb=# DECLARE v_num integer default NULL; BEGIN IF v_num IS NOT NULL THEN raise info 'v_num is NULL'; ELSE NULL; -- 不需要处理任何数据。 END IF; END; / ANONYMOUS BLOCK EXECUTE

条件表达式 在执行SQL语句时，可通过条件表达式筛选出符合条件的数据。 条件表达式主要有以下几种： CASE CASE表达式是条件表达式，类似于其他编程语言中的CASE语句。 CASE表达式的语法图如图1所示。 图1 case::= CASE子句可以用于合法的表达式中。condition是一个返回BOOLEAN数据类型的表达式： 如果结果为真，CASE表达式的结果就是符合该条件所对应的result。 如果结果为假，则以相同方式处理随后的WHEN或ELSE子句。 如果各WHEN condition都不为真，表达式的结果就是在ELSE子句执行的result。如果省略了ELSE子句且没有匹配的条件，结果为NULL。 支持对XML类型数据操作。 GUC参数enable_case_intervaltonumeric设置为true时，支持将INTERVAL转换为NUMERIC而不报错。 示例： 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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 gaussdb=# CREATE TABLE case_when_t1(CW_COL1 INT) DISTRIBUTE BY HASH (CW_COL1); gaussdb=# INSERT INTO case_when_t1 VALUES (1), (2), (3); gaussdb=# SELECT * FROM case_when_t1; cw_col1 --- 1 2 3 (3 rows) gaussdb=# SELECT CW_COL1, CASE WHEN CW_COL1=1 THEN 'one' WHEN CW_COL1=2 THEN 'two' ELSE 'other' END FROM case_when_t1 ORDER BY 1; cw_col1 | case ---------+------- 1 | one 2 | two 3 | other (3 rows) gaussdb=# DROP TABLE case_when_t1; -- GUC参数默认为false，此时报错。 gaussdb=# SHOW enable_case_intervaltonumeric; enable_case_intervaltonumeric ------------------------------- off (1 row) gaussdb=# SELECT case gaussdb-# WHEN 1=1 THEN gaussdb-# to_date('20240118','yyyymmdd')-to_date('20240116','yyyymmdd') gaussdb-# ELSE gaussdb-# 1 gaussdb-# end; ERROR: CASE types integer and interval cannot be matched LINE 3: to_date('20240118','yyyymmdd')-to_date('20240116','y... ^ CONTEXT: referenced column: case -- 打开GUC参数，能正确返回结果。 gaussdb=# SET enable_case_intervaltonumeric=true; SET gaussdb=# SELECT case gaussdb-# WHEN 1=1 THEN gaussdb-# to_date('20240118','yyyymmdd')-to_date('20240116','yyyymmdd') gaussdb-# ELSE gaussdb-# 1::int1 gaussdb-# END; case ------ 2 (1 row) DECODE DECODE的语法图如图2所示。 图2 decode::= 将表达式base_expr与后面的每个compare(n) 进行比较，如果匹配返回相应的value(n)。如果没有发生匹配，则返回default。 支持对XML类型数据操作。 示例请参见条件表达式函数。 1 2 3 4 5 gaussdb=# SELECT DECODE('A','A',1,'B',2,0); case ------ 1 (1 row) COALESCE COALESCE的语法图如图3所示。 图3 coalesce::= COALESCE返回它的第一个非NULL的参数值。如果参数都为NULL，则返回NULL。它常用于在显示数据时用缺省值替换NULL。和CASE表达式一样，COALESCE只计算用来判断结果的参数，即在第一个非空参数右边的参数不会被计算。 支持对XML类型数据操作。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 gaussdb=# CREATE TABLE c_tabl(description varchar(10), short_description varchar(10), last_value varchar(10)) DISTRIBUTE BY HASH (last_value); gaussdb=# INSERT INTO c_tabl VALUES('abc', 'efg', '123'); gaussdb=# INSERT INTO c_tabl VALUES(NULL, 'efg', '123'); gaussdb=# INSERT INTO c_tabl VALUES(NULL, NULL, '123'); gaussdb=# SELECT description, short_description, last_value, COALESCE(description, short_description, last_value) FROM c_tabl ORDER BY 1, 2, 3, 4; description | short_description | last_value | coalesce -------------+-------------------+------------+---------- abc | efg | 123 | abc | efg | 123 | efg | | 123 | 123 (3 rows) gaussdb=# DROP TABLE c_tabl; 如果description不为NULL，则返回description的值，否则计算下一个参数short_description；如果short_description不为NULL，则返回short_description的值，否则计算下一个参数last_value；如果last_value不为NULL，则返回last_value的值，否则返回（none）。 1 2 3 4 5 gaussdb=# SELECT COALESCE(NULL,'Hello World'); coalesce --------------- Hello World (1 row) NULLIF NULLIF的语法图如图4所示。 图4 nullif::= 只有当value1和value2相等时，NULLIF才返回NULL。否则它返回value1。支持对XML类型数据操作。 示例： 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 gaussdb=# CREATE TABLE null_if_t1 ( NI_VALUE1 VARCHAR(10), NI_VALUE2 VARCHAR(10) )DISTRIBUTE BY HASH (NI_VALUE1); gaussdb=# INSERT INTO null_if_t1 VALUES('abc', 'abc'); gaussdb=# INSERT INTO null_if_t1 VALUES('abc', 'efg'); gaussdb=# SELECT NI_VALUE1, NI_VALUE2, NULLIF(NI_VALUE1, NI_VALUE2) FROM null_if_t1 ORDER BY 1, 2, 3; ni_value1 | ni_value2 | nullif -----------+-----------+-------- abc | abc | abc | efg | abc (2 rows) gaussdb=# DROP TABLE null_if_t1; 如果value1等于value2则返回NULL，否则返回value1。 1 2 3 4 5 gaussdb=# SELECT NULLIF('Hello','Hello World'); nullif -------- Hello (1 row) GREATEST（最大值），LEAST（最小值） GREATEST的语法图如图5所示。 图5 greatest::= 从一个任意数字表达式的列表里选取最大的数值。支持对XML类型数据操作。 1 2 3 4 5 gaussdb=# SELECT greatest(9000,155555,2.01); greatest ---------- 155555 (1 row) LEAST的语法图如图6所示。 图6 least::= 从一个任意数字表达式的列表里选取最小的数值。 以上的数字表达式必须都可以转换成一个普通的数据类型，该数据类型将是结果类型。 列表中的NULL值将被忽略。只有所有表达式的结果都是NULL的时候，结果才是NULL。 支持对XML类型数据操作。 1 2 3 4 5 gaussdb=# SELECT least(9000,2); least ------- 2 (1 row) 示例请参见条件表达式函数。 NVL NVL的语法图如图7所示。 图7 nvl::= 如果value1为NULL，则返回value2，如果value1非NULL，则返回value1。支持对XML类型数据操作。 示例： 1 2 3 4 5 gaussdb=# SELECT nvl(null,1); nvl ----- 1 (1 row) 1 2 3 4 5 gaussdb=# SELECT nvl('Hello World',1); nvl --------------- Hello World (1 row) 父主题： 表达式

接口介绍 根据输入的参数，返回目标数据块中行的最后修改时间等信息，用于直观浏览每一行被判定为冷、热行的依据。该接口属于运维类接口，不做可见性判断，即传入的ctid为已删除的行时，该接口依然会返回当前行在页面上最新的状态。 表1 DBE_HEAT_MAP 接口名称 描述 ROW_HEAT_MAP 根据对象所属Schema、数据对象名称、数据对象分区名及ctid获取行的最后修改时间等信息。 DBE_HEAT_MAP.ROW_HEAT_MAP 根据对象所属Schema、数据对象名称、数据对象分区名及ctid获取行的最后修改时间等信息，原型为： 1 2 3 4 5 DBE_HEAT_MAP.ROW_HEAT_MAP( owner IN VARCHAR2, segment_name IN VARCHAR2, partition_name IN VARCHAR2 DEFAULT NULL, ctid IN TEXT); 表2 DBE_HEAT_MAP.ROW_HEAT_MAP接口参数说明 参数 描述 owner 数据对象所属Schema。 segment_name 数据对象名称。 partition_name 数据对象分区名，可选参数，默认为NULL。 ctid 数据行ID。 DBE_HEAT_MAP.ROW_HEAT_MAP 接口只支持分布式数据库中数据节点（DN），其他节点暂不支持。

GLOBAL_OS_RUNTIME 提供整个集群中所有正常节点下的操作系统运行状态信息，如表1所示。 表1 GLOBAL_OS_RUNTIME字段 名称 类型 描述 node_name name 节点名称。 id integer 编号。 name text 操作系统运行状态名称。 value numeric 操作系统运行状态值。 comments text 操作系统运行状态注释。 cumulative boolean 操作系统运行状态的值是否为累加值。 父主题： OS

二进制类型 GaussDB支持的二进制类型如表1所示。 表1 二进制类型 名称 描述 存储空间 BLOB 二进制大对象。 目前BLOB支持的外部存取接口仅为： DBE_LOB.GET_LENGTH DBE_LOB.READ DBE_LOB.WRITE DBE_LOB.WRITE_APPEND DBE_LOB.COPY DBE_LOB.ERASE 这些接口详细说明请参见DBE_LOB。 在ustore下，最大为1GB-1，但还需要考虑到列描述头信息的大小，以及列所在元组的大小限制（也小于1GB-1），因此BLOB类型最大值可能小于1GB-1。 当sql_compatibility = 'MYSQL'时，设置参数b_format_version = '5.7'和参数b_format_dev_version = 's1'时，BLOB类型映射为BYTEA类型，别名为BYTEA。 具体存储规格参考BYTEA类型。 TINYBLOB MEDIUMBLOB LONGBLOB 二进制大对象。 具体存储规格参考BYTEA类型。 只有当sql_compatibility = 'MYSQL'时，设置参数b_format_version = '5.7'和参数b_format_dev_version = 's1'时，可以使用此类型，类型映射为BYTEA类型，别名为BYTEA。 RAW 变长的十六进制类型。 4字节加上实际的二进制字符串。最大为1GB-1，但还需要考虑到列描述头信息的大小，以及列所在元组的大小限制（也小于1GB-1），因此类型最大值可能小于1GB-1。 BYTEA 变长的二进制字符串。 4字节加上实际的二进制字符串。最大为1GB-1，但还需要考虑到列描述头信息的大小，以及列所在元组的大小限制（也小于1GB-1），因此类型最大值可能小于1GB-1。 BYTEAWITHOUTORDERWITHEQUALCOL 变长的二进制字符串（密态特性新增的类型，如果加密列的加密类型指定为确定性加密，则该列的实际类型为BYTEAWITHOUTORDERWITHEQUALCOL），元命令打印加密表将显示原始数据类型。 4字节加上实际的二进制字符串。最大为1GB减去53字节（即1073741771字节）。 BYTEAWITHOUTORDERCOL 变长的二进制字符串（密态特性新增的类型，如果加密列的加密类型指定为随机加密，则该列的实际类型为BYTEAWITHOUTORDERCOL），元命令打印加密表将显示原始数据类型。 4字节加上实际的二进制字符串。最大为1GB减去53字节（即1073741771字节）。 _BYTEAWITHOUTORDERWITHEQUALCOL 变长的二进制字符串，密态特性新增的类型。 4字节加上实际的二进制字符串。最大为1GB减去53字节（即1073741771字节）。 _BYTEAWITHOUTORDERCOL 变长的二进制字符串，密态特性新增的类型。 4字节加上实际的二进制字符串。最大为1GB减去53字节（即1073741771字节）。 除了每列的大小限制以外，每个元组的总大小也不可超过1GB-1字节。 不支持直接使用BYTEAWITHOUTORDERWITHEQUALCOL、BYTEAWITHOUTORDERCOL、_BYTEAWITHOUTORDERWITHEQUALCOL和_BYTEAWITHOUTORDERCOL类型创建表。 RAW(n)，n是指字节长度建议值，不会用于校验输入RAW类型的字节长度。 当sql_compatibility = 'MYSQL'时，设置参数b_format_version = '5.7'和参数b_format_dev_version = 's1'后，TINYBLOB、BLOB、MEDIUMBLOB、LONGBLOB类型的表现规格为BYTEA类型，如查询表结构显示为BYTEA类型。 示例: 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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 --创建表。 gaussdb=# CREATE TABLE blob_type_t1 ( BT_COL1 INTEGER, BT_COL2 BLOB, BT_COL3 RAW, BT_COL4 BYTEA ) DISTRIBUTE BY REPLICATION; --插入数据。 gaussdb=# INSERT INTO blob_type_t1 VALUES(10,empty_blob(), HEXTORAW('DEADBEEF'),E'\\xDEADBEEF'); --查询表中的数据。 gaussdb=# SELECT * FROM blob_type_t1; bt_col1 | bt_col2 | bt_col3 | bt_col4 ---------+---------+----------+------------ 10 | | DEADBEEF | \xdeadbeef (1 row) --删除表。 gaussdb=# DROP TABLE blob_type_t1; --示例：TINYBLOB MEDIUMBLOB LONGBLOB二进制大对象类型。 gaussdb=# CREATE DATABASE gaussdb_m WITH dbcompatibility 'MYSQL'; gaussdb=# \c gaussdb_m --设置兼容版本控制参数。 gaussdb_m=# SET b_format_version='5.7'; gaussdb_m=# SET b_format_dev_version='s1'; --创建表。 gaussdb_m=# CREATE TABLE t1(num int, a tinyblob, b blob, m mediumblob, l longblob); --插入数据。 gaussdb_m=# INSERT INTO t1 VALUES (1, 'tinyblobtest', 'blobtest', 'mediumblobtest', 'longblobtest'); --查询表中数据。 gaussdb_m=# SELECT * FROM t1; num | a | b | m | l -----+--------------+----------+----------------+-------------- 1 | tinyblobtest | blobtest | mediumblobtest | longblobtest (1 row) --删除表和数据库。 gaussdb_m=# DROP TABLE t1; gaussdb_m=# \c postgres; gaussdb=# DROP DATABASE gaussdb_m; --重置参数。 gaussdb=# RESET ALL; 父主题： 数据类型

注意事项 EXPLAIN PLAN不支持在DN上执行。 对于执行错误的SQL语句无法进行计划信息的收集。 PLAN_TABLE中的数据是session级生命周期并且session隔离和用户隔离，用户只能看到当前session、当前用户的数据。 PLAN_TABLE无法与GDS外表进行关联查询。 对于不能下推的查询，执行EXPLAIN PLAN后PLAN_TABLE中的object仅收集到REMOTE_QUERY或CTE等信息。详见示例 2。 EXPLAIN中的PLAN选项表示需要将计划信息存储于PLAN_TABLE中，存储成功将返回“EXPLAIN SUCCESS”。 用户可通过STATEMENT_ID对查询设置标签，输入的标签信息也将存储于PLAN_TABLE中。 执行EXPLAIN PLAN 后会将计划信息自动存储于PLAN_TABLE中，不支持对PLAN_TABLE进行INSERT、UPDATE、ANALYZE等操作。PLAN_TABLE详细介绍见PLAN_TABLE。

GS_ALL_PREPARED_STATEMENTS GS_ALL_PREPARED_STATEMENTS视图显示所有会话中可用的预备语句的信息。默认只有系统管理员权限才可以访问。 表1 GS_ALL_PREPARED_STATEMENTS字段 名称 类型 描述 pid bigint 后台线程ID。 说明： 线程池模式下pid显示的是当前会话绑定的线程ID，当会话在不同线程上执行时pid会随之改变。线程池模式下statement与sessionid相关联，与pid无关联，关联查询时建议使用sessionid。 sessionid bigint 当前会话ID。 global_sessionid text 全局会话ID。 name text 预备语句的标识符。 statement text 创建该预备语句的查询字符串。对于从SQL创建的预备语句而言是客户端提交的PREPARE语句；对于通过前/后端协议创建的预备语句而言是预备语句自身的文本。 prepare_time timestamp with time zone 创建该预备语句的时间戳。 parameter_types regtype[] 该预备语句期望的参数类型，以regtype类型的数组格式出现。与该数组元素相对应的OID可以通过把regtype转换为OID值得到。 from_sql boolean 如果该预备语句是通过PREPARE语句创建的则为true。 如果是通过前/后端协议创建的则为false。 父主题： 其他系统视图

PGXC_CLASS PGXC_CLASS系统表存储每张表的复制或分布信息。 表1 PGXC_CLASS字段 名称 类型 描述 pcrelid oid 表的OID。 pclocatortype "char" 定位器类型。 H：hash G：Range L：List M：Modulo N：Round Robin R：Replication U：MurmurHash pchashalgorithm smallint 使用哈希算法分布元组。 1：默认的哈希算法。 2：MURMURHASH算法。 pchashbuckets smallint 哈希容器的值。 pgroup name 节点群的名称。 redistributed "char" 表已经完成重分布。 redis_order integer 重分布的顺序。该值等于0的表在本轮重分布过程中不进行重分布。 pcattnum int2vector 用作分布键的列标号。 nodeoids oidvector_extend 表分布的节点OID列表。 options text 系统内部保留字段，存储扩展状态信息。 diskey text SQL建表语句中，DISTRIBUTE BY子句括号中分布列表达式的字符串内容。目前只支持MURMURHASH分布。 diskeyexprs pg_node_tree diskey通过pack_node_to_string()函数序列化得到的字符串信息。 父主题： 其他系统表

GS_SEG_SPC_EXTENTS GS_SEG_SPC_EXTENTS获取所有表空间已使用的扩展信息。输出包含segment head、fork head、level1 page、data extent。只支持管理员权限用户查询。 表1 GS_SEG_SPC_EXTENTS 名称 类型 描述 node_name text 节点名称。 tablespace_name name 表空间名称。 file_id integer 数据文件标识。 bucketnode integer 0~1023表示hashbucket表的bucketnode。 1024表示段页式普通表的bucketnode。 1025表示段页式全局临时表的bucketnode。 1026表示段页式unlogged表的bucketnode。 1027表示段页式本地临时表的bucketnode。 forknum integer 数据文件分支。 block_id bigint 数据扩展的起始页面号。 blocks integer 数据扩展大小。取值：1、8、128、1024、4096。 contents text 数据文件的存储内容，取值范围： permanent：永久。 unlogged：不记录日志。 temporary：全局临时。 temporary2：本地临时。 in_used text 是否已分配。取值Y/N。 mapblock_location text 扩展在map block中的位置，格式：(page_id, offset)。 head_file_id integer 段头文件标识。 head_block_id bigint 段头页面号。 usage_type text 扩展的使用类型，取值范围： segment head表示段头。 fork head表示分支头。 level1 page表示level页面。 data extent表示数据扩展。 remain_flag text 是否为shrink残留扩展。取值Y/N。 special_data integer 扩展对应反向指针的特殊数据区。 ipblock_location text 扩展反向指针位置，格式：(block_id, offset)。 父主题： 段页式存储

规格约束 告警字符串长度上限为2048。如果告警信息超过这个长度（例如存在大量未收集统计信息的超长表名、列名等信息）则不告警，只上报warning： WARNING, "Planner issue report is truncated, the rest of planner issues will be skipped" 如果query存在limit节点（即查询语句中包含limit），则不会上报limit节点以下的Operator级别的告警。 对于“数据倾斜”和“估算不准”两种类型告警，在某一个plan树结构下，只上报下层节点的告警，上层节点不再重复告警。主要是因为这两种类型的告警可能是因为底层触发上层的。例如，如果在scan节点已经存在数据倾斜，那么在上层的hashagg等其他算子很可能也出现数据倾斜。

告警场景 目前支持对以下7种导致性能问题的场景上报告警。 多列/单列统计信息未收集 如果存在单列或者多列统计信息未收集，则上报相关告警。 告警信息示例： 整表的统计信息未收集： Statistic Not Collect: schema_test.t1 单列统计信息未收集： Statistic Not Collect: schema_test.t2(c1,c2) 多列统计信息未收集: Statistic Not Collect: schema_test.t3((c1,c2)) 单列和多列统计信息未收集： Statistic Not Collect: schema_test.t4(c1,c2) schema_test.t4((c1,c2)) SQL不下推 对于不下推的SQL，尽可能详细上报导致不下推的原因。调优方法请参见语句下推调优。 对于函数导致的不下推，告警导致不下推的函数名信息； 对于不支持下推的语法，会告警对应语法不支持下推，例如：含有With Recursive、Distinct On、row表达式，会告警相应语法不支持下推等。 告警信息示例： SQL is not plan-shipping, reason : "With Recursive" can not be shipped" SQL is not plan-shipping, reason : "Function now() can not be shipped" SQL is not plan-shipping, reason : "Function string_agg() can not be shipped" HashJoin中大表做内表 如果在表连接过程中使用了Hashjoin，且连接的内表行数是外表行数的10倍或以上，同时内表在每个DN上的平均行数大于10万行，且发生了下盘，则上报相关告警。调优方法请参见使用plan hint调优执行计划。 大表等值连接使用Nestloop 如果在表连接过程中使用了nestloop，并且两个表中较大表的行数平均每个DN上的行数大于10万行，表的连接中存在等值连接，则上报相关告警。调优方法请参见使用plan hint调优执行计划。 告警信息示例： PlanNode[5] Large Table with Equal-Condition use Nestloop"Nested Loop" 大表Broadcast 如果在Broadcast算子中，平均每DN的行数大于10万行，则告警大表broadcast。调优方法请参见使用plan hint调优执行计划。 告警信息示例： PlanNode[5] Large Table in Broadcast "Streaming(type: BROADCAST dop: 1/2)" 数据倾斜 某表在各DN上的分布，存在某DN上的行数是另一DN上行数的10倍或以上，且有DN中的行数大于10万行，则上报相关告警。 告警信息示例： PlanNode[6] DataSkew:"Seq Scan", min_dn_tuples:0, max_dn_tuples:524288 估算不准 如果优化器的估算行数和实际行数中的较大值平均每DN行数大于10万行，并且估算行数和实际行数中较大值是较小值的10倍或以上，则上报相关告警。调优方法请参见使用plan hint调优执行计划。 告警信息示例： PlanNode[5] Inaccurate Estimation-Rows: "Hash Join" A-Rows:0, E-Rows:52488

SUMMARY_STATIO_ALL_INDEXES SUMMARY_STATIO_ALL_INDEXES视图包含集群内汇聚的数据库中的每个索引行，显示特定索引的I/O的统计，如表1所示。 表1 SUMMARY_STATIO_ALL_INDEXES字段 名称 类型 描述 schemaname name 该索引的模式名。 relname name 该索引的表名。 indexrelname name 索引名称。 idx_blks_read numeric 从索引中读取的磁盘块数。 idx_blks_hit numeric 索引命中缓存数。 last_updated timestamp with time zone 视图中该索引监控数据最后一次更新的时间。 父主题： Cache/IO

参数说明 name 要创建的外部数据封装器的名称。 HADNLER handler_function handler_function是先前已经注册了的函数的名称，用来为外部表检索执行函数。处理器函数必须没有参数，并且它的返回类型必须为fdw_handler。 不用处理器函数创建外部数据封装器是可能的，但是使用这种封装器的外部表只能被声明，不能被访问。 VALIDATOR validator_function validator_function是先前已经注册了的函数的名字用来检查提供给外部数据封装器的通用选项，还有使用该外部数据封装器的外部服务器、用户映射和外部表的选项。如果没有验证器函数或声明了NO VALIDATOR，那么在创建时将不检查选项（外部数据封装器可能在运行时忽略或拒绝无效的选项说明，取决于实现）。验证器函数必须接受两个参数：一个类型为text[]，将包含存储在系统目录中的选项的数组；一个类型为oid，是包含这些选项的系统目录的OID。忽略返回类型；该函数应该使用ereport(ERROR)函数报告无效选项。 OPTIONS ( option 'value' [, ... ] ) 这个子句为新的外部数据封装器声明选项。允许的选项名和值是特定于每个外部数据封装器的， 并且是经过外部数据封装器的验证器函数验证了的。选项名必须是唯一的。

示例 --创建一个无用的外部数据封装器dummy。 gaussdb=# CREATE FOREIGN DATA WRAPPER dummy; --创建一个带有处理器函数file_fdw_handler 的外部数据封装器file。 gaussdb=# CREATE FOREIGN DATA WRAPPER file HANDLER file_fdw_handler; --创建一个带有一些选项的外部数据封装器mywrapper。 gaussdb=# CREATE FOREIGN DATA WRAPPER mywrapper OPTIONS (debug 'true');

GS_ENCRYPTED_COLUMNS GS_ENCRYPTED_COLUMNS系统表记录密态等值特性中表的加密列相关信息，每条记录对应一条加密列信息。 表1 GS_ENCRYPTED_COLUMNS字段 名称 类型 描述 rel_id oid 表的OID。 column_name name 加密列的名称。 column_key_id oid 外键，列加密密钥的OID。 encryption_type tinyint 加密类型。取值为2(DETERMINISTIC)或者1(RANDOMIZED)。 data_type_original_oid oid 加密列的原始数据类型id。该值参考系统表PG_TYPE的oid字段。 data_type_original_mod integer 加密列的原始数据类型修饰符。该值参考原始数据类型对应的系统表PG_ATTRIBUTE中的atttypmod字段。 create_date timestamp without time zone 创建加密列的时间。 父主题： 密态等值查询

PG_LARGEOBJECT_METADATA PG_LARGEOBJECT_METADATA系统表存储与大数据相关的元数据。实际的大对象数据存储在PG_LARGEOBJECT里。 表1 PG_LARGEOBJECT_METADATA字段 名称 类型 引用 描述 oid oid - 行标识符（隐含字段，必须明确选择）。 lomowner oid PG_AUTHID.oid 大对象的所有者。 lomacl aclitem[] - 访问权限。 父主题： 其他系统表

MY_TAB_COL_STATISTICS MY_TAB_COL_STATISTICS视图显示从MY_TAB_COLUMNS 中提取的列统计信息和直方图信息。所有用户都可以访问该视图。该视图同时存在于PG_CATALOG和SYS Schema下。具体字段信息如表1所示。 表1 MY_TAB_COL_STATISTICS字段 名称 类型 描述 table_name character varying(128) 表名。 column_name character varying(128) 列名。 num_distinct numeric 列中不同值的数量。 low_value raw 列中的低值。 high_value raw 列中的高值。 density numeric 如果COLUMN_NAME上有直方图，则此列将显示直方图中跨越少于2个端点的值的选择性。它不代表跨越2个或更多端点的值的选择性。 如果COLUMN_NAME上没有可用的直方图，则该列的值为1/NUM_DISTINCT。 num_nulls numeric 列中空值数。 num_buckets numeric 列的直方图中的桶数。 last_analyzed date 最近分析此列的日期，数据库重启后，数据会丢失。 sample_size numeric 用于分析此列的样本量。 global_stats character varying(3) 暂不支持，值为NULL。 user_stats character varying(3) 暂不支持，值为NULL。 notes character varying(99) 暂不支持，值为NULL。 avg_col_len numeric 列的平均长度（以字节为单位）。 histogram character varying(15) 表示直方图是否存在，如果存在的话是什么类型： NONE：表示不存在直方图。 FREQUENCY：表示频率直方图。 EQUI-WIDTH：表示等宽直方图。 scope character varying(7) 对于在除全局临时表之外的任何表上收集的统计信息，该值是SHARED(表示统计信息在所有会话之间共享)。 schema character varying(64) 列所属的名称空间的名称。 父主题： 其他系统视图

ADM_SCHEDULER_JOB_ARGS ADM_SCHEDULER_JOB_ARG视图显示数据库中所有任务的有关参数信息。默认只有系统管理员权限才可以访问，普通用户需要授权才可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 ADM_SCHEDULER_JOB_ARGS字段 名称 类型 描述 owner character varying(128) 参数所属作业的拥有者。 job_name character varying(128) 参数所属作业名。 argument_name character varying(128) 参数名称。 argument_position numeric 参数在参数列表中的位置。 argument_type character varying(257) 参数的数据类型，可以是用户的自定义数据类型。 value character varying(4000) 参数值。 anydata_value character varying(4000) 暂不支持，值为NULL。 out_argument character varying(5) 保留字段，值为NULL。 父主题： 其他系统视图

DBE_SQL_UTIL.enable_sql_patch enable_sql_patch是用于在当前建立连接的CN上开启SQL PATCH的接口函数，返回执行是否成功，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 CN之间SQL PATCH不共享，要在各个CN上单独执行。 开启负载均衡场景或者需要指定创建的CN的场景，推荐使用DBE_SQL_UTIL.enable_remote_sql_patch接口进行开启操作。 表1 DBE_SQL_UTIL.enable_sql_patch入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

PG_TRIGGER PG_TRIGGER系统表存储触发器信息。 表1 PG_TRIGGER字段 名称 类型 描述 oid oid 行标识符（隐含字段，必须明确选择）。 tgrelid oid 触发器所在表的OID。 tgname name 触发器名。 tgfoid oid 要被触发器调用的函数。 tgtype smallint 触发器类型。 tgenabled "char" O：表示触发器在“origin”和“local”模式下触发。 D：表示触发器被禁用。 R：表示触发器在“replica”模式下触发。 A：表示触发器始终触发。 tgisinternal boolean 内部触发器标识，如果为true表示内部触发器。 tgconstrrelid oid 完整性约束引用的表。 tgconstrindid oid 完整性约束的索引。 tgconstraint oid 约束触发器在12.2.15.30 PG_CONSTRAINT中的OID。 tgdeferrable boolean 约束触发器是否为DEFERRABLE类型。 t（true）：表示是。 f（false）：表示不是。 tginitdeferred boolean 约束触发器是否为INITIALLY DEFERRED类型。 t（true）：表示是。 f（false）：表示不是。 tgnargs smallint 触发器函数入参个数。 tgattr int2vector 当触发器指定列时的列号，未指定则为空数组。 tgargs bytea 传递给触发器的参数。 tgqual pg_node_tree 表示触发器的WHEN条件，如果没有则为null。 tgowner oid 触发器所有者。 父主题： 其他系统表

参数说明 IF EXISTS 如果指定的节点不存在，则发出一个notice而不是抛出一个错误。 nodename 要删除的节点名。 取值范围：已存在的节点nodename。 cnnodename CN名称。如果定义了该参数，则除当前连接CN外，还将在该节点上执行。否则，如果是删除DN，将在所有CN上执行；如果是删除CN，将在除待删除CN外所有CN上执行。 取值范围：已存在的CN的nodename。

参数说明 OR REPLACE 可选。如果同义词已存在，则重新定义。 PUBLIC 可选参数。创建PUBLIC同义词。 同一数据库下，PUBLIC同义词不能重名。 数据库从不支持PUBLIC同义词的版本升级到支持PUBLIC同义词的版本时，升级提交前不支持创建、删除PUBLIC同义词。 所有用户都可以访问PUBLIC同义词。除初始用户、系统管理员的用户外，创建和删除PUBLIC同义词需要具有对应CREATE PUBLIC SYNONYM和DROP PUBLIC SYNONYM的权限。 PUBLIC同义词在系统表PG_SYNONYM中的synnamespace和synowner对应为0，在系统视图ADM_SYNONYMS和DB_SYNONYMS的owner为PUBLIC，schema_name 为NULL。 未指定同义词SCHEMA情况下，首先检索同名对象，判断同名对象是否存在；然后检索同义词，按照SEARCH_PATH检索；最后检索PUBLIC同义词。指定同义词schema情况下，不检索PUBLIC同义词。 synonym_name 创建的同义词名称，可以带模式名。 取值范围：字符串，要符合标识符命名规范。 object_name 关联的对象名称，可以带模式名。 取值范围：字符串，要符合标识符命名规范。 object_name可以是不存在的对象名称。 object_name可以是使用DATABASE LINK方式访问远程对象。DATABASE LINK详细使用方式请参见DATABASE LINK。

示例 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 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 --创建模式ot。 gaussdb=# CREATE SCHEMA ot; --创建表ot.test_tbl1。 gaussdb=# CREATE TABLE ot.test_tbl1(c1 INT, c2 INT); gaussdb=# INSERT INTO ot.test_tbl1 values(1,1); --查看当前search_path。 gaussdb=# SHOW search_path; search_path ---------------- "$user",public (1 row) --因为当前search_path中不包含ot，并且当前用户不是ot，所以直接查看表名会报错。 gaussdb=# SELECT * FROM test_tbl1; ERROR: relation "test_tbl1" does not exist LINE 1: SELECT * FROM test_tbl1; ^ --创建同义词。 gaussdb=# CREATE OR REPLACE SYNONYM test_tbl1 FOR ot.test_tbl1; --使用同义词。 gaussdb=# SELECT * FROM test_tbl1; c1 | c2 ----+---- 1 | 1 (1 row) gaussdb=# INSERT INTO test_tbl1 VALUES (2,2); --查询已经创建的同义词。 gaussdb=# SELECT synname,synobjschema,synobjname FROM pg_synonym WHERE synname = 'test_tbl1'; synname | synobjschema | synobjname -----------+--------------+------------ test_tbl1 | ot | test_tbl1 (1 row) --删除。 gaussdb=# DROP SYNONYM test_tbl1; gaussdb=# DROP TABLE ot.test_tbl1; gaussdb=# DROP SCHEMA ot CASCADE;

注意事项 创建同义词的用户将成为其所有者。 若指定模式名称，则同义词在指定模式中创建。否则，在当前模式下创建。 支持通过同义词访问的数据库对象包括：表、视图、类型、包、函数和存储过程、序列和其他同义词对象。 使用同义词时，用户需要具有对关联对象的相应权限。 支持使用同义词的DML语句包括：SELECT、INSERT、UPDATE、DELETE、EXPLAIN、CALL。 不支持关联函数或存储过程的CREATE SYNONYM语句出现在存储过程中，建议存储过程中使用系统表pg_synonym中已存在的同义词对象。 不建议对临时表创建同义词。如果需要创建，需要指定同义词的目标临时表的模式名，否则无法正常使用该同义词，并且在当前会话结束前执行DROP SYNONYM命令。 删除原对象后，与之关联同义词不会被级联删除，继续访问该同义词将会报错，对于访问表提示已失效，对于访问函数、存储过程、包等会提示对象不存在。 被授予了CREATE ANY SYNONYM权限的用户能够在用户模式下创建同义词。 不支持针对包含加密列的密态表及基于密态表的视图、函数、存储过程创建同义词。 同义词的SCHEMA是用户所在SCHEMA时，该同义词OWNER为SCHEMA的OWNER，其他场景同义词OWNER默认为同义词的创建者。 设置SEARCH_PATH，未指定同义词SCHEMA情况下，存储过程和函数会优先按照名称检索PG_PROC表，在没有同名函数时，检索同义词，最后按照SEARCH_PATH检索；其他对象优先检索SEARCH_PATH，同SCHEMA下，本名的对象优先于同义词被访问。 不支持通过DDL语句CREATE、DROP、ALTER操作同义词的方式访问同义词所关联的对象。 支持嵌套同义词。搜索同义词时，如果同义词关联的是另一个同义词，则会继续搜索关联的同义词，直到搜索到最后关联的对象。 不支持使用\d、\df、\sf等方式通过同义词访问关联对象的信息。

GLOBAL_STAT_SYS_INDEXES 显示各节点pg_catalog、information_schema以及pg_toast模式中所有系统表的索引状态信息（包含CN与DN节点的索引状态信息，在CN节点使用，不汇总），如表1所示。 表1 GLOBAL_STAT_SYS_INDEXES字段 名称 类型 描述 node_name name 节点名称 relid oid 这个索引的表的OID。 indexrelid oid 索引的OID。 schemaname name 索引所在的Schema名。 relname name 索引的表名。 indexrelname name 索引名。 idx_scan bigint 该索引上执行的索引扫描次数。 idx_tup_read bigint 该索引上扫描返回的索引项数。 idx_tup_fetch bigint 使用该索引的简单索引扫描在原表中抓取的活跃行数。 父主题： Object

PG_STAT_ACTIVITY PG_STAT_ACTIVITY视图显示和当前用户查询相关的信息，字段保存的是上一次执行的信息。具体字段信息如表1所示。 表1 PG_STAT_ACTIVITY字段 名称 类型 描述 datid oid 用户会话在后台连接到的数据库OID。 datname name 用户会话在后台连接到的数据库名称。 pid bigint 后台线程id。 sessionid bigint 会话id。 usesysid oid 登录该后台的用户OID。 usename name 登录该后台的用户名。 application_name text 连接到该后台的应用名。 client_addr inet 连接到该后台的客户端的IP地址。 如果此字段是null，它表明通过服务器机器上UNIX套接字连接客户端或者这是内部线程，如autovacuum。 client_hostname text 客户端的主机名，这个字段是通过client_addr的反向DNS查找得到。这个字段只有在启动log_hostname且使用IP连接时才非空。 client_port integer 客户端用于与后台通讯的TCP端口号，如果使用Unix套接字，则为-1。 backend_start timestamp with time zone 该会话开始的时间，即客户端连接服务器的时间。 xact_start timestamp with time zone 当前活跃事务开始的时间，如果没有事务是活跃的，则为null。如果当前查询是首个事务，则这列等同于query_start列。 query_start timestamp with time zone 当前活跃查询开始的时间， 如果state的值不是active，则这个值是上一个查询的开始时间。如果是存储过程或函数，则显示的是第一个查询时间，不会随着存储过程内语句运行而改变。 state_change timestamp with time zone 上次状态改变的时间。 waiting boolean 如果后台当前正等待锁则为true。否则为false。 enqueue text 语句当前排队状态。可能值是： waiting in queue：表示语句在排队中。 空：表示语句正在运行。 state text 该后台当前总体状态。可能值是： active：后台正在执行一个查询。 idle：后台正在等待一个新的客户端命令。 idle in transaction：后台在事务中，但事务中没有语句在执行。 idle in transaction (aborted)：后台在事务中，但事务中有语句执行失败。 fastpath function call：后台正在执行一个fast-path函数。 disabled：如果后台禁用track_activities，则报告这个状态。 说明： 普通用户只能查看到自己账户所对应的会话状态。即其他账户的state信息为空。例如以judy用户连接数据库后，在pg_stat_activity中查看到的普通用户joe及初始用户omm的state信息为空： SELECT datname, usename, usesysid, state,pid FROM pg_stat_activity; datname | usename | usesysid | state | pid ----------+---------+----------+--------+----------------- testdb | omm | 10 | | 139968752121616 testdb | omm | 10 | | 139968903116560 db_tpcds | judy | 16398 | active | 139968391403280 testdb | omm | 10 | | 139968643069712 testdb | omm | 10 | | 139968680818448 testdb | joe | 16390 | | 139968563377936 (6 rows) resource_pool name 用户使用的资源池。 query_id bigint 查询语句的id。 query text 该后台的最新查询。如果state状态是active（活跃的），此字段显示当前正在执行的查询。所有其他情况表示上一个查询。 connection_info text json格式字符串，记录当前连接数据库的驱动类型、驱动版本号、当前驱动的部署路径、进程属主用户等信息（参见GUC参数connection_info）。 global_sessionid text 全局的会话id。 unique_sql_id bigint 语句的unique sql id。 trace_id text 驱动传入的trace id，与应用的一次请求相关联。 top_xid xid 事务的顶层事务id。 current_xid xid 事务的当前事务id。 xlog_quantity bigint 事务当前使用的XLOG量，单位为字节。 父主题： 其他系统视图