华为云用户手册

参数说明 column_encryption_key_name 该参数作为密钥对象名，在同一命名空间下，需满足命名唯一性约束。 取值范围：字符串，要符合标识符命名规范。 client_master_key_name 指定用于重加密该CEK的新的CMK，取值为：CMK对象名，该CMK对象由CREATE CLIENT MASTER KEY语法创建。与密钥轮转前指定的客户端主密钥不为同一密钥。 国密算法约束： 由于SM2、SM3、SM4等算法属于中国国家密码标准算法，为规避法律风险，需配套使用。如果轮转CEK前使用的CMK是国密算法，则轮转CEK指定的CMK仍必须使用国密算法。

返回值 SQL_SUC CES S：表示调用正确。 SQL_SUCCESS_WITH_INFO：表示会有一些警告信息。 SQL_NEED_DATA：表示在执行SQL语句前没有提供足够的参数。 SQL_ERROR：表示比较严重的错误，如：内存分配失败、建立连接失败等。 SQL_NO_DATA：表示SQL语句不返回结果集。 SQL_INVALID_HANDLE：表示调用无效句柄。其他API的返回值同理。 SQL_STILL_EXECUTING：表示语句正在执行。

PARALLEL_DECODE_STATUS PARALLEL_DECODE_STATUS视图用于查看当前节点上的复制槽的并行解码信息。 表1 PARALLEL_DECODE_STATUS字段 名称 类型 描述 slot_name text 复制槽的名称。 parallel_decode_num integer 该复制槽的并行解码线程数。 read_change_queue_length text 将每个解码线程读取日志队列的当前长度拼接后输出。 decode_change_queue_length text 将每个解码线程解码结果队列的当前长度拼接后输出。 reader_lsn text 当前reader线程读取的日志位置。 working_txn_cnt bigint 当前拼接-发送线程中正在拼接的事务个数。 working_txn_memory bigint 拼接-发送线程中拼接事务占用总内存（单位字节）。 decoded_time timestamptz 该复制槽最新解码到的WAL日志时间。 父主题： Utility

动态数据脱敏函数 该函数为内部功能调用函数。 creditcardmasking(col text, letter char default 'x') 描述：将col字符串后四位之前的数字使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from creditcardmasking('4511-8454-2178-6551', 'x'); creditcardmasking --------------------- xxxx-xxxx-xxxx-6551 (1 row) basicemailmasking(col text, letter char default 'x') 描述：将col字符串中第一个'@'之前的字符使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from basicemailmasking('Alex15@huawei.com','x'); basicemailmasking ------------------- xxxxxx@huawei.com (1 row) fullemailmasking(col text, letter char default 'x') 描述：将col字符串中出现最后一个'.'之前的字符(除'@'外)使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from fullemailmasking('Alex15@huawei.com','x'); fullemailmasking ------------------- xxxxxx@xxxxxx.com (1 row) alldigitsmasking(col text, letter char default '0') 描述：将col字符串中出现的数字使用letter替换。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from alldigitsmasking('abcdef 123456 ui 323 jsfd321 j3k2l3','0'); alldigitsmasking ------------------------------------- abcdef 000000 ui 000 jsfd000 j0k0l0 (1 row) shufflemasking(col text) 描述：将col字符串中的字符乱序排列。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from shufflemasking('abcdef 123456 ui 323 jsfd321 j3k2l3'); shufflemasking ------------------------------------- 22dc3316 3jb af4e3f135sjl ud2 k32i (1 row) randommasking(col text) 描述：将col字符串中的字符随机化。 参数：待替换的字符串、替换字符。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from randommasking('abcdef'); randommasking --------------- 63d8dc (1 row) regexpmasking(col text, reg text, replace_text text, pos INTEGER default 0, reg_len INTEGER default -1) 描述：将col字符串使用正则表达式替换。 参数：待替换的字符串、正则表达式、替换的起始位置、替换长度。 返回值类型：text 示例： 1 2 3 4 5 gaussdb=# select * from regexpmasking('abcdef 123456 ui 323 jsfd321 j3k2l3','[\d+]','0'); regexpmasking ------------------------------------- abcdef 000000 ui 000 jsfd000 j0k0l0 (1 row) 父主题： 函数和操作符

DB_TAB_COL_STATIS TICS DB_TAB_COL_STATISTI CS 视图显示从DB_TAB_COLUMNS中提取的列统计信息和直方图信息。所有用户都可以访问该视图。该视图同时存在于PG_CATA LOG 和SYS Schema下。该视图在LOW_VALUE、HIGH_VALUE字段，由于底层表结构不同原因，与A数据库取值有差异，当LOW_VALUE为高频值时， GaussDB 的LOW_VALUE为次小值。当HIGH_VALUE为高频值时，GaussDB的HIGH_VALUE为次高值。HISTOG RAM 字段，由于统计方式不同原因，与A数据库取值有差异，GaussDB只支持两种类型直方图frequency，equi-width。SCOPE字段，由于GaussDB不支持全局临时表统计原因，与A数据库取值有差异，GaussDB只支持本地临时表信息统计，默认置SHARED。 表1 DB_TAB_COL_STATISTICS字段 名称 类型 描述 owner character varying(128) 表的所有者。 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 列的直方图中的桶数。 sample_size numeric 用于分析此列的样本量。 last_analyzed timestamp(0) without time zone 最近分析此列的日期。数据库重启后，数据会丢失。 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-W IDT H：表示等宽直方图。 scope character varying(7) 该值SHARED用于在除全局临时表之外的任何表上收集的统计信息，值为SHARED。 schema character varying(64) 列所属的名称空间的名称。 父主题： 系统视图

PG_PARTITION PG_PARTITION系统表存储数据库内所有分区表（partitioned table）、分区（table partition）和分区索引（index partition）四类对象的信息。分区表索引（partitioned index）的信息不在PG_PARTITION系统表中保存。由于分区表（partitioned table）没有实际的物理文件，所以在pg_partition中不会记录其relfilenode，relpages，reltuples，reltoastrelid，reltoastidxid等信息。 表1 PG_PARTITION字段 名称 类型 描述 oid oid 行标识符（隐含属性，必须明确选择）。 relname name 分区表、分区、分区上toast表和分区索引的名称。 parttype "char" 对象类型： 'r'：partitioned table 'p'：table partition 's'：table subpartition 'x'：index partition parentid oid 当对象为分区表或分区时，此字段表示分区表在PG_CLASS中的OID。 当对象为二级分区时，此字段标识其一级分区在PG_PARTITION中的OID。 当对象为index partition时，此字段表示所属分区表索引（partitioned index）的OID。 rangenum integer 保留字段。 intervalnum integer 保留字段。 partstrategy "char" 分区表分区策略，现在仅支持： 'r'：范围分区。 'v'：数值分区。 'i'：间隔分区。 'l'：list分区。 'h'：hash分区。 'n'：无效分区。 relfilenode oid table partition、index partition、分区上toast表的物理存储位置。 reltablespace oid table partition、index partition、分区上toast表所属表空间的OID。 relpages double precision 统计信息：table partition、index partition的数据页数量。 reltuples double precision 统计信息：table partition、index partition的元组数。 relallvisible integer 统计信息：table partition、index partition的可见数据页数。 reltoastrelid oid table partition所对应toast表的OID。 reltoastidxid oid table partition所对应toast表的索引的OID。 indextblid oid index partition对应table partition的OID。 indisusable boolean 分区索引是否可用。 relfrozenxid xid32 冻结事务ID号。 为保持前向兼容，保留此字段，新增relfrozenxid64用于记录此信息。 intspnum integer 间隔分区所属表空间的个数。 partkey int2vector 分区键的列号。 intervaltablespace oidvector 间隔分区所属的表空间，间隔分区以round-robin方式落在这些表空间内。 interval text[] 间隔分区的间隔值。 boundaries text[] 范围分区和间隔分区的上边界。 transit text[] 间隔分区的跳转点。 reloptions text[] 设置partition的存储属性，与pg_class.reloptions的形态一样，用“keyword=value”格式的字符串来表示 ，目前用于在线扩容的信息搜集。 relfrozenxid64 xid 冻结事务ID号。 relminmxid xid 冻结多事务ID号。 partitionno integer 用于维护分区表中的分区Map结构。 当对象为分区时，此字段表示分区ID，从1开始自增。 当对象为分区表时，此字段表示分区ID的最大值，并使用负值来特殊标记，该值会随着部分分区DDL语法不断递增。 当对象为其他类型时，此字段为空值，没有任何含义。 partitionno是一个永久自增列，可以通过语法ALTER TABLE t_name RESET PARTITION或者VACUUM FULL命令重置/回收。 subpartitionno integer 用于维护分区表中的二级分区Map结构。 当对象为二级分区时，此字段表示二级分区ID，从1开始自增。 当对象为二级分区表的一级分区时，此字段表示二级分区ID的最大值，并使用负值来特殊标记，该值会随着部分分区DDL语法不断递增。 当对象为其他类型时，此字段为空值，没有任何含义。 subpartitionno是一个永久自增列，可以通过语法ALTER TABLE t_name RESET PARTITION或者VACUUM FULL命令重置/回收。 父主题： 系统表

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。 父主题： 系统视图

STATIO_ALL_TABLES STATIO_ALL_TABLES视图将包含数据库中每个表（包括TOAST表）的一行，显示出特定表I/O的统计。 表1 STATIO_ALL_TABLES字段 名称 类型 描述 relid oid 表OID。 schemaname name 该表模式名。 relname name 表名。 heap_blks_read bigint 从该表中读取的磁盘块数。 heap_blks_hit bigint 该表缓存命中数。 idx_blks_read bigint 从表中所有索引读取的磁盘块数。 idx_blks_hit bigint 表中所有索引命中缓存数。 toast_blks_read bigint 该表的TOAST表读取的磁盘块数（如果存在）。 toast_blks_hit bigint 该表的TOAST表命中缓冲区数（如果存在）。 tidx_blks_read bigint 该表的TOAST表索引读取的磁盘块数（如果存在）。 tidx_blks_hit bigint 该表的TOAST表索引命中缓冲区数（如果存在）。 父主题： Cache/IO

DB4AI.PREPARE_SNAPSHOT_INTERNAL PREPARE_SNAPSHOT_INTERNAL是db4ai.prepare_snapshot函数的内置执行函数。函数存在信息校验，无法直接调用。 表1 DB4AI.PREPARE_SNAPSHOT_INTERNAL入参和返回值列表 参数 类型 描述 s_id IN BIGINT 快照ID p_id IN BIGINT 父快照ID m_id IN BIGINT 矩阵id r_id IN BIGINT 根快照ID i_schema IN NAME 快照模式 i_name IN NAME 快照名称 i_commands IN TEXT[] 定义快照修改的DDL和DML命令 i_comment IN TEXT 快照描述 i_owner IN NAME 快照所有者 i_idx INOUT INT exec_cmds的索引 i_exec_cmds INOUT TEXT[] 用于执行的DDL和DML i_mapping IN NAME[] 将用户列映射到备份列；如果不为NULL，则生成规则 父主题： DB4AI Schema

事务管理 在ecpg缺省模式下，语句只有在EXEC SQL COMMIT发出的时候才被提交，嵌入的SQL接口也支持事务的自动提交（通过EXEC SQL SET AUTOCOMMIT TO ON语句设置自动提交）。在自动提交模式下，每条命令都是自动提交的，除非它们包围在一个明确的事务块里。自动提交模式可以用EXEC SQL SET AUTOCOMMIT TO OFF语句关闭。 常见事务管理命令如下： EXEC SQL COMMIT：提交正在进行的事务。 EXEC SQL ROLLBACK：回滚正在进行的事务。 EXEC SQL SET AUTOCOMMIT TO ON：启动自动提交模式。 EXEC SQL SET AUTOCOMMIT TO OFF：关闭自动提交模式，缺省模式。 父主题： 执行SQL命令

功能描述 FETCH通过已创建的游标来检索数据。 每个游标都有一个供FETCH使用的关联位置。游标的关联位置可以在查询结果的第一行之前，或者在结果中的任意行，或者在结果的最后一行之后： 游标刚创建完之后，关联位置在第一行之前。 在抓取了一些移动行之后，关联位置在检索到的最后一行上。 如果FETCH抓取完了所有可用行，它就停在最后一行后面，或者在反向抓取的情况下是停在第一行前面。 FETCH ALL或FETCH BACKWARD ALL总是把游标的关联位置放在最后一行或者在第一行前面。

注意事项 如果游标定义了NO SCROLL，则不允许使用例如FETCH BACKWARD之类的反向抓取。 NEXT，PRIOR，FIRST，LAST，ABSOLUTE，RELATIVE形式在恰当地移动游标之后抓取一条记录。如果后面没有数据行，就返回一个空的结果，此时游标就会停在查询结果的最后一行之后（向后查询时）或者第一行之前（向前查询时）。 FORWARD和BACKWARD形式在向前或者向后移动的过程中抓取指定的行数，然后把游标定位在最后返回的行上；或者，如果count大于可用的行数，则在所有行之后（向后查询时）或者之前（向前查询时）。 RELATIVE 0，FORWARD 0，BACKWARD 0都要求在不移动游标的前提下抓取当前行，也就是重新抓取最近刚抓取过的行。除非游标定位在第一行之前或者最后一行之后，否则这个动作都应该成功。而当游标定位在第一行之前或者最后一行之后，不返回任何行。

语法格式 FETCH [ direction { FROM | IN } ] cursor_name; 其中direction子句为可选参数。 NEXT | PRIOR | FIRST | LAST | ABSOLUTE count | RELATIVE count | count | ALL | FORWARD | FORWARD count | FORWARD ALL | BACKWARD | BACKWARD count | BACKWARD ALL

示例 --创建一个schema。 gaussdb=# CREATE SCHEMA tpcds; --创建表tpcds.customer_address。 gaussdb=# CREATE TABLE tpcds.customer_address ( ca_address_sk INTEGER NOT NULL, ca_address_id CHARACTER(16) NOT NULL, ca_street_number INTEGER , ca_street_name CHARACTER (20) ); --向表中插入多条记录。 gaussdb=# INSERT INTO tpcds.customer_address VALUES (1, 'AAAAAAAABAAAAAAA', '18', 'Jackson'),(2, 'AAAAAAAACAAAAAAA', '362', 'Washington 6th'),(3, 'AAAAAAAADAAAAAAA', '585', 'Dogwood Washington'); --SELECT语句，用一个游标读取一个表。开始一个事务。 gaussdb=# START TRANSACTION; --建立一个名为cursor1的游标。 gaussdb=# CURSOR cursor1 FOR SELECT * FROM tpcds.customer_address ORDER BY 1; --抓取头3行到游标cursor1里。 gaussdb=# FETCH FORWARD 3 FROM cursor1; ca_address_sk | ca_address_id | ca_street_number | ca_street_name ---------------+------------------+------------------+-------------------- 1 | AAAAAAAABAAAAAAA | 18 | Jackson 2 | AAAAAAAACAAAAAAA | 362 | Washington 6th 3 | AAAAAAAADAAAAAAA | 585 | Dogwood Washington (3 rows) --关闭游标并提交事务。 gaussdb=# CLOSE cursor1; --结束一个事务。 gaussdb=# END; --VALUES子句，用一个游标读取VALUES子句中的内容。开始一个事务。 gaussdb=# START TRANSACTION; --建立一个名为cursor2的游标。 gaussdb=# CURSOR cursor2 FOR VALUES(1,2),(0,3) ORDER BY 1; --抓取头2行到游标cursor2里。 gaussdb=# FETCH FORWARD 2 FROM cursor2; column1 | column2 ---------+--------- 0 | 3 1 | 2 (2 rows) --关闭游标并提交事务。 gaussdb=# CLOSE cursor2; --结束一个事务。 gaussdb=# END; --WITH HOLD游标的使用，开启事务。 gaussdb=# START TRANSACTION; --创建一个with hold游标。 gaussdb=# DECLARE cursor1 CURSOR WITH HOLD FOR SELECT * FROM tpcds.customer_address ORDER BY 1; --抓取头2行到游标cursor1里。 gaussdb=# FETCH FORWARD 2 FROM cursor1; ca_address_sk | ca_address_id | ca_street_number | ca_street_name ---------------+------------------+------------------+-------------------- 1 | AAAAAAAABAAAAAAA | 18 | Jackson 2 | AAAAAAAACAAAAAAA | 362 | Washington 6th (2 rows) --结束事务。 gaussdb=# END; --抓取下一行到游标cursor1里。 gaussdb=# FETCH FORWARD 1 FROM cursor1; ca_address_sk | ca_address_id | ca_street_number | ca_street_name ---------------+------------------+------------------+-------------------- 3 | AAAAAAAADAAAAAAA | 585 | Dogwood Washington (1 row) --关闭游标。 gaussdb=# CLOSE cursor1; --删除表tpcds.customer_address。 gaussdb=# DROP TABLE tpcds.customer_address; --删除SCHEMA。 gaussdb=# DROP SCHEMA tpcds CASCADE;

参数说明 direction 定义抓取数据的方向。 取值范围： NEXT（缺省值） 从当前关联位置开始，抓取下一行。 PRIOR 从当前关联位置开始，抓取上一行。 FIRST 抓取查询的第一行（和ABSOLUTE 1相同）。 LAST 抓取查询的最后一行（和ABSOLUTE -1相同）。 ABSOLUTE count 抓取查询中第count行。 ABSOLUTE抓取不会比用相对位移移动到需要的数据行更快，因为下层的实现必须遍历所有中间的行。 count取值范围：有符号的整数 count为正数，就从查询结果的第一行开始，抓取第count行。 count为负数，就从查询结果末尾抓取第abs(count)行。 count为0时，定位在第一行之前。 RELATIVE count 从当前关联位置开始，抓取随后或前面的第count行。 取值范围：有符号的整数 count为正数就抓取当前关联位置之后的第count行。 count为负数就抓取当前关联位置之前的第abs(count)行。 如果当前行没有数据的话，RELATIVE 0返回空。 count 抓取随后的count行（和FORWARD count一样）。 ALL 从当前关联位置开始，抓取所有剩余的行（和FORWARD ALL一样）。 FORWARD 抓取下一行（和NEXT一样）。 FORWARD count 从当前关联位置开始，抓取随后或前面的count行。 FORWARD ALL 从当前关联位置开始，抓取所有剩余行。 BACKWARD 从当前关联位置开始，抓取前面一行(和PRIOR一样) 。 BACKWARD count 从当前关联位置开始，抓取前面的count行（向后扫描）。 取值范围：有符号的整数 count为正数就抓取当前关联位置之前的count行。 count为负数就抓取当前关联位置之后的abs（count）行。 如果有数据的话，BACKWARD 0重新抓取当前行。 BACKWARD ALL 从当前关联位置开始，抓取所有前面的行（向后扫描） 。 { FROM | IN } cursor_name 使用关键字FROM或IN指定游标名称。 取值范围：已创建的游标的名称。

MY_IND_COLUMNS MY_IND_COLUMNS视图显示当前用户下所有索引的字段信息。所有用户都可以访问。该视图同时存在于PG_CATALOG和SYS Schema下。 表1 MY_IND_COLUMNS字段 名称 类型 描述 index_owner character varying(64) 索引的所有者。 index_name character varying(64) 索引名。 table_owner character varying(64) 表的所有者。 table_name character varying(64) 表名。 column_name name 列名。 column_position smallint 索引中列的位置。 column_length numeric 列的长度，如果列是变长类型，该字段取值为NULL。 char_length numeric 列的最大字节长度。 descend character varying 表示列是按降序（DESC）还是升序（ASC）排序。 collated_column_id numeric 暂不支持，值为NULL。 父主题： 系统视图

PG_PREPARED_STATEMENTS PG_PREPARED_STATEMENTS视图显示当前会话所有可用的预备语句的信息。 表1 PG_PREPARED_STATEMENTS字段 名称 类型 描述 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。 父主题： 系统视图

语法格式 为当前会话设置会话用户标识符和当前用户标识符。 SET [ SESSION | LOCAL ] SESSION AUTHORIZATION role_name PASSWORD 'password'; 重置会话和当前用户标识符为初始认证的用户名。 {SET [ SESSION | LOCAL ] SESSION AUTHORIZATION DEFAULT | RESET SESSION AUTHORIZATION};

参数说明 SESSION 声明这个命令只对当前会话起作用。 LOCAL 声明该命令只在当前事务中有效。 role_name 用户名。 取值范围：字符串，要符合标识符命名规范。 password 角色的密码。要求符合密码的命名规则。 使用密文密码限制如下： 管理员用户不能使用密文密码切换到其他管理员用户，只能向权限更低用户切换。 使用密文密码通常用于gs_dump、gs_dumpall导出场景，其他场景不建议直接使用密文密码。 DEFAULT 重置会话和当前用户标识符为初始认证的用户名。

SUMMARY_STAT_XACT_ALL_TABLES 显示数据库各节点所有Schema中所有普通表和toast表的事务状态信息的汇总求和结果。 表1 SUMMARY_STAT_XACT_ALL_TABLES字段 名称 类型 描述 schemaname name 此表所在的Schema名。 relname name 表名。 seq_scan numeric 此表发起的顺序扫描数。 seq_tup_read numeric 顺序扫描抓取的活跃行数。 idx_scan numeric 此表发起的索引扫描数。 idx_tup_fetch numeric 索引扫描抓取的活跃行数。 n_tup_ins numeric 插入行数。 n_tup_upd numeric 更新行数。 n_tup_del numeric 删除行数。 n_tup_hot_upd numeric HOT更新行数（即没有更新索引列的行数）。 父主题： Object

SUMMARY_STATEMENT 获得各数据库主节点的执行语句（归一化SQL）的全量信息（包含数据库节点）。 当前版本暂不支持对FOR UPDATE关键字进行识别并归一化处理。例如：SELECT * FROM table; 与SELECT * FROM table FOR UPDATE WAIT N; 会被归一化处理为相同的归一化SQL，在query字段中体现。 表1 SUMMARY_STATEMENT字段 名称 类型 描述 node_name name 数据库进程名称。 node_id integer 节点的ID。 user_name name 用户名称。 user_id oid 用户OID。 unique_sql_id bigint 归一化的SQL ID。 query text 归一化的SQL。 备注：长度受track_activity_query_size控制。 n_calls bigint 调用次数。 min_elapse_time bigint SQL在内核内的最小运行时间（单位：微秒）。 max_elapse_time bigint SQL在内核内的最大运行时间（单位：微秒）。 total_elapse_time bigint SQL在内核内的总运行时间（单位：微秒）。 n_returned_rows bigint SELECT返回的结果集行数。 n_tuples_fetched bigint 随机扫描行。 n_tuples_returned bigint 顺序扫描行。 n_tuples_inserted bigint 插入行。 n_tuples_updated bigint 更新行。 n_tuples_deleted bigint 删除行。 n_blocks_fetched bigint buffer的块访问次数。 n_blocks_hit bigint buffer的块命中次数。 n_soft_parse bigint 软解析次数。 n_hard_parse bigint 硬解析次数。 db_time bigint 有效的DB时间花费，多线程将累加（单位：微秒）。 cpu_time bigint CPU时间（单位：微秒）。 execution_time bigint 执行器内执行时间（单位：微秒）。 parse_time bigint SQL解析时间（单位：微秒）。 plan_time bigint SQL生成计划时间（单位：微秒）。 rewrite_time bigint SQL重写时间（单位：微秒）。 pl_execution_time bigint plpgsql上的执行时间（单位：微秒）。 pl_compilation_time bigint plpgsql上的编译时间（单位：微秒）。 data_io_time bigint I/O上的时间花费（单位：微秒）。 net_send_info text 通过物理连接发送消息的网络状态，包含时间（微秒）、调用次数、吞吐量（字节）。单机模式下不支持该字段。 net_recv_info text 通过物理连接接收消息的网络状态，包含时间（微秒）、调用次数、吞吐量（字节）。单机模式下不支持该字段。 net_stream_send_info text 通过逻辑连接发送消息的网络状态，包含时间（微秒）、调用次数、吞吐量（字节）。单机模式下不支持该字段。 net_stream_recv_info text 通过逻辑连接接收消息的网络状态，包含时间（微秒）、调用次数、吞吐量（字节）。单机模式下不支持该字段。 last_updated timestamp with time zone 最后一次更新该语句的时间。 sort_count bigint 排序执行的次数。 sort_time bigint 排序执行的时间（单位：微秒）。 sort_mem_used bigint 排序过程中使用的work memory大小（单位：KB）。 sort_spill_count bigint 排序过程中，若发生落盘，写文件的次数。 sort_spill_size bigint 排序过程中，若发生落盘，使用的文件大小（单位：KB）。 hash_count bigint hash执行的次数。 hash_time bigint hash执行的时间（单位：微秒）。 hash_mem_used bigint hash过程中使用的work memory大小（单位：KB）。 hash_spill_count bigint hash过程中，若发生落盘，写文件的次数。 hash_spill_size bigint hash过程中，若发生落盘，使用的文件大小（单位：KB）。 parent_unique_sql_id bigint 父语句的unique_sql_id，非存储过程子语句该值为0。 父主题： Query

子查询 【规则】禁止一条SQL语句中，出现重复子查询语句。 【建议】少用标量子查询。 标量子查询指结果为一个值，并且条件表达式为等值的子查询。示例如下： 不符合规范的语句 SELECT * FROM t1 WHERE id = (SELECT id FROM t2 LIMIT 1); 上述语句建议业务拆分为两条SQL语句，先执行子查询。 【建议】避免在SELECT目标列中使用子查询，可能导致计划无法下推影响执行性能。 【建议】子查询嵌套深度不建议超过两层。 由于子查询会带来临时表开销，过于复杂的查询应考虑从业务逻辑上进行优化。 父主题： 数据库编程规范

PG_AM PG_AM系统表存储有关索引访问方法的信息。系统支持的每种索引访问方法都有一行。 表1 PG_AM字段 名称 类型 引用 描述 oid oid - 行标识符（隐含属性，必须明确选择）。 amname name - 访问方法的名称。 amstrategies smallint - 访问方法的操作符策略个数，或者如果访问方法没有一个固定的操作符策略集则为0。 amsupport smallint - 访问方法的支持过程个数。 amcanorder boolean - 这种访问方式是否支持通过索引字段值的命令扫描排序。 amcanorderbyop boolean - 这种访问方式是否支持通过索引字段上操作符的结果的命令扫描排序。 amcanbackward boolean - 访问方式是否支持向后扫描。 amcanunique boolean - 访问方式是否支持唯一索引。 amcanmulticol boolean - 访问方式是否支持多字段索引。 amoptionalkey boolean - 访问方式是否支持第一个索引字段上没有任何约束的扫描。 amsearcharray boolean - 访问方式是否支持ScalarArrayOpExpr搜索。 amsearchnulls boolean - 访问方式是否支持IS NULL/NOT NULL搜索。 amstorage boolean - 是否允许索引存储的数据类型与列的数据类型不同。 amclusterable boolean - 是否允许在一个这种类型的索引上聚簇。 ampredlocks boolean - 是否允许这种类型的一个索引管理细粒度的谓词锁定。 amkeytype oid PG_TYPE.oid 存储在索引里数据的类型，如果不是一个固定的类型则为0。 aminsert regproc PG_PROC.proname “插入这个行”函数。 ambeginscan regproc PG_PROC.proname “准备索引扫描”函数。 amgettuple regproc PG_PROC.proname “下一个有效行”函数，如果没有则为0。 amgetbitmap regproc PG_PROC.proname “抓取所有的有效行” 函数，如果没有则为0。 amrescan regproc PG_PROC.proname “（重新）开始索引扫描”函数。 amendscan regproc PG_PROC.proname “索引扫描后清理” 函数。 ammarkpos regproc PG_PROC.proname “标记当前扫描位置”函数。 amrestrpos regproc PG_PROC.proname “恢复已标记的扫描位置”函数。 ammerge regproc PG_PROC.proname “归并多个索引对象”函数。 ambuild regproc PG_PROC.proname “建立新索引”函数。 ambuildempty regproc PG_PROC.proname “建立空索引”函数。 ambulkdelete regproc PG_PROC.proname 批量删除函数。 amvacuumcleanup regproc PG_PROC.proname VACUUM后的清理函数。 amcanreturn regproc PG_PROC.proname 检查是否索引支持唯一索引扫描的函数，如果没有则为0。 amcostestimate regproc PG_PROC.proname 估计一个索引扫描开销的函数。 amoptions regproc PG_PROC.proname 为一个索引分析和确认reloptions的函数。 父主题： 系统表

开发流程 数据库Go驱动遵循Go语言第三方库的规则，只需在应用程序中import驱动，并将驱动代码放入GOPATH路径。 图1 采用Go开发应用程序的流程图 根据图1，Go驱动应用开发流程依赖于Go原生的database/sql包和GaussDB开发的driver驱动，database/sql包提供用户使用的标准接口，GaussDB实现需要被database/sql包调用的接口。 父主题： 基于Go驱动开发

DBE_PLDEBUGGER.info_locals debug端调试过程中，调用info_locals，打印当前存储过程内变量。该函数入参frameno表示查询遍历的栈层数，支持无入参调用，缺省为查看最上层栈变量。 表1 info_locals入参和返回值列表 名称 类型 描述 frameno IN integer （可选） 指定的栈层数，缺省为最顶层 varname OUT text 变量名 vartype OUT text 变量类型 value OUT text 变量值 package_name OUT text 变量对应的package名，非package时为空 isconst OUT boolean 是否为常量 父主题： DBE_PLDEBUGGER Schema

unix_socket_directory 参数说明：设置GaussDB服务器侦听客户端连接的Unix域套接字目录。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 该参数的长度限制于操作系统的长度，超过该限制将会导致Unix-domain socket path "xxx" is too long的问题。 取值范围：字符串 默认值：空字符串（实际值由安装时配置文件指定）

service_reserved_connections 参数说明：为后台运维用户（带有persistence属性）预留的最少连接数，不建议设置过大。该参数和max_connections参数配合使用，运维用户的最大连接数等于max_connections + service_reserved_connections。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，最小值为0，最大值为262143。 默认值：10 注意：如果设置过小，会导致在max_connections满的情况下，该运维用户（带有persistence属性）无法连接数据库，作业无法正常执行。

application_name 参数说明：当前连接请求当中，所使用的客户端名称。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 在备机请求主机进行日志复制时，如果该参数非空串，那么会被用来作为备机在主机上的流复制槽名字。此时，如果该参数长度超过61个字节，那么流复制槽名字只会截取使用前61个字节的字符。 取值范围：字符串。 默认值：空字符串(连接到后端的应用名，以实际安装为准)

unix_socket_permissions 参数说明：设置Unix域套接字的访问权限。 Unix域套接字使用普通的Unix文件系统权限集。这个参数的值应该是数值的格式（chmod和umask命令可接受的格式）。如果使用自定义的八进制格式，数字必须以0开头。 建议设置为0770（只有当前连接数据库的用户和同组的人可以访问）或者0700（只有当前连接数据库的用户自己可以访问，同组或者其他人都没有权限）。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：0000-0777 默认值：0700 在Linux中，文档具有十个属性，其中第一个属性为文档类型，后面九个为权限属性，分别为Owner，Group及Others这三个组别的read、write、execute属性。 文档的权限属性分别简写为r，w，x，这九个属性三个为一组，也可以使用数字来表示文档的权限，对照表如下： r：4 w: 2 x：1 -：0 同一组（owner/group/others）的三个属性是累加的。 例如，-rwxrwx---表示这个文档的权限为： owner = rwx = 4+2+1 = 7 group = rwx = 4+2+1 = 7 others = --- = 0+0+0 = 0 所以其权限为0770。

listen_addresses 参数说明：声明服务器侦听客户端的TCP/IP地址。 该参数指定GaussDB服务器使用哪些IP地址进行侦听，如IPV4。服务器主机上可能存在多个网卡，每个网卡可以绑定多个IP地址，该参数就是控制GaussDB绑定在哪个或者哪几个IP地址上。而客户端则可以通过该参数中指定的IP地址来连接GaussDB或者给GaussDB发送请求。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围： 主机名或IP地址，多个值之间用英文逗号分隔。 星号“*”或“0.0.0.0”表示侦听所有IP地址。配置侦听所有IP地址存在安全风险，不推荐用户使用。必须与有效地址结合使用（比如本地IP等），否则，可能造成Build失败的问题。同时，主备环境下配置为“\*”或“0.0.0.0”时，主节点数据库路径下postgresql.conf文件中的localport端口号不能为数据库dataPortBase+1，否则会导致数据库无法启动。 当该参数值非法时（如包含非法IP、非法字符，参数值为空，或重复侦听），进程将启动失败。 默认值：数据库实例安装好后，根据public_cloud.conf配置文件中不同实例的IP地址配置不同默认值。DN的默认参数值为：listen_addresses = 'data.net网卡对应的IP地址'。 public_cloud.conf文件保存的网卡信息，包括：mgr.net（管理网卡）、data.net（数据网卡）、virtual.net（虚拟网卡）。 支持gs_guc reload方式进行设置该参数值，GaussDB内核会按照“侦听新IP、保留重复IP的侦听、关闭无效IP侦听”的策略，动态侦听该参数配置的IP。若存在非法IP（如本机未配置此IP、无效的IP值、该IP已被侦听等）时，内核侦听IP失败，此时会出现listen_addresses设置值和实际侦听IP的状况不匹配。 若通过gs_guc reload方式设置参数值，且参数值中均为非法IP时，侦听新IP失败，同时会取消全部旧IP的侦听。若参数为空时，直接拦截而保持旧IP侦听。 若在进程启动参数中配置listen_addresses后，该参数将强制指定为设置值而不会被reload修改。 若设置新参数值和已设置旧参数值相同时，将不再进行侦听动作。故设置listen_addresses参数值且列表中某非法IP时，内核侦听此IP失败；待IP变为合法后，再次设置相同参数值，由于前后两次参数值相同，则不会侦听此IP。此时需通过gs_guc reload方式将此IP从参数值中去除，并再次设置添加该IP，才会成功侦听。 通过gs_guc reload方式刷新该参数后，若不再侦听某IP后，需再执行gs_validate_ext_listen_ip函数进行清理连接操作，具体入参及执行详见该函数说明。 禁止gs_guc工具通过"-N all"方式reload刷新所有DN的listen_addresses参数值，仅允许单DN设置。 动态修改listen_addresses属于高危操作，若配置有误可能导致数据库无法接受新连接，进而影响业务，请谨慎操作。