华为云用户手册

backend_flush_after 参数说明：设置backend线程刷页个数超过设定的阈值时，告知操作系统开始将操作系统缓存中的页面异步刷盘。 GaussDB 中，磁盘页大小为8KB。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，0~256（0表示关闭异步刷盘功能），单位页面（8KB）。可以设置页面的数量或字节的大小，例如，取值64或512KB，表示backend线程连续写64个磁盘页，即64*8=512KB磁盘空间后会进行异步刷盘。 默认值：0

temp_file_limit 参数说明：限制一个会话中，触发下盘操作时，下盘文件占用的空间大小。例如一次会话中，排序和哈希表使用的临时文件，或者游标占用的临时文件。此设置为会话级别的下盘文件控制。 参数类型：整型 参数单位：kB SQL查询执行时使用的临时表空间不在此限制。 取值范围：-1~2147483647，其中-1表示没有限制。 默认值：-1 设置方式：该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：无。

comm_proxy_attr 参数说明：通信代理库相关参数配置。 该参数仅支持欧拉2.9系统下的集中式ARM单机。 本功能在线程池开启状态下生效，即enable_thread_pool为on。 配置该参数时需同步配置GUC参数local_bind_address为libos_kni的网卡IP。 参数模板：comm_proxy_attr = '{enable_libnet:true, enable_dfx:false, numa_num:4, numa_bind:[[30,31],[62,63],[94,95],[126,127]]}' 可配置参数说明。 enable_libnet：是否开启用户态协议，取值范围：true、false。 enable_dfx：是否开启通信代理库视图，取值范围：true、false。 numa_num：机器环境中numa的数量，支持2P、4P服务器，取值范围：4、8。 numa_bind：代理线程绑核参数，每个numa两个CPU绑核，共numa_num组，取值范围：[0，cpu数-1]。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串，长度大于0。 默认值：'none'

umdk_port 参数说明：当DN主备间通信使用UMDK协议时，主备DN网络通信链路的侦听端口。 参数类型：整型 参数单位：无 取值范围：1 ～ 65535 默认值：dataPortBase+15，dataPortBase的值为数据库初次安装时GUC参数port的取值。 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 GaussDB数据库 适配UMDK通信协议栈，UMDK能力由操作系统提供和维护。 GaussDB数据库侧umdk_port默认不会侦听，需要在GUC参数umdk_enabled打开后，且当前环境硬件和软件支持UMDK协议时，数据库UMDK协议的功能才会开启，相关端口才会被侦听，DN主备开始执行UMS网络协议（UMS为UMDK的网络协议族）。

umdk_enabled 参数说明：控制当前数据库主备DN是否开启UMDK功能。若DN主备间通信使用UMDK通信协议，则DN上相关日志关键字为“umdk”，若DN主备间通信使用TCP协议，则记录log日志。目前仅部分场景支持该功能。 参数类型：布尔型 参数单位：无 取值范围： on：开启UMDK功能，若当前数据库实例不支持UMDK网络通信协议，则DN主备间通信走TCP协议；若当前数据库实例支持UMDK网络通信协议，DN主备间通信走UMDK协议。 off：不开启UMDK功能，DN主备间通信走TCP协议。 默认值：off 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：根据具体使用场景进行设置。

tcp_keepalives_interval 参数说明：在支持TCP_KEEPINTVL套接字选项的操作系统上，以秒数声明在重新传输之间等待响应的时间。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：0-180，单位为s。 默认值：30 如果操作系统不支持TCP_KEEPINTVL选项，这个参数的值必须为0。 在通过UNIX域套接字进行的连接的操作系统上，这个参数将被忽略。 将该值设置为0时，将使用系统的值。 该参数在不同的会话之间不共享，也就是说不同的会话连接可能有不同的值。 查看该参数时查出来的是当前会话连接内的参数值，而不是GUC副本的值。

tcp_user_timeout 参数说明：在支持TCP_USER_TIMEOUT套接字选项的操作系统上，设置GaussDB在发送数据时，指定传输的数据在TCP连接被强制关闭之前可以保持未确认状态的最大时长。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 如果操作系统不支持TCP_USER_TIMEOUT选项，这个参数的值将不生效，默认为0。 在通过UNIX域套接字进行连接的操作系统上，这个参数将被忽略。 取值范围：0-3600000，单位为ms。其中0表示跟随操作系统设置。 默认值：0 注意，不同操作系统内核下，这个参数生效结果将不同： aarch64 EulerOS（Linux内核版本：4.19），超时时间即为该参数设置值。 x86 Euler2.5（Linux内核版本：3.10），超时时间不是该参数设置值，而是不同区间的最大值，即超时时间取值为：tcp_user_timeout设置值所处“Linux TCP重传总耗时”区间的上限最大值。例如：tcp_user_timeout=40000时，重传总耗时为51秒。 表1 x86 Euler2.5（Linux内核版本：3.10）tcp_user_timeout参数取值示意 Linux TCP重传次数 Linux TCP重传总耗时区间（秒） tcp_user_timeout设置举例（毫秒） 实际Linux TCP重传总耗时（秒） 1 (0.2,0.6] 400 0.6 2 (0.6,1.4] 1000 1.4 3 (1.4,3] 2000 3 4 (3,6.2] 4000 6.2 5 (6.2,12.6] 10000 12.6 6 (12.6,25.4] 20000 25.4 7 (25.4,51] 40000 51 8 (51,102.2] 80000 102.2 9 (102.2,204.6] 150000 204.6 10 (204.6,324.6] 260000 324.6 11 (324.6,444.6] 400000 444.6 注：TCP每次重传耗时随重传次数指数增加，当TCP一次重传到达120秒后，后续每次重传都将耗时120秒不再变化。

tcp_keepalives_idle 参数说明：在支持TCP_KEEPIDLE套接字选项的系统上，设置发送活跃信号的间隔秒数。不设置发送保持活跃信号，连接就会处于闲置状态。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 如果操作系统不支持TCP_KEEPIDLE选项 ，这个参数的值必须为0。 在通过UNIX域套接字进行的连接的操作系统上，这个参数将被忽略。 将该值设置为0时，将使用系统的值。 该参数在不同的会话之间不共享，也就是说不同的会话连接可能有不同的值。 查看该参数时查出来的是当前会话连接内的参数值，而不是GUC副本的值。 取值范围：0-3600，单位为s。 默认值：60

tcp_keepalives_count 参数说明：在支持TCP_KEEPCNT套接字选项的操作系统上，设置GaussDB服务端在断开与客户端连接之前可以等待的保持活跃信号个数。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 如果操作系统不支持TCP_KEEPCNT选项，这个参数的值必须为0。 在通过UNIX域套接字进行连接的操作系统上，这个参数将被忽略。 将该值设置为0时，将使用系统的值。 该参数在不同的会话之间不共享，也就是说不同的会话连接可能有不同的值。 查看该参数时查出来的是当前会话连接内的参数值，而不是GUC副本的值。 取值范围：0-100，其中0表示GaussDB未收到客户端反馈的保持活跃信号则立即断开连接。 默认值：20

DBE_SQL_UTIL.show_sql_patch show_sql_patch是用于显示给定patch_name对应的SQL PATCH的接口函数，返回运行结果，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 表1 DBE_SQL_UTIL.show_sql_patch入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 unique_sql_id OUT bigint 查询全局唯一id。 enabled OUT bool PATCH是否生效。 abort OUT bool 是否是AbortHint。 hint_str OUT text Hint文本。 父主题： DBE_SQL_UTIL Schema

DBE_SQL_UTIL.disable_sql_patch disable_sql_patch是用于禁用SQL PATCH的接口函数，返回执行是否成功，如表1所示。 限制：仅初始用户、sysadmin、opradmin、monadmin用户有权限调用。 表1 DBE_SQL_UTIL.disable_sql_patch入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

DBE_SQL_UTIL.enable_sql_patch enable_sql_patch是用于开启SQL PATCH的接口函数，返回执行是否成功，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 表1 DBE_SQL_UTIL.enable_sql_patch入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

DBE_SQL_UTIL.drop_sql_patch drop_sql_patch是用于删除SQL PATCH的接口函数，返回执行是否成功，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 表1 DBE_SQL_UTIL.drop_sql_patch入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

DBE_SQL_UTIL.create_abort_sql_patch create_abort_sql_patch是用于创建避险SQL PATCH的接口函数，返回执行是否成功，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 表1 DBE_SQL_UTIL.create_abort_sql_patch入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 unique_sql_id IN bigint 查询全局唯一id。 description IN text PATCH的备注，默认值为NULL。 enabled IN bool PATCH是否生效，默认值为true。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

DBE_SQL_UTIL.create_hint_sql_patch create_hint_sql_patch是用于创建调优SQL PATCH的接口函数，返回执行是否成功，如表1所示。 限制：仅初始用户、sysadmin、opradmin和monadmin用户有权限调用。 表1 DBE_SQL_UTIL.create_hint_sql_patch入参和返回值列表 参数 类型 描述 patch_name IN name PATCH名称。 unique_sql_id IN bigint 查询全局唯一id。 hint_string IN text Hint文本。 description IN text PATCH的备注，默认值为NULL。 enabled IN bool PATCH是否生效，默认值为true。 result OUT bool 执行是否成功。 父主题： DBE_SQL_UTIL Schema

DBE_PLDEVELOPER.gs_errors 用于记录PL/SQL对象（存储过程、函数、包、包体）编译过程中遇到的报错信息，如表1所示。 打开plsql_show_all_error参数后，如果编译过程中存在报错，则会跳过报错继续编译并把报错信息记录在gs_errors中，如果关闭plsql_show_all_error参数，且behavior_compat_options参数不为skip_insert_gs_source，则会直接将报错信息插入此表中。 该表的owner是创建的用户，修改存储过程或者package的owner不会修改该表信息。 1、创建包头时的开头（as/is之前）和结尾（end之后），如果出现错误，不会记录在gs_errors表格里面，会直接在客户端返回错误的行号和该行具体内容，返回的行号不一定准确。个别is本身和end本身错误场景也不会记录在gs_errors表格里面。 2、创建包体时的开头（as/is之前）和结尾（end之后），如果出现错误，不会记录在gs_errors表格里面，会直接在客户端返回错误的行号和该行具体内容，返回的行号不一定准确。个别is本身和end本身错误场景也不会记录在gs_errors表格里面。 3、创建包体时，函数或者存储过程的结尾（end之后），如果出现错误，不会记录在gs_errors表格里面，会直接在客户端返回错误的行号和该行具体内容，行号不一定准确。 4、创建包体时，函数或者存储过程的开头（as/is 以及 as/is之前），如果出现错误，报错行数不准确。 5、创建包头时，变量声明少分号，会记录在gs_errors表格里面，记录的报错行号不准确。开启参数不会记录。 6、包体内存储过程或函数内部，自治事务标识符PRAGMA AUTONOMOUS_TRANSACTION声明错误时，不能确保是否能记录在gs_errors表里。 7、客户端直接报错，但是gs_errors表格未记录的情况，如果客户端报错行号不对，本需求不纠正已报错的行号。 8、对于类似if ....then、for....loop、when .... then语句中间的错误或EXCEPTION本身错误，报错行号在本行，而不是下一个分号所在行。 9、包内存储过程或函数内部begin本身错误的场景，报错行数不准。 表1 DBE_PLDEVELOPER.gs_errors字段 名称 类型 描述 id oid 对象id。 owner bigint 对象创建用户id。 nspid oid 对象的模式id。 name name 对象名。 type text 对象类型（procedure/function/package/package body）。 line integer 行号。 src text 报错信息。 父主题： DBE_PLDEVELOPER

DBE_PLDEVELOPER.gs_source 用于记录PL/SQL对象（存储过程、函数、包、包体）编译相关信息，如表1所示。 打开plsql_show_all_error参数后，会把成功或失败的PL/SQL对象编译信息记录在此表中，如果关闭plsql_show_all_error参数则只会将正确的编译相关信息插入此表中。 gs_source表中只记录用户定义的原始对象语句，即使用户使用了ALTER改变了创建的SCHEMA或者名字，gs_source表中的信息也不会发生变化，如果用户更改了对象的SCHEMA或者名字，会导致用户在删除对象后，对象仍存在于gs_source表中。 gs_source表中的owner指创建的用户，不是用户创建存储过程或者package时指定的用户。 数据库默认情况下没有对gs_source表中设置行级访问控制，如果用户想使用数据库隔离性特性，请参考以下语句，自行添加行级访问控制。 ALTER TABLE dbe_pldeveloper.gs_source ENABLE ROW LEVEL SECURITY; CREATE ROW LEVEL SECURITY POLICY all_data_rls ON dbe_pldeveloper.gs_source USING(owner = (select oid from pg_roles where rolname=current_user)); 表1 DBE_PLDEVELOPER.gs_source字段 名称 类型 描述 id oid 对象id。 owner bigint 对象创建用户id。 nspid oid 对象的模式id。 name name 对象名。 type text 对象类型（procedure/function/package/package body）。 status boolean 是否创建成功。 src text 对象创建的原始语句。 父主题： DBE_PLDEVELOPER

DB4AI.PURGE_SNAPSHOT_INTERNAL PURGE_SNAPSHOT_INTERNAL是DB4AI.PURGE_SNAPSHOT函数的内置执行函数，如表1所示。函数存在信息校验，无法直接调用 表1 DB4AI.PURGE_SNAPSHOT_INTERNAL入参和返回值列表 参数 类型 描述 i_schema IN NAME 快照存储的模式名字。 i_name IN NAME 快照名称。 父主题： DB4AI Schema

DB4AI.SAMPLE_SNAPSHOT SAMPLE_SNAPSHOT是DB4AI特性用于对基数据进行采样生成快照的接口函数，如表1所示。通过语法SAMPLE SNAPSHOT调用。 表1 DB4AI.SAMPLE_SNAPSHOT入参和返回值列表 参数 类型 描述 i_schema IN NAME 快照存储的模式名字。 i_parent IN NAME 父快照名称。 i_sample_infixes IN NAME[] 示例快照名称中缀。 i_sample_ratios IN NUMBER[] 每个样本的大小，作为父集的比率。 i_stratify IN NAME[] 分层策略。 i_sample_comments IN TEXT[] 示例快照描述。 res OUT db4ai.snapshot_name 结果。 父主题： DB4AI Schema

DB4AI.PUBLISH_SNAPSHOT PUBLISH_SNAPSHOT是DB4AI特性用于发布快照的接口函数，如表1所示。通过语法PUBLISH SNAPSHOT调用。 表1 DB4AI.PUBLISH_SNAPSHOT入参和返回值列表 参数 类型 描述 i_schema IN NAME 快照存储的模式名字，默认值是当前用户或者PUBLIC。 i_name IN NAME 快照名称。 res OUT db4ai.snapshot_name 结果。 父主题： DB4AI Schema

DB4AI.PREPARE_SNAPSHOT_INTERNAL PREPARE_SNAPSHOT_INTERNAL是db4ai.prepare_snapshot函数的内置执行函数，如表1所示。函数存在信息校验，无法直接调用。 表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

DB4AI.PREPARE_SNAPSHOT PREPARE_SNAPSHOT是DB4AI特性中数据准备模型训练和解释快照进行协作，如表1所示。快照为所有应用更改的数据和文档提供了完整的序列。通过语法PREPARE SNAPSHOT调用。 表1 DB4AI.PREPARE_SNAPSHOT入参和返回值列表 参数 类型 描述 i_schema IN NAME 快照存储的模式名字，默认值是当前用户或者PUBLIC。 i_parent IN NAME 父快照名称。 i_commands IN TEXT[] 定义快照修改的DDL和DML命令。 i_vers IN NAME 版本后缀。 i_comment IN TEXT 此数据策展单元的说明。 res OUT db4ai.snapshot_name 结果。 父主题： DB4AI Schema

DB4AI.CREATE_SNAPSHOT_INTERNAL CREATE_SNAPSHOT_INTERNAL是db4ai.create_snapshot函数的内置执行函数，如表1所示。函数存在信息校验，无法直接调用。 表1 DB4AI.CREATE_SNAPSHOT_INTERNAL入参和返回值列表 参数 类型 描述 s_id IN BIGINT 快照id。 i_schema IN NAME 快照存储的名字空间。 i_name IN NAME 快照名称。 i_commands IN TEXT[] 定义数据获取的SQL命令。 i_comment IN TEXT 快照描述。 i_owner IN NAME 快照拥有者。 父主题： DB4AI Schema

DB4AI.CREATE_SNAPSHOT CREATE_SNAPSHOT是DB4AI特性用于创建快照的接口函数，如表1所示。通过语法CREATE SNAPSHOT调用。 表1 DB4AI.CREATE_SNAPSHOT入参和返回值列表 参数 类型 描述 i_schema IN NAME 快照存储的模式名字，默认值是当前用户或者PUBLIC。 i_name IN NAME 快照名称。 i_commands IN TEXT[] 定义数据获取的SQL命令。 i_vers IN NAME 版本后缀。 i_comment IN TEXT 快照描述。 res OUT db4ai.snapshot_name 结果。 父主题： DB4AI Schema

DBE_PLDEBUGGER.set_var 将指定的调试的存储过程中最上层栈上的变量修改为入参的取值，如表1所示。如果存储过程中包含同名的变量，set_var只支持第一个变量值的设置。 表1 set_var入参和返回值列表 名称 类型 描述 var_name IN text 变量名。 value IN text 修改值。 result OUT boolean 是否成功。 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.disable_breakpoint debug端调试过程中，调用disable_breakpoint禁用已被激活的断点，如表1所示。 表1 disable_breakpoint入参和返回值列表 名称 类型 描述 breakpointno IN integer 断点编号。 result OUT bool 是否成功。 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.backtrace debug端调试过程中，调用backtrace，查看当前的调用堆栈，如表1所示。 表1 backtrace返回值列表 名称 类型 描述 frameno OUT integer 调用栈编号。 funcname OUT text 函数名。 lineno OUT integer 行号。 query OUT text 断点内容。 funcoid OUT oid 函数oid。 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.info_breakpoints debug端调试过程中，调用info_breakpoints，查看当前的函数断点，如表1所示。 表1 info_breakpoints返回值列表 名称 类型 描述 breakpointno OUT integer 断点编号。 funcoid OUT oid 函数ID。 lineno OUT integer 行号。 query OUT text 断点内容。 enable OUT boolean 是否有效。 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.add_breakpoint debug端调试过程中，调用add_breakpoint增加新的断点，如表1所示。如果返回-1则说明指定的断点不合法，请参见DBE_PLDEBUGGER.info_code的canbreak字段确定合适的断点位置。进入内层函数前，外层函数无断点，则不支持在内层函数执行时，给外层函数添加断点。 表1 add_breakpoint入参和返回值列表 名称 类型 描述 funcoid IN text 函数ID。 lineno IN integer 行号。 breakpointno OUT integer 断点编号。 父主题： DBE_PLDEBUGGER Schema

DBE_PLDEBUGGER.next 执行存储过程中当前的sql，返回执行的下一条的行数和对应query，如表1所示。 表1 next返回值列表 名称 类型 描述 funcoid OUT oid 函数id。 funcname OUT text 函数名。 lineno OUT integer 当前调试运行的下一行行号。 query OUT text 当前调试的下一行函数源码。 父主题： DBE_PLDEBUGGER Schema