华为云用户手册

背景信息 GaussDB 提供了多种修改GUC参数的方法，用户可以方便地针对数据库、用户、会话进行设置。 参数名称不区分大小写。 参数取值有整型、浮点型、字符串、布尔型和枚举型五类。 布尔值可以是（on，off）、（true，false）、（yes，no）或者（1，0），且不区分大小写。 枚举类型的取值是在系统表pg_settings的enumvals字段取值定义的。 对于有单位的参数，在设置时请指定单位，否则将使用默认的单位。 参数的默认单位在系统表pg_settings的unit字段定义的。 内存单位有：KB（千字节）、MB（兆字节）和GB（吉字节）。 时间单位：ms（毫秒）、s（秒）、min（分钟）、h（小时）和d（天）。 具体参数说明请参见GUC参数说明。

GUC参数设置 GaussDB提供了六类GUC参数，具体分类和设置方式请参考表1： 表1 GUC参数分类 参数类型 说明 设置方式 INTERNAL 固定参数，在创建数据库的时候确定，用户无法修改，只能通过show语法或者pg_settings视图进行查看。 无 POSTMASTER 数据库服务端参数，在数据库启动时确定，可以通过配置文件指定。 支持表2中的方式一。 SIGHUP 数据库全局参数，可在数据库启动时设置或者在数据库启动后，发送指令重新加载。 支持表2中的方式一、方式二。 BACKEND 会话连接参数。在创建会话连接时指定，连接建立后无法修改。连接断掉后参数失效。内部使用参数，不推荐用户设置。 支持表2中的方式一、方式二。 说明： 设置该参数后，下一次建立会话连接时生效。 SUSET 数据库管理员参数。可在数据库启动时、数据库启动后或者数据库管理员通过SQL进行设置。 支持表2中的方式一、方式二或由数据库管理员通过方式三设置。 USERSET 普通用户参数。可被任何用户在任何时刻设置。 支持表2中的方式一、方式二或方式三设置。 GaussDB提供了三种方式来修改GUC参数，具体操作请参考表2： 表2 GUC参数设置方式 序号 设置方法 方式一 登录管理控制台。 在“实例管理”页面，选择指定的实例，单击实例名称，进入实例基本信息页面。 在左侧导航栏单击“参数修改”，进入参数修改页面，在该页面修改参数。 如果需要修改的参数在管理该控制台无法修改，请提前评估风险后再联系客服进行修改。 重启数据库使参数生效。 说明： 重启数据库集群操作会导致用户执行操作中断，请在操作之前规划好合适的执行窗口。 方式二 登录管理控制台。 在“实例管理”页面，选择指定的实例，单击实例名称，进入实例基本信息页面。 在左侧导航栏单击“参数修改”，进入参数修改页面，在该页面修改参数。 如果需要修改的参数在管理该控制台无法修改，请提前评估风险后再联系客服进行修改。 方式三 登录管理控制台。 在“实例管理”页面，选择指定的实例，单击实例名称，进入实例基本信息页面。 在左侧导航栏单击“参数修改”，进入参数修改页面，在该页面修改参数。 如果需要修改的参数在管理该控制台无法修改，请提前评估风险后再联系客服进行修改。 使用方式一和方式二设置参数时，若所设参数不属于当前环境，数据库会提示参数不在支持范围内的相关信息。 使用方式三设置参数时，若参数值为int整型，则会将整数前导零过滤掉，例如SET paraname TO 008192与SET paraname TO 8192效果相同。

standard_conforming_strings 参数说明：控制普通字符串文本（'...'）中是否按照SQL标准把反斜扛当普通文本。 应用程序通过检查这个参数可以判断字符串文本的处理方式。 建议明确使用转义字符串语法（E'...'）来转义字符。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示打开控制功能。 off表示关闭控制功能。 默认值：on

quote_all_identifiers 参数说明：当数据库生成SQL时，此选项强制引用所有的标识符（包括非关键字）。这将影响到EXPLAIN的输出及函数的结果，例如pg_get_viewdef。详细说明请参见gs_dump的--quote-all-identifiers选项。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示打开强制引用。 off表示关闭强制引用。 默认值：off

synchronize_seqscans 参数说明：控制启动同步的顺序扫描。在大约相同的时间内并行扫描读取相同的数据块，共享I/O负载。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示扫描可能从表的中间开始，然后选择"环绕"方式来覆盖所有的行，为了与已经在进行中的扫描活动同步。这可能会造成没有用ORDER BY子句的查询得到行排序造成不可预测的后果。 off表示确保顺序扫描是从表头开始的。 默认值：on

default_with_oids 参数说明：在没有声明WITH OIDS和WITHOUT OIDS的情况下，这个选项控制在新创建的表中CREATE TABLE和CREATE TABLE AS是否包含一个OID字段。它还决定SELECT INTO创建的表里面是否包含OID 。 不推荐在用户表中使用OID，故默认设置为off。需要带有OID字段的表应该在创建时声明WITH OIDS 。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示在新创建的表中CREATE TABLE和CREATE TABLE AS可以包含一个OID字段。 off表示在新创建的表中CREATE TABLE和CREATE TABLE AS不可以包含一个OID字段。 默认值：off

backslash_quote 参数说明：控制字符串文本中的单引号是否能够用\'表示。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 在字符串文本符合SQL标准的情况下，\没有任何其他含义。这个参数影响的是如何处理不符合标准的字符串文本，包括明确的字符串转义语法是（E'...'）。 取值范围：枚举类型 on表示一直允许使用\'表示。 off表示拒绝使用\'表示。 safe_encoding表示仅在客户端字符集编码不会在多字节字符末尾包含\的ASCII值时允许。 默认值：safe_encoding

escape_string_warning 参数说明：警告在普通字符串中直接使用反斜杠转义。 如果需要使用反斜杠作为转义，可以调整为使用转义字符串语法(E'...')来做转义，因为在每个SQL标准中，普通字符串的默认行为现在将反斜杠作为一个普通字符。 这个变量可以帮助定位需要改变的代码。 使用E转义会导致部分场景下日志记录不全。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 默认值：on

audit_space_limit 参数说明：审计文件占用的磁盘空间总量。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，1024KB~1024GB，单位为KB。 默认值：1GB 多审计线程场景下，审计文件占用的磁盘空间最小值是audit_thread_num与audit_rotation_size的乘积，请保证audit_space_limit的值大于audit_thread_num与audit_rotation_size的乘积。

audit_file_remain_threshold 参数说明：审计目录下审计文件个数的最大值。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，100~1048576 默认值：1048576 请尽量保证此参数为1048576，并不要随意调整此参数，否则可能会导致audit_resource_policy无法生效，如果需要控制审计日志的存储空间和时间，请使用audit_resource_policy、audit_space_limit和audit_file_remain_time参数进行控制。 多审计线程场景下不建议调整此参数，请保证此参数不小于审计线程个数audit_thread_num，否则会导致审计功能无法正常使用与数据库异常。

audit_thread_num 参数说明：审计线程的个数。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，1~48 默认值：1 当audit_dml_state开关打开且在高性能场景下，建议增大此参数保证审计消息可以被及时处理和记录。 请保证此参数不大于审计目录下审计文件个数的最大值audit_file_remain_threshold，否则会导致审计功能无法正常使用与数据库异常。

audit_rotation_interval 参数说明：指定创建一个新审计日志文件的时间间隔。当现在的时间减去上次创建一个审计日志的时间超过了此参数值时，服务器将生成一个新的审计日志文件。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，1~INT_MAX/60，单位为min。 默认值：1d 请不要随意调整此参数，否则可能会导致audit_resource_policy无法生效，如果需要控制审计日志的存储空间和时间，请使用audit_resource_policy、audit_space_limit和audit_file_remain_time参数进行控制。

audit_rotation_size 参数说明：指定审计日志文件的最大容量。当审计日志消息的总量超过此参数值时，服务器将生成一个新的审计日志文件。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，1024~1048576，单位为KB。 默认值：10MB 请不要随意调整此参数，否则可能会导致audit_resource_policy无法生效，如果需要控制审计日志的存储空间和时间，请使用audit_resource_policy、audit_space_limit和audit_file_remain_time参数进行控制。 审计日志文件中记录的单条日志占用空间大小超过此参数值时会被作为无效日志文件。

audit_directory 参数说明：审计文件的存储目录。一个相对于数据目录data的路径，可自行指定，仅sysadmin用户可以访问。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串 默认值：pg_audit。如果使用om工具部署数据库，则审计日志路径为“$GAUSS LOG /pg_audit/实例名称”。 不同的DN实例需要设置不同的审计文件存储目录，否则会导致审计日志异常。 当配置文件中audit_directory的值为非法路径时，会导致审计功能无法使用。

enable_instr_track_wait 参数说明：是否开启等待事件信息实时收集功能。 在x86架构集中式部署下，硬件配置规格为32核CPU/256GB内存，使用Benchmark SQL 5.0工具测试性能，开关此参数性能影响约1.4%。 该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on：表示打开等待事件信息收集功能。 off：表示关闭等待事件信息收集功能。 默认值：on

hadr_process_type 参数说明：流式容灾双实例容灾场景流程标识。 该参数属于SIGHUP类型参数，改请参考表2进行设置。 取值范围：枚举类型。 none表示当前无流程。 failover表示当前处于灾备数据库实例升主流程。 switchover_promote表示主备数据库实例倒换流程中灾备数据库实例升主流程。 switchover_demote表示主备数据库实例倒换流程中主数据库实例降为灾备数据库实例流程。 默认值：none

backtrace_min_messages 参数说明：控制当产生该设置参数级别相等或更高级别的信息时，会打印函数的堆栈信息到服务器日志文件中。 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 该参数作为客户现场问题定位手段使用，且由于频繁的打印函数栈会对系统的开销及稳定性有一定的影响，因此如果需要进行问题定位时，建议避免将backtrace_min_messages的值设置为fatal及panic以外的级别。 取值范围：枚举类型 有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表1。 默认值：panic

log_min_duration_statement 参数说明：当某条语句的持续时间大于或者等于特定的毫秒数时，log_min_duration_statement参数用于控制记录每条完成语句的持续时间。 设置log_min_duration_statement可以很方便地跟踪需要优化的查询语句。对于使用扩展查询协议的客户端，语法分析、绑定、执行每一步所花时间被独立记录。 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 当此选项与log_statement同时使用时，已经被log_statement记录的语句文本不会被重复记录。在没有使用syslog情况下，推荐使用log_line_prefix记录PID或会话ID，方便将当前语句消息连接到最后的持续时间消息。 取值范围：整型，-1~ 2147483647，单位为毫秒。 设置为250，所有运行时间不短于250ms的SQL语句都会被记录。 设置为0，输出所有语句的持续时间。 设置为-1，关闭此功能。 默认值：3s（即3000ms）

log_min_messages 参数说明：控制写到服务器日志文件中的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低，服务器运行日志中记录的消息就越少。 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 当client_min_messages和log_min_messages取相同值log时所代表的消息级别不同。部分日志信息的打印需要同时配置该参数与logging_module，即设置该参数打开后可能还需要设置logging_module打开对应模块的日志打印开关。 取值范围：枚举类型，有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表1。 默认值：warning

log_min_error_statement 参数说明：控制在服务器日志中记录错误的SQL语句。 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：枚举类型，有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表1。 设置为error，表示导致错误、日志消息、致命错误、panic的语句都将被记录。 设置为panic，表示关闭此特性。 默认值：error

client_min_messages 参数说明：控制发送到客户端的消息级别。每个级别都包含排在它后面的所有级别中的信息。级别越低，发送给客户端的消息就越少。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 当client_min_messages和log_min_messages取相同值时，其值所代表的级别不同。 取值范围：枚举类型，有效值有debug、debug5、debug4、debug3、debug2、debug1、info、log、notice、warning、error、fatal、panic。参数的详细信息请参见表1。在实际设置过程中，如果设置的级别大于error，为fatal或panic，系统会默认将级别转为error。 默认值：notice

alarm_component 参数说明：在对告警做上报时，会进行告警抑制，即同一个实例的同一个告警项在alarm_report_interval（默认值为10s）内不做重复上报。在这种情况下设置用于处理告警内容的告警组件的位置，仅sysadmin用户可以访问。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串。 若前置脚本gs_preinstall中的--alarm-type参数设置为5时，表示未对接第三方组件，告警写入system_alarm日志，此时GUC参数alarm_component的取值为：/opt/huawei/snas/bin/snas_cm_cmd。 若前置脚本gs_preinstall中的--alarm-type参数设置为1时，表示对接第三方组件，此时GUC参数alarm_component的值为第三方组件的可执行程序的绝对路径。 默认值：/opt/huawei/snas/bin/snas_cm_cmd

dynamic_library_path 参数说明：设置数据查找动态加载的共享库文件的路径。当需要打开一个可以动态装载的模块并且在CREATE FUNCTION或LOAD命令里面声明的名称没有目录部分时，系统将搜索这个目录以查找声明的文件，仅sysadmin用户可以访问。 用于dynamic_library_path的数值必须是一个冒号分隔的绝对路径列表。当一个路径名称以特殊变量$libdir为开头时，会替换为GaussDB发布提供的模块安装路径。例如： 1 dynamic_library_path = '/usr/local/lib/gaussdb:/opt/testgs/lib:$libdir' 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串 设置为空字符串，表示关闭自动路径搜索。 默认值：$libdir

local_preload_libraries 参数说明：指定一个或多个共享库，它们在开始连接前预先加载。多个加载库之间用逗号分隔，除了双引号，所有的库名都转换为小写。 并非只有系统管理员才能更改此选项，因此只能加载安装的标准库目录下plugins子目录中的库文件，数据库管理员有责任确保该目录中的库都是安全的。local_preload_libraries中指定的项可以明确含有该目录，例如$libdir/plugins/mylib；也可以仅指定库的名称，例如mylib（等价于$libdir/plugins/mylib）。 与shared_preload_libraries不同，在会话开始之前加载模块与在会话中使用到该模块的时候临时加载相比并不具有性能优势。相反，这个特性的目的是为了调试或者测量在特定会话中不明确使用LOAD加载的库。例如针对某个用户将该参数设为ALTER USER SET来进行调试。 当指定的库未找到时，连接会失败。 每一个支持GaussDB的库都有一个“magic block”用于确保兼容性，因此不支持GaussDB的库不能通过这个方法加载。 该参数属于BACKEND类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串 默认值：空

输出性能统计日志 参数说明：对每条查询，以下4个选项控制在服务器日志里记录相应模块的性能统计数据，具体含义如下： log_parser_stats控制在服务器日志里记录解析器的性能统计数据。 log_planner_stats控制在服务器日志里记录查询优化器的性能统计数据。 log_executor_stats控制在服务器日志里记录执行器的性能统计数据。 log_statement_stats控制在服务器日志里记录整个语句的性能统计数据。 这些参数只能辅助管理员进行粗略分析，类似Linux中的操作系统工具getrusage() 。 这些参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 log_statement_stats记录总的语句统计数据，而其他的只记录针对每个模块的统计数据。 log_statement_stats不能和其他任何针对每个模块统计的选项一起打开。 取值范围：布尔型 on表示开启记录性能统计数据的功能。 off表示关闭记录性能统计数据的功能。 默认值：off

string_hash_compatible 参数说明：该参数用来说明char类型和varchar/text类型的hash值计算方式是否相同，以此来判断进行分布列从char类型到相同值的varchar/text类型转换，数据分布变化时，是否需要进行重分布。 该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示计算方式相同，不需要进行重分布。 off表示计算方式不同，需要进行重分布。 计算方式的不同主要体现在字符串计算hash值时传入的字节长度上。（如果为char，则会忽略字符串后面空格的长度，如果为text或varchar，则会保留字符串后面空格的长度。）hash值的计算会影响到查询的计算结果，因此此参数一旦设置后，在整个数据库使用过程中不能再对其进行修改，以避免查询错误。 默认值：off

ustore_attr 参数说明：该参数主要用来控制USTORE存储引擎表的信息统计，回滚类型，重点模块(包括数据、索引、回滚段、回放等)运行时数据的校验，主要用于协助研发问题定位。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：字符串，该参数值的设置方式采用key-value模式，key和value取值对应关系和说明如下。如果是多个key-value组合设置，中间使用";"作为分隔符，例如： ustore_attr='ustore_verify_level=NORMAL;ustore_verify_module=UPAGE:UBTREE:UNDO:REDO'。 ustore_attr设置参数值时，key和value之间的"="前后不要有空格或者其他字符，例如ustore_attr='ustore_verify_level = NORMAL;，内核代码校验会发现参数不合法，导致参数设置失败。 ustore_verify_level：控制校验的级别。 取值范围：字符串，见下述表格详细描述。 表1 ustore_verify_level取值含义说明 参数取值 含义 FAST FAST表示快速校验，校验内容少，性能影响最小。 NORMAL NORMAL表示正常校验，校验内容相比快速校验增多，性能影响中等。 SLOW SLOW表示慢速校验，校验内容最多，性能影响比较大。 默认值：空字符串 ustore_verify_module：控制校验的模块。 取值范围：字符串，设置值UPAGE，UBTREE，UNDO, REDO中的一个或者多个，或者单独设置ALL或者NULL(不区分大小写)。当设置 UPAGE，UBTREE，UNDO，REDO中的多个值时，使用":"作为连接符。例如ustore_verify_module=UPAGE:UBTREE:UNDO:REDO。 表2 ustore_verify_module取值含义说明 参数取值 含义 UPAGE 表示开启数据页面校验 UBTREE 表示开启UBTREE索引校验 UNDO 表示开启回滚段数据校验 REDO 表示开启REDO流程的数据页面校验 ALL 表示同时开启UPAGE，UBTREE，UNDO，REDO模块数据的校验 NULL 表示同时关闭UPAGE，UBTREE，UNDO，REDO模块数据的校验 默认值：空字符串 index_trace_level：控制开启索引追踪并控制打印级别，开启后在索引扫描的过程中，会根据不同的打印级别对符合条件的索引元组的信息进行打印。 取值范围：字符串，取值下表格描述。 默认值：NO 表3 index_trace_level取值含义说明 参数取值 含义 NO 不打印任何额外信息。 NORMAL 打印可见索引元组相关信息，包括： 当前索引元组所在索引页面号以及偏移。 当前元组状态。 当前元组对应的TID以及partOid。 当前元组对应的xmin和xmax信息。 当前元组内容（如果开启enable_log_tuple）。 VISIBILITY 在NORMAL的基础上，额外打印没有通过可见性检查的索引元组的信息，并标明是否可见。 SHOWHIKEY 在VISIBILITY的基础上，尝试打印页面上HIKEY元组的信息。 ALL 打印扫描的索引页面上所有元组的相关信息。 enable_log_tuple：打印日志级提示信息时，是否允许同时将相关元组的内容打印出来，以便进行问题排查和定位。 取值范围：on或者off（不区分大小写） 默认值：off 备注：该参数已弃用 enable_ustore_sync_rollback：控制USTORE表是否开启同步回滚。 取值范围：布尔值 默认值：true enable_ustore_async_rollback：控制USTORE表是否开启异步回滚。 取值范围：布尔值 默认值：true enable_ustore_page_rollback：控制USTORE表是否开启页面回滚。 取值范围：布尔值 默认值：true enable_ustore_partial_seqscan：是否允许USTORE表开启部分扫描。 取值范围：布尔值 默认值：false enable_candidate_buf_usage_count：是否开启缓存区使用计数统计。 取值范围：布尔值 默认值：false ustats_tracker_naptime：控制USTORE表统计信息周期。 取值范围：1~INT_MAX/1000 默认值：20, 单位(秒) umax_search_length_for_prune：控制USTORE表prune操作搜索的最大深度。 取值范围：1~INT_MAX/1000 默认值：10，单次(次) 默认值：空字符串 该参数只适用于集中式上的USTORE存储引擎表。

post_auth_delay 参数说明：在认证成功后，延迟指定时间，启动服务器连接。允许调试器附加到启动进程上。 该参数属于BACKEND类型参数，请参考表1中对应设置方法进行设置。 取值范围：整型，最小值为0，最大值为2147，单位为秒。 默认值：0 此参数只用于调试和问题定位，为避免影响正常业务运行，生产环境下请确保参数值为默认值0。参数设置为非0时可能会因认证延迟时间过长导致数据库实例状态异常。

enable_fast_numeric 参数说明：标识是否开启Numeric类型数据运算优化。Numeric数据运算是较为耗时的操作之一，通过将Numeric转化为int64/int128类型，提高Numeric运算的性能。 该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on/true表示开启Numeric优化。 off/false表示关闭Numeric优化。 默认值：on

debug_assertions 参数说明：控制打开各种断言检查。能够协助调试，当遇到奇怪的问题或者崩溃，请把此参数打开，因为它能暴露编程的错误。要使用这个参数，必须在编译GaussDB的时候定义宏USE_ASSERT_CHECKING（通过configure选项 --enable-cassert完成）。 该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。 取值范围：布尔型 on表示打开断言检查。 off表示不打开断言检查。 当启用断言选项编译GaussDB时，debug_assertions缺省值为on 。 默认值：off