华为云用户手册

log_connections 参数说明：控制是否记录客户端连接请求的日志信息。日志信息包括连接的IP、PORT、用户名、数据库名、 GaussDB数据库 响应建立连接流程中关键步骤的耗时等。 有些客户端程序（例如gsql），在判断是否需要口令的时候会尝试连接两次，因此日志消息中可能存在重复的“connection receive”（收到连接请求）。 参数类型：布尔型 参数单位：无 取值范围： on：表示记录日志信息。 off：表示不记录日志信息。 默认值：off 设置方式：该参数属于BACKEND类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

log_error_verbosity 参数说明：控制服务器日志中每条记录的消息写入的详细度。该参数可在PDB级别设置。 参数类型：枚举类型 参数单位：无 取值范围： terse：表示不包括DETAIL、HINT、QUERY及CONTEXT错误信息的记录。 verbose：表示包括SQLSTATE错误代码 、源代码文件名、函数名及产生错误所在的行号。 default：表示包括DETAIL、HINT、QUERY及CONTEXT错误信息的记录，不包括SQLSTATE错误代码 、源代码文件名、函数名及产生错误所在的行号。 默认值：default。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：根据对日志消息的详细度要求进行设置。推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

log_hostname 参数说明：此参数关闭状态下，连接消息日志只显示正在连接主机的IP地址。打开此参数，表示会同时记录主机名。由于解析主机名需要一定的时间，可能影响数据库的性能。 参数类型：布尔型 参数单位：无 取值范围： on：表示记录主机名。 off：表示不记录主机名。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：开启时可能影响数据库的性能。

log_checkpoints 参数说明：控制在服务器日志中记录检查点和重启点的信息。打开此参数时，服务器日志消息包含涉及检查点和重启点的统计量，其中包含需要写的缓存区的数量及写入所花费的时间等。 参数类型：布尔型 参数单位：无 取值范围： on：表示打开此参数，服务器日志消息包含涉及检查点和重启点的统计量。 off：表示关闭此参数，服务器日志消息不包含涉及检查点和重启点的统计量。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

log_duration 参数说明：控制记录每个已完成SQL语句的执行时间。对使用扩展查询协议的客户端，会记录语法分析、绑定和执行每一步所花费的时间。该参数可在PDB级别设置。 参数类型：布尔型 参数单位：无 取值范围： on：表示记录所有已完成SQL语句的执行时间。 off：表示不记录SQL语句的执行时间。 该参数设置为on或log_min_duration_statement设置为0都会记录每个已完成SQL语句的执行时间，不同之处在于log_min_duration_statement会强制记录SQL语句。 默认值：off。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

debug_print_plan 参数说明：用于设置是否将查询的执行计划打印到日志中。 参数类型：布尔型 参数单位：无 取值范围： on：表示将查询的执行计划打印到日志中。 off：表示不将查询的执行计划打印到日志中。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 只有当日志的级别为log及以上时，debug_print_parse、debug_print_rewritten和debug_print_plan的调试信息才会输出。当这些选项打开时，调试信息只会记录在服务器的日志中，而不会输出到客户端的日志中。通过设置client_min_messages和log_min_messages参数可以改变日志级别。 在打开debug_print_plan开关的情况下需尽量避免调用gs_encrypt_aes128及gs_decrypt_aes128函数，避免敏感参数信息在日志中泄露的风险。同时建议用户在打开debug_print_plan开关生成的日志中对gs_encrypt_aes128及gs_decrypt_aes128函数的参数信息进行过滤后再提供给外部维护人员定位，日志使用完成后请及时删除。

debug_print_rewritten 参数说明：用于控制打印查询重写结果。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启打印查询重写结果的功能。 off：表示关闭打印查询重写结果的功能。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

参数说明 name 已有外部数据封装的名称。 HANDLER handler_function 为外部数据封装指定一个新的处理函数。 NO HANDLER 这个参数用来指定外部数据封装不再拥有处理函数。 使用外部数据封装但没有handler的外表不能访问。 VALIDATOR validator_function 为外部数据封装指定一个新的验证函数。 根据新的验证器，外部数据封装器或依赖的服务器、 用户映射或外部表的已经存在的选项是有可能是无效的。用户在使用外部数据封装之前需要保证这些选项是正确的。 不过，ALTER FOREIGN DATA WRAPPER 命令中指定的任何选项都将使用新的验证函数检查。 NO VALIDATOR 这个用来指定外部数据封装不再有验证函数。 OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ] ) 修改外部数据封装的选项。 ADD, SET, 和 DROP 指定表现的动作。如果没有明确指定操作默认是ADD。选项名必须唯一。 使用外部数据封装验证函数时，名字和取值也会被验证。

示例 --创建一个外部数据封装dbi。 gaussdb=# CREATE FOREIGN DATA WRAPPER dbi OPTIONS (bar 'true'); --修改一个外部数据封装dbi，增加选项foo，删除bar。 gaussdb=# ALTER FOREIGN DATA WRAPPER dbi OPTIONS (ADD foo '1', DROP 'bar'); --修改外部数据封装dbi验证器为file_fdw_validator。 gaussdb=# ALTER FOREIGN DATA WRAPPER dbi VALIDATOR file_fdw_validator; --修改外部数据封装dbi处理函数为file_fdw_handler。 gaussdb=# ALTER FOREIGN DATA WRAPPER dbi HANDLER file_fdw_handler;

语法格式 设置外部数据封装属性 ALTER FOREIGN DATA WRAPPER name [ HANDLER handler_function | NO HANDLER ] [ VALIDATOR validator_function | NO VALIDATOR ] [ OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ]) ];

注意事项 在使用CREATE EXTENSION载入扩展到数据库中之前，必须先安装好该扩展的支持文件。 CREATE EXTENSION命令安装一个新的扩展到一个数据库中，必须保证没有同名的扩展已经被安装。 安装一个扩展意味着执行一个扩展的脚本文件，这个脚本会创建一个新的SQL实体，例如函数、数据类型、操作符和索引支持的方法。 安装扩展需要有和创建他的组件对象相同的权限。对于大多数扩展这意味着需要超户或者数据库所有者的权限，对于后续的权限检查和该扩展脚本所创建的实体，运行CREATE EXTENSION命令的角色将变为扩展的所有者。 CREATE EXTENSION时如果数据库中存在与EXTENSION内同名的PACKAGE、同义词、操作符、目录、函数、存储过程、视图、表这些数据库对象，将会导致CREATE EXTENSION失败。 数据库禁止直接创建扩展，因为扩展可能会引起非预期的错误，且在升级后面临不兼容的问题。如果需要创建扩展，需要设置enable_extension为true才能够创建。 CREATE EXTENSION时，如果GUC参数enable_object_special_character为off，且扩展的脚本文件中使用"@extschema@"，那么扩展的支持文件中schema参数的值不能包含["$'\]中任意特殊字符。

参数说明 IF NOT EXISTS 如果系统已经存在一个同名的扩展，不会报错。这种情况下会给出一个提示。请注意该参数不保证系统存在的扩展和现在脚本创建的扩展相同。 extension_name 将被安装扩展的名字，数据库将使用文件SHAREDIR/extension/extension_name.control中的详细信息创建扩展。 schema_name 扩展的实例被安装在该模式下，扩展的内容可以被重新安装。指定的模式必须已经存在，如果没有指定，扩展的控制文件也不指定一个模式，这样将使用默认模式。 扩展不属于任何模式，扩展在一个数据库范围内的名字是不受限制的，但是一个扩展的实例是属于一个模式的。 version 安装扩展的版本，可以作为一个标识符或者字符串，默认的版本在扩展的控制文件中指定。 old_version 当需要升级安装"old style" 模块中没有的内容时,需要指定FROM old_version。通过CREATE EXTENSION运行一个安装脚本将新的内容安装到扩展中，而不是创建一个新的实体。注意：SCHEMA指定了包括这些已存在实体的模式。

STAT_USER_INDEXES 显示当前节点用户自定义普通表的索引状态信息，如表1所示。 表1 STAT_USER_INDEXES字段 名称 类型 描述 relid oid 此索引的表的OID。 indexrelid oid 索引的OID。 schemaname name 索引所在的Schema名。 relname name 索引的表名。 indexrelname name 索引名。 idx_scan bigint 该索引上执行的索引扫描次数。 idx_tup_read bigint 该索引上扫描返回的索引项数。 idx_tup_fetch bigint 使用该索引的简单索引扫描在原表中抓取的活跃行数。 last_updated timestamp with time zone 视图中该对象监控数据最后一次更新的时间。 父主题： Object

示例 --创建数据表t1。 gaussdb=# CREATE TABLE t1 (id int, name varchar); --插入数据。 gaussdb=# INSERT INTO t1 VALUES (1, 'zhangsan'); gaussdb=# INSERT INTO t1 VALUES (2, 'lisi'); gaussdb=# INSERT INTO t1 VALUES (3, 'wangwu'); gaussdb=# INSERT INTO t1 VALUES (4, 'lisa'); gaussdb=# INSERT INTO t1 VALUES (5, 'jack'); --创建快照。 gaussdb=# CREATE SNAPSHOT s1@1.0 comment is 'first version' AS SELECT * FROM t1; --迭代创建快照。 gaussdb=# CREATE SNAPSHOT s1@2.0 FROM @1.0 comment is 'inherits from @1.0' USING (INSERT VALUES(6, 'john'), (7, 'tim'); DELETE WHERE id = 1); --查看快照内容。 gaussdb=# SELECT * FROM DB4AISHOT(s1@1.0); id | name ----+---------- 1 | zhangsan 2 | lisi 3 | wangwu 4 | lisa 5 | jack (5 rows) gaussdb=# SELECT * FROM DB4AISHOT(s1@2.0); id | name ----+-------- 2 | lisi 3 | wangwu 4 | lisa 5 | jack 6 | john 7 | tim (6 rows) --快照采样。 gaussdb=# SAMPLE SNAPSHOT s1@2.0 stratify by name as nick at ratio .5; --删除快照。 gaussdb=# PURGE SNAPSHOT s1@2.0; gaussdb=# PURGE SNAPSHOT s1nick@2.0; gaussdb=# PURGE SNAPSHOT s1@1.0; --删除表格t1。 gaussdb=# DROP TABLE t1;

参数说明 qualified_name 创建snapshot的名称。 取值范围：字符串，需要符合标识符命名规范。 version (可省略)snapshot的版本号，当省略设置。系统会自动顺延编号。 取值范围：字符串，数字编号配合分隔符。 ident 用于标定快照后缀编号(或者大版本) 取值范围：整数(int)，数字编号。 sconst 用浮点数标记版本号，特性会在后台中将用GUC参数db4ai_snapshot_version_separator指定的分隔符代替小数点 取值范围：浮点型(float)。 comment 指定添加的评论内容。 取值范围：字符串，需要符合标识符命名规范。 alias 对当前对象取的别名。 取值范围：字符串，需要符合标识符命名规范。 attr_list 目标对象的list集合。 取值范围：字符串，需要符合标识符命名规范。 label 采样数据列别名。 取值范围：字符串，需要符合标识符命名规范。 num 指定的比例值。 取值范围：数字。

注意事项 本特性GUC参数db4ai_snapshot_mode，快照存储模型分为MSS和 CSS 两种；GUC参数db4ai_snapshot_version_delimiter，用于设定版本分隔符，仅接受设定单字节参数值，默认为“@”;GUC参数db4ai_snapshot_version_separator，用于设定子版本分隔符，仅接受设定单字节参数值，默认为“.”。 当快照选用增量存储方式时，各个快照中具有依赖关系。删除快照需要按照依赖顺序进行删除。 snapshot特性用于团队不同成员间维护数据，涉及管理员和普通用户之间的数据转写。所以在三权分立(enableSeparationOfDuty=ON)等状态下，数据库不支持snapshot功能特性。 当需要稳定可用的快照用于AI训练等任务时，用户需要将快照发布。

standby_bufferpool_scale 参数说明：设置用于开启极致RTO备机读独立缓冲区功能后，独立缓冲区使用shared_buffers内存缓冲区大小的比例。 参数类型：浮点型 参数单位：无 取值范围：0.1-0.9 默认值：0.5 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：若该值设置不合理，会导致刷页速度加快。

enable_standby_bufferpool 参数说明：启用极致RTO备机读独立缓冲区功能的开关。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启。 off：表示关闭。 默认值：on 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 启用该功能开关时，开关生效需满足enable_incremental_checkpoint增量检查点打开，且参数standby_shared_buffers_fraction减去参数standby_bufferpool_scale的差值不小于0.1。

enable_standby_walsync_optimization 参数说明：启用主备WAL日志同步性能优化的开关。开启后，备机WAL日志落盘方式由fsync方式改为ADIO（asynchronous-direct input-output）方式，WAL日志不经过OS的cache缓存，直接从高速内存写到磁盘，并且写磁盘从原来同步改为异步方式，加快落盘速度，提升主备WAL日志同步的性能。另外，主机工作线程等待备机WAL日志落盘后的唤醒方式也有变化， 从原来的双链表队列检查方式改为轮询检查方式，减少唤醒等待时间，提升性能。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启。 off：表示关闭。 默认值：off 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 当前版本支持的同步模式是quorum，不支持DCF。通过出口参数控制，在鲲鹏4路服务器上打开，在2路服务器上关闭。 当使用DCF同步模式时，该参数控制的优化不生效。 不支持同时开启enable_standby_walsync_optimization与enable_wal_shipping_compression，当同时开启时，enable_wal_shipping_compression失效，即日志压缩功能失效。

standby_max_query_time 参数说明：开启极致RTO功能后，支持备机上查询的最大时间，超过该时间会被取消。 何时取消查询受回收线程的时间间隔参数standby_recycle_interval和查询取快照的时间影响，因此备机上查询的实际执行时间要大于该参数。 参数类型：整型 参数单位：s（秒） 取值范围：0 ~ 86400‬ 默认值：600 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：建议根据实际业务需要进行调整。 设置不当的风险与影响：若设置过高，将导致磁盘空间占用过高。

walrcv_writer_crc_check_level 参数说明：支持流式容灾场景下，主备数据库内备机侧的xlog校验，默认仅在灾备数据库内开启。 参数类型：整型 参数单位：无 取值范围：0 ~ 3 0：关闭校验。 1：灾备数据库内校验生效。 2：主数据库内备机侧的校验生效。 3：主数据库内的备机和灾备数据库内节点全部生效。 默认值：1 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：容灾搭建流程会自动设置，无需用户手动设置。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

hot_standby_feedback 参数说明：将备机上执行查询的最小事务号反馈给主机，可以避免查询冲突。 参数类型：布尔型 参数单位：无 取值范围： on：表示允许将备机上执行查询的最小事务号反馈给主机。 off：表示不允许将备机上执行查询的最小事务号反馈给主机。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：当该参数为on时，主机的旧版本数据的清理会受限于备机正在读的事务，即主机只允许清理小于备机反馈的事务号所作的更改。因此若该参数开启时，会影响主机的性能。若备机回放与查询冲突，会出现查询报错，因此建议适当调大max_standby_streaming_delay。

max_keep_csn_info_size 参数说明：开启极致RTO功能后，备机上每个DN允许的csn info链表的最大存储空间。 参数类型：整型 参数单位：kB 取值范围：16384 ~ 131072 默认值：16384‬（即16MB） 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

standby_force_recycle_ratio 参数说明：开启极致RTO功能后，备机读相关文件触发强制回收的比例。当base page文件总大小超过max_standby_base_page_size* standby_force_recycle_ratio，或者lsn info文件总大小超过max_standby_lsn_info_size* standby_force_recycle_ratio时，触发强制回收，会有查询被取消。当standby_force_recycle_ratio = 0时，不会启动强制回收，max_standby_base_page_size和max_standby_lsn_info_size也不会生效。 参数类型：浮点型 参数单位：无 取值范围：0.0 ~ 1.0 默认值：0.8 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

standby_recycle_interval 参数说明：开启极致RTO功能后，备机读相关文件回收的时间间隔。备机读的资源回收线程，每间隔该参数值的时间，尝试清理一次备机读相关文件。 参数类型：整型 参数单位：s（秒） 取值范围：0 ~ 86400‬ 默认值：10 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：设置间隔过长，会导致历史页面回收不及时，可能会导致过多的磁盘占用。

max_standby_base_page_size 参数说明：开启极致RTO功能后，备机上允许base page类型文件的最大存储空间。 参数类型：整型 参数单位：kB 取值范围：1048576 ~ 562949953421311 默认值：268435456‬（即256GB） 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：根据实际物理磁盘大小，对此参数进行设置。 设置不当的风险与影响：设置过小，会导致备机读报错概率增加。

max_standby_lsn_info_size 参数说明：开启极致RTO功能后，备机上允许lsn info类型文件的最大存储空间。 参数类型：整型 参数单位：kB 取值范围：1048576 ~ 562949953421311 默认值：268435456‬（即256GB） 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：根据实际物理磁盘大小，对此参数进行设置。 设置不当的风险与影响：设置过小，会导致备机读报错概率增加。

base_page_saved_interval 参数说明：开启极致RTO功能后，备机上生成base page的间隔次数。对同一个页面来说，每回放该参数值的次数，生成一次base page。 参数类型：整型 参数单位：无 取值范围：5 ~ 2000 默认值：400 设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：间隔过大，会使得每次备机读需要回放的xlog较多，性能变差；间隔过小，会占用更多的磁盘空间，更快到达强制回收点。

max_standby_archive_delay 参数说明：当开启双机热备模式时，备机读场景下进行查询就会产生冲突，此参数就是设置备机取消查询之前所等待的时间。当前版本设置暂不生效，统一由参数max_standby_streaming_delay控制。 参数类型：整型 参数单位：ms（毫秒） 取值范围：-1 ~ 2147483647。-1表示允许备机一直等待冲突的查询完成。 默认值：3000（即3s） 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

wal_receiver_status_interval 参数说明：WAL日志接收线程的状态通知给主机的最大时间间隔。 参数类型：整型 参数单位：s（秒） 取值范围：0 ~ 2147483 默认值：5s 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：当该参数设置为0时，表示关闭备机向主机反馈日志接收位置等信息，可能会导致主机事务提交阻塞、switchover操作失败等异常现象。正常业务场景，不建议将该参数设置为0。