其他优化器选项

其他优化器选项

explain_dna_file

**参数说明：**指定explain_perf_mode为run，导出的csv信息的目标文件。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

须知： 这个参数的取值必须是绝对路径加上.csv格式的文件名。

**取值范围：**字符串

**默认值：**空

explain_perf_mode

参数说明：此参数用来指定explain的显示格式。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：normal、pretty、summary、run

normal：代表使用默认的打印格式。
pretty：代表使用openGauss改进后的新显示格式。新的格式层次清晰，计划包含了plan node id，性能分析简单直接。
summary：是在pretty的基础上增加了对打印信息的分析。
run：在summary的基础上，将统计的信息输出到csv格式的文件中，以便于进一步分析。

默认值：normal

analysis_options

**参数说明：**通过开启对应选项中所对应的功能选项使用相应的定位功能，包括数据校验，性能统计等，参见取值范围中的选项说明。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。设置时，选择开启或者关闭的选项请使用’on()’或’off()’包括，未被显示指定的功能选项会维持原来的值，参考格式：’on(option1, option2, …)’。

**取值范围：**字符串

LLVM_COMPILE表示在explain performance显示界面中显示每个线程的codegen编译时间。
HASH_CONFLICT表示在数据库节点进程的pg_log目录中的log日志中显示hash表的统计信息，包括hash表大小，hash链长，hash冲突情况。
STREAM_DATA_CHECK表示对网络传输前后的数据进行CRC校验。

说明： pretty模式当前版本不支持。

**默认值：**ALL,on(),off(LLVM_COMPILE,HASH_CONFLICT,STREAM_DATA_CHECK)，不开启任何定位功能。

cost_param

参数说明：该参数用于控制在特定的客户场景中，使用不同的估算方法使得估算值与真实值更接近。此参数可以同时控制多种方法，与某一方法对应的位做与操作，不为0表示该方法被选择。

当cost_param & 1 不为0，表示对于求不等值连接选择率时选择一种改良机制，此方法在自连接（两个相同的表之间连接）的估算中更加准确。目前，已弃用cost_param & 1 不为0时的路径，默认选择更优的估算公式；

当cost_param & 2 不为0，表示求多个过滤条件（Filter）的选择率时，选择最小的作为总的选择率，而非两者乘积，此方法在过滤条件的列之间关联性较强时估算更加准确；

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，0～INT_MAX

默认值：0

enable_partitionwise

参数说明：分区表连接操作是否选择智能算法。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示选择智能算法。
off表示不选择智能算法。

默认值：off

rewrite_rule

参数说明：标识开启的可选查询重写规则。有部分查询重写规则是可选的，开启它们并不能总是对查询效率有提升效果。在特定的客户场景中，通过此GUC参数对查询重写规则进行设置，使得查询效率最优。

此参数可以控制查询重写规则的组合，比如有多个重写规则：rule1、rule2、rule3、rule4。可以设置：

set rewrite_rule=rule1;          --启用查询重写规则rule1
set rewrite_rule=rule2,rule3;    --启用查询重写规则rule2和rule3
set rewrite_rule=none;           --关闭所有可选查询重写规则

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：字符串

none：不使用任何可选查询重写规则。
lazyagg：使用Lazy Agg查询重写规则（消除子查询中的聚集运算）。
magicset : 使用Magic Set查询重写规则（从主查询中下推条件到子查询）。
partialpush：使用Partial Push查询重写规则。
uniquecheck：使用Unique Check查询重写规则（提升目标列中无agg的子查询语句，在执行时检查返回行数是否为1行）。
disablerep：使用Disable Replicate查询重写规则。
intargetlist：使用In Target List查询重写规则（提升目标列中的子查询）。
predpushnormal：使用Predicate Push查询重写规则（下推谓词条件到子查询中）。
predpushforce：使用Predicate Push查询重写规则（下推谓词条件到子查询中，尽可能的利用索引加速）。
predpush：在predpushnormal和predpushforce中根据代价选择最优计划。

默认值：magicset

enable_pbe_optimization

参数说明：设置优化器是否对以PBE（Parse Bind Execute）形式执行的语句进行查询计划的优化。

该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型。

on表示优化器将优化PBE语句的查询计划。
off表示不使用优化。

默认值：on

enable_light_proxy

参数说明：设置优化器是否对简单查询在数据库主节点上优化执行，应用端和内核端字符集不匹配时，该参数不生效，建议建库时将字符集设为UTF8。

该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型。

on表示优化器将优化数据库主节点上简单查询的执行。
off表示不使用优化。

默认值：on

enable_global_plancache

参数说明：设置是否对PBE查询的执行计划进行缓存共享，开启该功能可以节省高并发下数据库节点的内存使用。

在打开enable_global_plancache的情况下，为保证GPC生效，默认local_syscache_threshold不小于16MB。即如当前local_syscache_threshold小于16MB，则设置为16MB，如大于16MB，则不改变。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型。

on表示对PBE查询的执行计划进行缓存共享。
off表示不共享。

默认值：off

enable_global_stats

**参数说明：**标识当前统计信息模式，区别采用全局统计信息收集模式还是单节点统计信息收集模式，默认创建为采用全局统计信息模式。当关闭该参数时，则默认收集openGauss第一个节点的统计信息，此时可能会影响生成查询计划的质量，但信息收集性能较优，建议客户谨慎考虑。

该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on/true表示全局统计信息。
off/false表示数据库节点统计信息。

**默认值：**on

enable_opfusion

参数说明：控制是否对简单增删改查进行优化。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

简单查询限制如下：

只支持indexscan和indexonlyscan，且全部WHERE语句的过滤条件都在索引上。
只支持单表增删改查，不支持join、using。
只支持行存表，不支持分区表，表不支持有触发器。
不支持active sql、QPS等信息统计特性。
不支持正在扩容和缩容的表。
不支持查询或者修改系统列。
只支持简单SELECT语句，例如：
```
SELECT c3 FROM t1 WHERE c1 = ? and c2 =10;
```
仅可以查询目标表的列，c1和c2列为索引列，后边可以是常量或者参数，可以使用 for update。
只支持简单INSERT语句，例如：
```
INSERT INTO t1 VALUES (?,10,?);
```
仅支持一个VALUES，VALUES里面的类型可以是常量和参数，不支持returning。
只支持简单DELETE语句，例如：
```
DELETE FROM t1 WHERE c1 = ? and c2 = 10;
```
c1和c2列为索引列，后边可以是常量或者参数。
只支持简单UPDATE语句，例如：
```
UPDATE t1 SET c3 = c3+? WHERE c1 = ? and c2 = 10;
```
c3列修改的值可以是常量和参数，也可以是一个简单的表达式，c1和c2列为索引列，后边可以是常量或者参数。

取值范围：布尔型

on表示使用。
off表示不使用。

默认值：off

enable_partition_opfusion

参数说明：在enable_opfusion参数打开的状态下，如果开启该参数，可以对分区表的简单查询进行查询优化，提升SQL执行性能。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示使用。
off表示不使用。

默认值：off

sql_beta_feature

参数说明：标识开启的可选SQL引擎Beta特性，其中包括对行数估算、查询等价估算等优化。

开启它们可以对特定的场景进行优化，但也可能会导致部分没有被测试覆盖的场景发生性能劣化。在特定的客户场景中，通过此GUC参数对查询重写规则进行设置，使得查询效率最优。

此参数可以控制SQL引擎Beta特性的组合，比如有多个Beta特性：feature1、feature2、feature3、feature4。可以设置：

--启用SQL引擎Beta特性feature1。
set sql_beta_feature=feature1;
--启用SQL引擎Beta特性feature2和feature3。
set sql_beta_feature=feature2,feature3;
--关闭所有可选SQL引擎Beta特性。
set sql_beta_feature=none;

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：字符串

none：不使用任何Beta优化器特性。
sel_semi_poisson：使用泊松分布对等值的半连接和反连接选择率进行校准。
sel_expr_instr：使用字符串匹配的行数估算方法对instr(col, ‘const’) > 0, = 0, = 1进行更准确的估算。
param_path_gen：生成更多可能的参数化路径。
rand_cost_opt：对小数据量表的随机读取代价进行优化。
param_path_opt：利用表的膨胀系数优化索引analyze信息。
page_est_opt：优化对非列存表索引analyze信息的relpages估算。
no_unique_index_first：关闭主键索引扫描路径优先的优化。

默认值：none

ngram_gram_size

**参数说明：**ngram解析器分词的长度。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**整型，1～4

**默认值：**2

ngram_grapsymbol_ignore

**参数说明：**ngram解析器是否忽略图形化字符。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示忽略图形化字符。
off表示不忽略图形化字符。

**默认值：**off

ngram_punctuation_ignore

**参数说明：**ngram解析器是否忽略标点符号。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示忽略标点符号。
off表示不忽略标点符号。

**默认值：**on

default_statistics_target

参数说明：为没有用ALTER TABLE SET STATISTICS设置字段目标的表设置缺省统计目标。此参数设置为正数是代表统计信息的样本数量，为负数时，代表使用百分比的形式设置统计目标，负数转换为对应的百分比，即-5代表5%。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，-100～10000。

须知：

比默认值大的正数数值增加了ANALYZE所需的时间，但是可能会改善优化器的估计质量。
调整此参数可能存在性能劣化的风险，如果某个查询劣化，可以考虑

恢复默认的统计信息。
使用plan hint来调整到之前的查询计划。（详细参见[使用Plan Hint进行调优](使用Plan Hint进行调优.md)）

当此guc参数设置为负数时，如果计算的采样样本数大于等于总数据量的2%，且用户表的数据量小于1600000时，ANALYZE所需时间相比guc参数为默认值的时间会有所增加。
当此guc参数设置为负数时，则autoanalyze不生效。

默认值：100

constraint_exclusion

参数说明：控制查询优化器使用表约束查询的优化。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：枚举类型

on表示检查所有表的约束。
off表示不检查约束。
partition表示只检查继承的子表和UNION ALL子查询。

须知： 当constraint_exclusion为on，优化器用查询条件和表的CHECK约束比较，并且在查询条件和约束冲突的时候忽略对表的扫描。

默认值：partition

说明： 目前， constraint_exclusion缺省被打开，通常用来实现表分区。为所有的表打开它时，对于简单的查询强加了额外的规划，并且对简单查询没有什么好处。如果不用分区表，可以关掉它。

cursor_tuple_fraction

参数说明：优化器估计游标获取行数在总行数中的占比。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：浮点型，0.0～1.0。

须知： 比默认值小的值与使用 “fast start” 为游标规划的值相偏离，从而使得前几行恢复的很快而抓取全部的行需要很长的时间。比默认值大的值加大了总的估计的时间。在最大的值1.0处，像正常的查询一样规划游标，只考虑总的估计时间和传送第一行的时间。

默认值：0.1

from_collapse_limit

参数说明：根据生成的FROM列表的项数来判断优化器是否将把子查询合并到上层查询，如果FROM列表项个数小于等于该参数值，优化器会将子查询合并到上层查询。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，1～INT_MAX。

须知： 比默认值小的数值将降低规划时间，但是可能生成差的执行计划。

默认值：8

join_collapse_limit

参数说明：根据得出的列表项数来判断优化器是否执行把除FULL JOINS之外的JOIN构造重写到FROM列表中。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，1～INT_MAX。

须知：

设置为1会避免任何JOIN重排。这样就使得查询中指定的连接顺序就是实际的连接顺序。查询优化器并不是总能选取最优的连接顺序，高级用户可以选择暂时把这个变量设置为1，然后指定它们需要的连接顺序。
比默认值小的数值减少规划时间但也降低了执行计划的质量。

默认值：8

plan_mode_seed

参数说明：该参数为调测参数，目前仅支持OPTIMIZE_PLAN和RANDOM_PLAN两种。其中：OPTIMIZE_PLAN表示通过动态规划算法进行代价估算的最优plan，参数值设置为0；RANDOM_PLAN表示随机生成的plan；如果设置为-1，表示用户不指定随机数的种子标识符seed值，由优化器随机生成[1, 2147483647]范围整型值的随机数，并根据随机数生成随机的执行计划；如果用户指定guc参数值为[1, 2147483647]范围的整型值，表示指定的生成随机数的种子标识符seed，优化器需要根据seed值生成随机的执行计划。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，-1~ 2147483647

默认值：0

须知：

当该参数设置为随机执行计划模式时，优化器会生成不同的随机执行计划，该执行计划可能不是最优计划。因此在随机计划模式下，会对查询性能产生影响，所以建议在升级、扩容、缩容等正常业务操作或运维过程中将该参数保持为默认值0。
当该参数不为0时，查询指定的plan hint不会生效。

hashagg_table_size

参数说明：用于设置执行HASH JOIN操作时HASH表的大小。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：整型，0～INT_MAX/2。

默认值：0

enable_codegen

**参数说明：**标识是否允许开启代码生成优化，目前代码生成使用的是LLVM优化。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示允许开启代码生成优化。
off表示不允许开启代码生成优化。

须知： 目前LLVM优化仅支持向量化执行引擎特性和SQL on Hadoop特性，在其他场景下建议关闭此参数。

**默认值：**on

codegen_strategy

**参数说明：**标识在表达式codegen化过程中所使用的代码生成优化策略。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**枚举类型

partial表示当所计算表达式中即使包含部分未被codegen化的函数时，仍可借助表达式全codegen框架调用LLVM动态编译优化策略。
pure表示当所计算表达式整体可被codegen化时，才考虑调用LLVM动态编译优化策略。

须知： 在开启代码生成优化会导致查询性能下降的场景下可以设置此参数为pure，其他场景下建议不改变此参数的默认值partial。

**默认值：**partial

enable_codegen_print

**参数说明：**标识是否允许在log日志中打印所生成的LLVM IR函数。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示允许在log日志中打印IR函数。
off表示不允许在log日志中打印IR函数。

**默认值：**off

codegen_cost_threshold

**参数说明：**由于LLVM编译生成最终的可执行机器码需要一定时间，因此只有当实际执行的代价大于编译生成机器码所需要的代码和优化后的执行代价之和时，利用代码生成才有收益。codegen_cost_threshold标识代价的阈值，当执行估算代价大于该代价时，使用LLVM优化。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**整型，0 ~ 2147483647。

**默认值：**10000

enable_bloom_filter

**参数说明: **标识是否允许使用BloomFilter优化。该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示允许使用BloomFilter优化。
off表示不允许使用BloomFilter优化。

**默认值：**on

enable_extrapolation_stats

**参数说明: **标识对于日期类型是否允许基于历史统计信息使用推理估算的逻辑。使用该逻辑对于未及时收集统计信息的表可以增大估算准确的可能性，但也存在错误推理导致估算过大的可能性，需要对于日期类型数据定期插入的场景开启此开关。该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示允许基于历史统计信息使用推理估算的逻辑。
off表示不允许基于历史统计信息使用推理估算的逻辑。

**默认值：**off

autoanalyze

**参数说明: **标识是否允许在生成计划的时候，对于没有统计信息的表进行统计信息自动收集。对于外表和临时表，不支持autoanalyze，如果需要收集统计信息，用户需手动执行analyze操作。如果在auto analyze某个表的过程中数据库发生异常，当数据库正常运行之后再执行语句有可能仍提示需要收集此表的统计信息。此时需要用户对该表手动执行一次analyze操作，以同步统计信息数据。该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示允许自动进行统计信息收集。
off表示不允许自动进行统计信息收集。

**默认值：**off

enable_analyze_check

**参数说明: **标识是否允许在生成计划的时候，对于在pg_class中显示reltuples和relpages均为0的表，检查该表是否曾进行过统计信息收集。

该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示允许检查。
off表示不允许检查。

**默认值：**off

enable_sonic_hashagg

**参数说明：**标识是否依据规则约束使用基于面向列的hash表设计的Hash Agg算子。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示在满足约束条件时使用基于面向列的hash表设计的Hash Agg算子。
off表示不使用面向列的hash表设计的Hash Agg算子。

说明：

在开启enable_sonic_hashagg，且查询达到约束条件使用基于面向列的hash表设计的Hash Agg算子时，查询对应的Hash Agg算子内存使用通常可获得精简。但对于代码生成技术可获得显著性能提升的场景enable_codegen打开后获得较大性能提升)，对应的算子查询性能可能会出现劣化。
开启enable_sonic_hashagg，且查询达到约束条件使用基于面向列的hash表设计的Hash Agg算子时，在Explain Analyze/Performance的执行计划和执行信息中，算子显示为“Sonic Hash Aggregation”，而未达到该约束条件时，算子名称将显示为“Hash Aggregation”，Explain详解请参见详解。

**默认值：**on

enable_sonic_hashjoin

**参数说明：**标识是否依据规则约束使用基于面向列的hash表设计的Hash Join算子。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示在满足约束条件时使用基于面向列的hash表设计的Hash Join算子。
off表示不使用面向列的hash表设计的Hash Join算子。

说明：

当前开关仅适用于Inner Join的场景。
在开启enable_sonic_hashjoin，查询对应的Hash Inner算子内存使用通常可获得精简。但对于代码生成技术可获得显著性能提升的场景，对应的算子查询性能可能会出现劣化。
开启enable_sonic_hashjoin，且查询达到约束条件使用基于面向列的hash表设计的Hash Join算子时，在Explain Analyze/Performance的执行计划和执行信息中，算子显示为“Sonic Hash Join”，而未达到该约束条件时，算子名称将显示为“Hash Join”，Explain详解请参见详解。

**默认值：**on

enable_sonic_optspill

**参数说明：**标识是否对面向列的hash表设计的Hash Join算子进行下盘文件数优化。该参数打开时，在Hash Join算子下盘文件较多的时候，下盘文件数不会显著增加。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示优化面向列的hash表设计的Hash Join算子的下盘文件数。
off表示不优化面向列的hash表设计的Hash Join算子的下盘文件数。

**默认值：**on

log_parser_stats

参数说明：控制优化器输出parser模块的性能日志。

该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示使用。
off表示不使用。

默认值：off

log_planner_stats

参数说明：控制优化器输出planner模块的性能日志。

该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示使用。
off表示不使用。

默认值：off

log_executor_stats

参数说明：控制优化器输出executor模块的性能日志。

该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示使用。
off表示不使用。

默认值：off

log_statement_stats

参数说明：控制优化器输出该语句的性能日志。

该参数属于SUSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示使用。
off表示不使用。

默认值：off

plan_cache_mode

参数说明：标识在prepare语句中，选择生成执行计划的策略。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：枚举类型

auto表示按照默认的方式选择custom plan或者generic plan。
force_generic_plan表示强制走generic plan。
force_custom_plan表示强制走custom plan。

说明：

此参数只对prepare语句生效，一般用在prepare语句中参数化字段存在比较严重的数据倾斜的场景下。
custom plan是指对于preapre语句，在执行execute的时候，把execute语句中的参数嵌套到语句之后生成的计划。custom plan会根据execute语句中具体的参数生成计划，这种方案的优点是每次都按照具体的参数生成优选计划，执行性能比较好；缺点是每次执行前都需要重新生成计划，存在大量的重复的优化器开销。
generic plan是指对于preapre语句生成计划，该计划策略会在执行execute语句的时候把参数bind到plan中，然后执行计划。这种方案的优点是每次执行可以省去重复的优化器开销；缺点是当bind参数字段上数据存在倾斜时该计划可能不是最优的，部分bind参数场景下执行性能较差。

默认值：auto

enable_hypo_index

参数说明：控制优化器执行EXPLAIN命令时是否考虑虚拟索引。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示使用。
off表示不使用。

默认值：off

enable_force_vector_engine

参数说明：对于支持向量化的执行器算子，如果其子节点是非向量化的算子，通过设置此参数为on，强制生成向量化的执行计划。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型

on表示可以向量化的算子强制生成向量化。
off表示由向量化算子优化器决定是否向量化。

默认值：off

enable_auto_explain

参数说明：控制是否开启自动打印执行计划。该参数是用来定位慢存储过程或慢查询，只对当前连接的数据库主节点有效。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：布尔型，true表示开启，false表示关闭。

默认值：false

auto_explain_level

参数说明：控制自动打印执行计划的日志等级。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

取值范围：枚举型，LOG或NOTICE，LOG表示在日志中打印执行计划，NOTICE表示以提示知的形式打印出计划。

默认值：LOG