华为云用户手册

bbox_blanklist_items 参数说明：黑匣子core文件的脱敏数据选项。此参数仅在enable_bbox_dump参数取值为on时才生效。 参数类型：字符串 参数单位：无 取值范围：以逗号分隔的敏感数据选项组成的字符串。 默认值：""。表示bbox生成的core文件脱敏所有支持的敏感数据项。 目前支持脱敏的数据项： SHARED_BUFFER：buffer数据缓冲区。 X LOG _BUFFER：redo日志缓冲区。 DW_BUFFER：双写数据缓冲区。 XLOG_MESSAGE_SEND：主备日复制日志发送缓冲区。 WALRECEIVER_CTL_BLOCK：主备复制日志接收缓冲区。 DATA_MESSAGE_SEND：主备复制数据发送缓冲区。 DATA_WRITER_QUEUE：主备复制数据接收缓冲区。 BUCKET_XLOG_MESSAGE_SEND：bucket扩容回放日志发送缓冲区。 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

enable_ffic_log 参数说明：设置是否开启FFIC(First Failure Info Capture)功能。 参数类型：布尔型 参数单位：无 取值范围： on：表示打开FFIC功能。 off：表示关闭FFIC功能。 默认值：on 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

io_control_unit 参数说明：行存场景下，I/O管控时用来对I/O次数进行计数的单位。 记多少次I/O触发为一计数单位，通过此计数单位所记录的次数进行I/O管控。 参数类型：整型 参数单位：无 取值范围：1000 ~ 1000000 默认值：6000 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

io_priority 参数说明：I/O利用率高达50%时，重消耗I/O作业进行I/O资源管控时关联的优先级等级。 参数类型：枚举类型 参数单位：无 取值范围： None：表示不受控。 Low：表示限制iops为该作业原始触发数值的10%。 Medium：表示限制iops为该作业原始触发数值的20%。 High：表示限制iops为该作业原始触发数值的50%。 默认值：None 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

instance_metric_retention_time 参数说明：设置实例历史资源监控数据的保存天数。该参数仅在enable_instance_metric_persistent参数取值为on时有效。 参数类型：整型 参数单位：d（天） 取值范围：0 ~ 3650 值等于0时，实例历史资源监控数据将永久保存。 值大于0时，实例历史资源监控数据将保存对应设置天数。 默认值：7 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。取值如果要带单位，必须为d。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

resource_track_duration 参数说明：设置资源监控实时视图中记录的语句执行结束后进行历史信息转存的最小执行时间。当执行完成的作业，其执行时间不小于此参数值时，作业信息会从实时视图（以statistics为后缀的视图）转存到相应的历史视图（以history为后缀的视图）中。该参数仅在enable_resource_track参数取值为on时才有效。该参数可在PDB级别设置。 参数类型：整型 参数单位：s（秒） 取值范围：0 ~ 2147483647 值为0时，资源监控实时视图中记录的所有语句都进行历史信息归档。 值大于0时，资源监控实时视图中记录的语句的执行时间超过这个值就会进行历史信息归档。 默认值：60。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。例如，不带单位取值3600，表示resource_track_duration为3600s；带单位取值1h，表示resource_track_duration为1h。取值如果要带单位，必须为s、min、h、d。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

disable_memory_protect 参数说明：设置是否禁止内存保护功能。当系统内存不足时如果需要查询系统视图，可以先将此参数置为on，禁止内存保护功能，保证视图可以正常查询。该参数只适用于在系统内存不足时进行系统诊断和调试，正常运行时请保持该参数配置为off。该参数可在PDB级别设置。 参数类型：布尔型 参数单位：无 取值范围： on：表示禁止内存保护功能。 off：表示启动内存保护功能。 默认值：off。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，且只对当前会话有效，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

enable_bbox_dump 参数说明：设置是否开启黑匣子功能，在系统不配置core机制的情况下，是否产生core文件。 参数类型：布尔型 参数单位：无 取值范围： on：表示打开黑匣子功能。 off：表示关闭黑匣子功能。 默认值：on 设置方式：该参数属于SIGHUP类型参数，请参见表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 黑匣子功能生成core文件依赖操作系统开放ptrace接口。若发生权限不足(errno = 1)，请确保/proc/sys/kernel/yama/ptrace_scope配置合理。

resource_track_cost 参数说明：设置对当前会话的语句进行资源监控的最小执行代价。该参数仅在enable_resource_track参数取值为on时才有效。该参数可在PDB级别设置。 参数类型：整型 参数单位：无 取值范围：-1 ~ 2147483647 值为-1时，不进行资源监控。 值大于等于0且小于等于9时，对执行代价大于等于10的语句进行资源监控。 值大于等于10时，对执行代价超过该参数值的语句进行资源监控。 默认值：100000。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

resource_track_level 参数说明：设置当前会话的资源监控的等级。该参数仅在enable_resource_track参数取值为on时才有效。该参数可在PDB级别设置。 参数类型：枚举类型 参数单位：无 取值范围： none：不开启资源监控功能。 query：开启query级别资源监控功能。 operator：开启query级别和算子级别资源监控功能。 默认值：query。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

query_band 参数说明：用于标识当前会话的作业类型，由用户自定义。该参数可在PDB级别设置。 参数类型：字符串 参数单位：无 取值范围：字符串 默认值：""。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

memory_tracking_mode 参数说明：设置记录内存信息的模式。该参数可在PDB级别设置。 参数类型：枚举类型 参数单位：无 取值范围： none：不启动内存统计功能。 peak：统计query级内存peak值，此数值记入数据库，也可由explain analyze输出。 normal：仅做内存实时统计，不生成文件。 executor：生成统计文件，包含执行层使用过的所有已分配内存的上下文信息。 fullexec：生成统计文件，包含执行层申请过的所有内存上下文信息。 默认值：none。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

enable_resource_record 参数说明：设置是否开启资源监控记录归档功能。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启资源监控记录归档功能。 off：表示关闭资源监控记录归档功能。 默认值：off 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

user_metric_retention_time 参数说明：设置用户历史资源监控数据的保存天数。该参数仅在enable_user_metric_persistent参数取值为on时有效。 参数类型：整型 参数单位：d（天） 取值范围：0 ~ 3650 值等于0时，用户历史资源监控数据将永久保存。 值大于0时，用户历史资源监控数据将保存对应天数。 默认值：7 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。取值如果要带单位，必须为d。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

memory_detail_tracking 参数说明：设置需要的线程内分配内存上下文的顺序号以及当前线程所在query的plannodeid，仅用在DEBUG版本。该参数可在PDB级别设置。 参数类型：字符串 参数单位：无 取值范围：字符串 默认值：""。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：该参数不允许用户进行设置，建议保持默认值。 设置不当的风险与影响：无

enable_logical_io_statistics 参数说明：设置是否开启资源监控逻辑I/O统计功能。开启时，对于PG_TOTAL_USER_RESOURCE_INFO视图中的read_kbytes、write_kbytes、read_counts、write_counts、read_speed和write_speed字段，会统计对应用户的逻辑读写字节数、次数以及速率。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启资源监控逻辑I/O统计功能。 off：表示关闭资源监控逻辑I/O统计功能。 默认值：on 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

cpu_collect_timer 参数说明：设置语句执行时在数据库节点上收集CPU时间的周期。 参数类型：整型 参数单位：s（秒） 取值范围：1 ~ 2147483647 默认值：30 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。取值不能带单位。 设置建议：数据库管理员需根据系统资源（如CPU资源、I/O资源和内存资源）情况，调整此数值大小，使得系统支持较合适的收集周期，太小会影响执行效率，太大会影响异常处理的精确度。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

enable_vacuum_control 参数说明：控制数据库常驻线程中的autoVacuumWorker是否绑定到Vacuum控制组。多租数据库特性（enable_mtd）需要开启该参数。 参数类型：布尔型 参数单位：无 取值范围： on：表示数据库常驻线程中的autoVacuumWorker绑定到Vacuum控制组。 off：表示数据库常驻线程中的autoVacuumWorker不绑定到Vacuum控制组。 默认值：off 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：该参数默认关闭，开启后会开启后台vacuum线程CPU管控功能，在vacuum线程消耗CPU高的场景下可以开启该参数来限制vacuum线程的CPU使用。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 当且仅当enable_control_group参数取值为on时，该参数设置有效。

enable_backend_control 参数说明：控制数据库常驻线程是否绑定到DefaultBackend控制组。多租数据库特性（enable_mtd）需要开启该参数。 参数类型：布尔型 参数单位：无 取值范围： on：表示常驻线程绑定到DefaultBackend控制组。 off：表示常驻线程不绑定到DefaultBackend控制组。 默认值：off 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：该参数默认关闭，开启后会开启后台线程CPU管控功能，在后台线程消耗CPU高的场景下可以开启该参数来限制后台线程的CPU使用。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 当且仅当enable_control_group参数取值为on时，该参数设置有效。

use_workload_manager 参数说明：设置是否开启资源管理功能。多租数据库特性（enable_mtd）需要开启该参数。 参数类型：布尔型 参数单位：无 取值范围： on：表示打开资源管理。 off：表示关闭资源管理。 默认值：on 设置方式：该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 当使用表1中的方式二来修改参数值时，新参数值只能对更改操作执行后启动的线程生效。此外，对于后台线程以及线程复用执行的新作业，该参数值的改动不会生效。如果希望这类线程即时识别参数变化，可以使用kill session或重启节点的方式来实现。 use_workload_manager参数由off变为on状态后，不会统计off时的存储资源。如果需要统计off时用户使用的存储资源，请在数据库中执行以下SQL语句： 1 SELECT gs_wlm_readjust_user_space(0);

enable_control_group 参数说明：设置是否开启Cgroups功能。多租数据库特性（enable_mtd）需要开启该参数。 参数类型：布尔型 参数单位：无 取值范围： on：表示打开Cgroups功能。 off：表示关闭Cgroups功能。 默认值：on 设置方式：该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置，当使用表中的方式二来修改参数值时，需要重启节点才能使Cgroups功能生效。 设置建议：推荐使用默认值，使用多租数据库时开启该参数。 设置不当的风险与影响：同时开启该参数和资源管控功能（use_workload_manager）后会使用户资源管控功能生效，降低用户执行的作业的性能。

cgroup_name 参数说明：设置当前使用的Cgroups的名称以及调整当前group下排队的优先级。 如果先设置cgroup_name，再设置session_respool，那么session_respool关联的控制组起作用，如果再修改cgroup_name，那么新修改的cgroup_name起作用。 修改cgroup_name的过程中如果指定Workload控制组级别，数据库不对级别进行验证。级别的范围只要在1-10范围内都可以。 参数类型：字符串 参数单位：无 取值范围：已有控制组的名称。 默认值："InvalidGroup" 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：尽量不要混合使用cgroup_name和session_respool。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

enable_cgroup_switch 参数说明：控制数据库执行语句时是否根据类型自动切换到TopWD组。该参数可在PDB级别设置。 参数类型：布尔型 参数单位：无 取值范围： on：表示数据库执行语句时根据类型自动切换到TopWD组。 off：表示数据库执行语句时根据类型不自动切换到TopWD组。 默认值：off。在PDB场景内，若未设置该参数，则继承来自全局的设置。 设置方式：该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。 当且仅当enable_control_group参数取值为on时，该参数设置有效。

创建、修改和删除用户 创建用户，请使用SQL语句CREATE USER。 例如：创建用户joe，并设置用户拥有CREATEDB属性。 1 2 gaussdb=# CREATE USER joe WITH CREATEDB PASSWORD "********"; CREATE ROLE 创建系统管理员，请使用带有SYSADMIN选项的CREATE USER语句。 删除现有用户，请参见DROP USER。 更改用户账户（例如，重命名用户或更改密码），请参见ALTER USER。 查看用户列表，请查询视图GS_USER。 1 gaussdb=# SELECT * FROM gs_user; 查看用户属性，请查询系统表PG_AUTHID。 1 gaussdb=# SELECT * FROM pg_authid;

永久用户 GaussDB 提供永久用户方案：创建具有PERSISTENCE属性的永久用户，具有PERSISTENCE属性的用户能够使用service_reserved_connections通道连接数据库。 1 gaussdb=# CREATE USER user_persistence WITH PERSISTENCE IDENTIFIED BY "********"; 只允许初始用户创建、修改和删除具有PERSISTENCE属性的永久用户。

PG_STAT_SYS_TABLES PG_STAT_SYS_TABLES视图显示pg_catalog、information_schema模式的所有命名空间中系统表的统计信息。 表1 PG_STAT_SYS_TABLES字段 名称 类型 描述 relid oid 表的OID。 schemaname name 该表的模式名。 relname name 表名。 seq_scan bigint 该表发起的顺序扫描数。 seq_tup_read bigint 顺序扫描抓取的活跃行数。 idx_scan bigint 该表发起的索引扫描数。 idx_tup_fetch bigint 索引扫描抓取的活跃行数。 n_tup_ins bigint 插入行数。 n_tup_upd bigint 更新行数。 n_tup_del bigint 删除行数。 n_tup_hot_upd bigint HOT更新行数（比如没有更新所需的单独索引）。 n_live_tup bigint 估计活跃行数。 n_dead_tup bigint 估计不活跃行数。在Ustore表中仅代表不活跃行指针数量。 last_vacuum timestamp with time zone 上次手动清理该表的时间（不计算VACUUM FULL）。 last_autovacuum timestamp with time zone 上次被autovacuum守护线程清理的时间。 last_analyze timestamp with time zone 上次手动分析这个表的时间。 last_autoanalyze timestamp with time zone 上次被autovacuum守护线程分析的时间。 vacuum_count bigint 这个表被手动清理的次数（不计算VACUUM FULL）。 autovacuum_count bigint 这个表被autovacuum守护线程清理的次数。 analyze_count bigint 这个表被手动分析的次数。 autoanalyze_count bigint 这个表被autovacuum守护线程分析的次数。 last_data_changed timestamp with time zone 这个表数据最近修改时间。 父主题： 其他系统视图

shared_preload_libraries 参数说明：此参数用于声明一个或者多个在数据库启动的时候需要预先装载的共享库，多个库名字之间用逗号分隔。比如 '$libdir/mylib' 会在加载标准库目录中的库文件之前预先加载mylib.so（某些平台上可能是mylib.sl），当前该参数只能由sysadmin用户可以访问设置。 如果被声明的库不存在，GaussDB服务将会启动失败。 每一个支持GaussDB的库都有一个特殊的标记用于保证兼容性。因此，不支持GaussDB的库不能用这种方法加载。 参数类型：字符串 参数单位：无 取值范围：字符串 默认值：''platform_compatibility_b,security_plugin'' 设置方式：该参数属于POSTMASTER类型参数，请参见表1中对应设置方法进行设置。 设置建议：可以用这个方法预先装载GaussDB的存储过程库，通常是使用'$libdir/plXXX'语法。XXX只能是pgsql、perl、tcl、python之一。 通过预先装载一个共享库并在需要的时候进行初始化，可以避免第一次使用这个库的加载时间。但是启动每个服务器进程的时间可能会增加，即使进程从来没有使用过这些库。因此建议对那些将被大多数会话使用的库才使用这个选项。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改。

SUMMARY_STAT_XACT_ALL_TABLES 显示数据库各节点所有Schema中所有普通表和toast表的事务状态信息的汇总求和结果，如表1所示。 表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

PG_LOCKS PG_LOCKS视图显示各打开事务所持有的锁的信息。在多租场景下，在PDB仅返回本PDB信息，在Non-PDB返回全局信息。 表1 PG_LOCKS字段 名称 类型 引用 描述 locktype text - 被锁定对象的类型：relation、extend，page、tuple、transactionid、virtualxid、object、userlock、advisory或tablespace。 database oid PG_DATABASE.oid 被锁定对象所在数据库的OID。 如果被锁定的对象是共享对象，则OID为0。 如果被锁定的对象是一个事务，则OID为NULL。 relation oid PG_CLASS.oid 关系的OID，如果锁定的对象不是关系，也不是关系的一部分，则为NULL。 page integer - 关系内部的页面编号，如果对象不是关系页或者不是行页，则为NULL。 tuple smallint - 页面里边的行编号，如果对象不是行，则为NULL。 bucket integer - 子表对应的bucket number。如果目标不是表的话，则为NULL。 virtualxid text - 虚拟事务的ID，如果对象不是一个虚拟事务，则为NULL。 transactionid xid - 事务的ID，如果对象不是一个事务，则为NULL。 classid oid PG_CLASS.oid 包含该对象的系统表的OID，如果对象不是普通的数据库对象，则为NULL。 objid oid - 对象在其系统表内的OID，如果对象不是普通的数据库对象，则为NULL。 objsubid smallint - 对于表的一个字段，这是字段编号；对于其他对象类型，这个字段是0；如果这个对象不是普通数据库对象，则为NULL。 virtualtransaction text - 持有此锁或者在等待此锁的虚拟事务的ID。 pid bigint - 持有或者等待这个锁的服务器逻辑线程的ID。如果锁是被一个预备事务持有的，则为NULL。 sessionid bigint - 持有或者等待这个锁的会话的ID。 mode text - 这个线程持有的或者是期望的锁模式。 可能取值为：AccessShareLock、RowShareLock、RowExclusiveLock、ShareLock、ShareRowExclusiveLock、ExclusiveLock、AccessExclusiveLock。 granted boolean - 如果锁是持有锁，则为TRUE。 如果锁是等待锁，则为FALSE。 fastpath boolean - 如果通过fast-path获得锁，则为TRUE；如果通过主要的锁表获得，则为FALSE。 locktag text - 会话等待锁信息，可通过locktag_decode()函数解析。 global_sessionid text - 全局会话ID。 父主题： 其他系统视图

示例 --创建表def_test、视图def_view_test用于创建RULE gaussdb=# CREATE TABLE def_test ( c1 int4 DEFAULT 5, c2 text DEFAULT 'initial_default' ); gaussdb=# CREATE VIEW def_view_test AS SELECT * FROM def_test; --创建RULE def_view_test_ins gaussdb=# CREATE RULE def_view_test_ins AS gaussdb=# ON INSERT TO def_view_test gaussdb=#DO INSTEAD INSERT INTO def_test SELECT new.*; --删除RULE def_view_test_ins gaussdb=# DROP RULE def_view_test_ins ON def_view_test; --删除表def_test、视图def_view_test gaussdb=# DROP VIEW def_view_test; gaussdb=# DROP TABLE def_test;