变量
PALO 中的变量(Variable)参考 MySQL 中的变量设置。
用户可以设置会话级别的变量和全局生效的标量。
但部分变量仅用于兼容一些 MySQL 客户端协议,并不产生其在 MySQL 数据库中的实际意义。
变量设置与查看
查看
SHOW VARIABLES;
SHOW VARIABLES LIKE '%time_zone%';
设置
部分变量可以设置全局生效或仅当前会话生效。设置全局生效后,后续新的会话连接中会沿用设置值。而设置仅当前会话生效,则变量仅对当前会话产生作用。
设置仅当前会话生效,如:
SET exec_mem_limit = 137438953472;
SET forward_to_master = true;
SET time_zone = "Asia/Shanghai";
设置全局生效,如:
SET GLOBAL exec_mem_limit = 137438953472
注1:只有 admin 用户可以设置变量的全局生效。 注2:全局生效的变量不影响当前会话的变量值,仅影响新的会话中的变量。需断开连接后重新登录方可生效。
既支持当前会话生效又支持全局生效的变量包括:
time_zone
wait_timeout
sql_mode
is_report_success
query_timeout
exec_mem_limit
batch_size
parallel_fragment_exec_instance_num
parallel_exchange_instance_num
enable_fold_constant_by_be
enable_cost_based_join_reorder
只支持全局生效的变量包括:
default_rowset_type
同时,变量设置也支持常量表达式。如:
SET exec_mem_limit = 10 * 1024 * 1024 * 1024;
SET forward_to_master = concat('tr', 'u', 'e');
在查询语句中设置变量
在一些场景中,我们可能需要对某些查询有针对性的设置变量。 通过使用SET_VAR提示可以在查询中设置会话变量(在单个语句内生效)。例子:
SELECT /*+ SET_VAR(exec_mem_limit = 8589934592) */ name FROM people ORDER BY name;
SELECT /*+ SET_VAR(query_timeout = 1) */ sleep(3);
注意注释必须以 /*+
开头,并且只能跟随在SELECT之后。
支持的变量
-
SQL_AUTO_IS_NULL
用于兼容 JDBC 连接池 C3P0。 无实际作用。
-
auto_increment_increment
用于兼容 MySQL 客户端。无实际作用。
-
autocommit
用于兼容 MySQL 客户端。无实际作用。
-
batch_size
用于指定在查询执行过程中,各个节点传输的单个数据包的行数。默认一个数据包的行数为 1024 行,即源端节点每产生 1024 行数据后,打包发给目的节点。
较大的行数,会在扫描大数据量场景下提升查询的吞吐,但可能会在小查询场景下增加查询延迟。同时,也会增加查询的内存开销。建议设置范围 1024 至 4096。
-
character_set_client
用于兼容 MySQL 客户端。无实际作用。
-
character_set_connection
用于兼容 MySQL 客户端。无实际作用。
-
character_set_results
用于兼容 MySQL 客户端。无实际作用。
-
character_set_server
用于兼容 MySQL 客户端。无实际作用。
-
codegen_level
用于设置 LLVM codegen 的等级。(当前未生效)。
-
collation_connection
用于兼容 MySQL 客户端。无实际作用。
-
collation_database
用于兼容 MySQL 客户端。无实际作用。
-
collation_server
用于兼容 MySQL 客户端。无实际作用。
-
disable_colocate_join
控制是否启用 Colocation Join 功能。默认为 false,表示启用该功能。true 表示禁用该功能。当该功能被禁用后,查询规划将不会尝试执行 Colocation Join。
-
disable_streaming_preaggregations
控制是否开启流式预聚合。默认为 false,即开启。当前不可设置,且默认开启。
-
enable_cost_based_join_reorder
是否开启基于代价模型的 Join Reorder 优化。默认关闭。开启后,PALO 将使用更优的规划方式来确定 Join 的顺序。该功能尚处于实验性质,对于复杂的对表 Join 查询,可以尝试开启该功能观察优化效果。
-
enable_fold_constant_by_be
是否通过 ComputeNode 节点计算 SQL 中的常量表达式。默认为 false。
Leader Node 节点默认会计算部分 SQL 中的常量表达式,对常量表达式的计算,有助于查询规划器进行谓词下推、分区裁剪等查询优化工作。但是 Leader Node 上的计算能力有限,部分复杂的常量表达式无法支持。此时可以设置这个变量为 true,PALO 会借助 Compute Node 来进行表达式的计算。但是这种方式会增加额外的节点间的 RPC。对于高并发场景,需观察对集群的性能影响。
-
enable_insert_strict
用于设置通过 INSERT 语句进行数据导入时,是否开启
strict
模式。默认为 false,即不开启strict
模式。关于该模式的介绍,可以参阅 严格模式。 -
enable_spilling
用于设置是否开启大数据量落盘排序。默认为 false,即关闭该功能。当用户未指定 ORDER BY 子句的 LIMIT 条件,同时设置
enable_spilling
为 true 时,才会开启落盘排序。该功能启用后,会使用 BE 数据目录下doris-scratch/
目录存放临时的落盘数据,并在查询结束后,清空临时数据。该功能主要用于使用有限的内存进行大数据量的排序操作。
注意,该功能为实验性质,不保证稳定性,请谨慎开启。
-
exec_mem_limit
用于设置单个查询的内存限制。默认为 2GB,单位为
B/K/KB/M/MB/G/GB/T/TB/P/PB
, 默认为B。该参数用于限制一个查询计划中,单个查询计划的实例所能使用的内存。一个查询计划可能有多个实例,一个 BE 节点可能执行一个或多个实例。所以该参数并不能准确限制一个查询在整个集群的内存使用,也不能准确限制一个查询在单一 BE 节点上的内存使用。具体需要根据生成的查询计划判断。
通常只有在一些阻塞节点(如排序节点、聚合节点、Join 节点)上才会消耗较多的内存,而其他节点(如扫描节点)中,数据为流式通过,并不会占用较多的内存。
当出现
Memory Exceed Limit
错误时,可以尝试指数级增加该参数,如 4G、8G、16G 等。 -
forward_to_master
用户设置是否将一些命令转发到 Master FE 节点执行。默认为 false,即不转发。PALO 中存在多个 FE 节点,其中一个为 Master 节点。通常用户可以连接任意 FE 节点进行全功能操作。但部分信息查看指令,只有从 Master FE 节点才能获取详细信息。
如
SHOW BACKENDS;
命令,如果不转发到 Master FE 节点,则仅能看到节点是否存活等一些基本信息,而转发到 Master FE 则可以获取包括节点启动时间、最后一次心跳时间等更详细的信息。当前受该参数影响的命令如下:
-
SHOW FRONTENDS;
转发到 Master 可以查看最后一次心跳信息。
-
SHOW BACKENDS;
转发到 Master 可以查看启动时间、最后一次心跳信息、磁盘容量信息。
-
SHOW BROKER;
转发到 Master 可以查看启动时间、最后一次心跳信息。
-
SHOW TABLET;
/ADMIN SHOW REPLICA DISTRIBUTION;
/ADMIN SHOW REPLICA STATUS;
转发到 Master 可以查看 Master FE 元数据中存储的 tablet 信息。正常情况下,不同 FE 元数据中 tablet 信息应该是一致的。当出现问题时,可以通过这个方法比较当前 FE 和 Master FE 元数据的差异。
-
SHOW PROC;
转发到 Master 可以查看 Master FE 元数据中存储的相关 PROC 的信息。主要用于元数据比对。
-
-
init_connect
用于兼容 MySQL 客户端。无实际作用。
-
interactive_timeout
用于兼容 MySQL 客户端。无实际作用。
-
is_report_success
用于设置是否需要查看查询的 profile。默认为 false,即不需要 profile。
默认情况下,只有在查询发生错误时,BE 才会发送 profile 给 FE,用于查看错误。正常结束的查询不会发送 profile。发送 profile 会产生一定的网络开销,对高并发查询场景不利。 当用户希望对一个查询的 profile 进行分析时,可以将这个变量设为 true 后,发送查询。查询结束后,可以通过在当前连接的 FE 的 web 页面查看到 profile:
fe_host:fe_http_port/query
其中会显示最近100条,开启
is_report_success
的查询的 profile。 -
language
用于兼容 MySQL 客户端。无实际作用。
-
license
显示 PALO 的 License。无其他作用。
-
load_mem_limit
用于指定导入操作的内存限制。默认为 0,即表示不使用该变量,而采用
exec_mem_limit
作为导入操作的内存限制。这个变量仅用于 INSERT 操作。因为 INSERT 操作设计查询和导入两个部分,如果用户不设置此变量,则查询和导入操作各自的内存限制均为
exec_mem_limit
。否则,INSERT 的查询部分内存限制为exec_mem_limit
,而导入部分限制为load_mem_limit
。其他导入方式,如 BROKER LOAD,STREAM LOAD 的内存限制依然使用
exec_mem_limit
。 -
lower_case_table_names
用于兼容 MySQL 客户端。不可设置。当前 PALO 中的表名默认为大小写敏感。
-
max_allowed_packet
用于兼容 JDBC 连接池 C3P0。 无实际作用。
-
net_buffer_length
用于兼容 MySQL 客户端。无实际作用。
-
net_read_timeout
用于兼容 MySQL 客户端。无实际作用。
-
net_write_timeout
用于兼容 MySQL 客户端。无实际作用。
-
parallel_exchange_instance_num
用于设置执行计划中,一个上层节点接收下层节点数据所使用的 exchange node 数量。默认为 -1,即表示 exchange node 数量等于下层节点执行实例的个数(默认行为)。当设置大于0,并且小于下层节点执行实例的个数,则 exchange node 数量等于设置值。
在一个分布式的查询执行计划中,上层节点通常有一个或多个 exchange node 用于接收来自下层节点在不同 BE 上的执行实例的数据。通常 exchange node 数量等于下层节点执行实例数量。
在一些聚合查询场景下,如果底层需要扫描的数据量较大,但聚合之后的数据量很小,则可以尝试修改此变量为一个较小的值,可以降低此类查询的资源开销。如在 DUPLICATE KEY 明细模型上进行聚合查询的场景。
-
parallel_fragment_exec_instance_num
针对扫描节点,设置其在每个 BE 节点上,执行实例的个数。默认为 1。
一个查询计划通常会产生一组 scan range,即需要扫描的数据范围。这些数据分布在多个 BE 节点上。一个 BE 节点会有一个或多个 scan range。默认情况下,每个 BE 节点的一组 scan range 只由一个执行实例处理。当机器资源比较充裕时,可以将增加该变量,让更多的执行实例同时处理一组 scan range,从而提升查询效率。
而 scan 实例的数量决定了上层其他执行节点,如聚合节点,join 节点的数量。因此相当于增加了整个查询计划执行的并发度。修改该参数会对大查询效率提升有帮助,但较大数值会消耗更多的机器资源,如CPU、内存、磁盘IO。
-
query_cache_size
用于兼容 MySQL 客户端。无实际作用。
-
query_cache_type
用于兼容 JDBC 连接池 C3P0。 无实际作用。
-
query_timeout
用于设置查询超时。该变量会作用于当前连接中所有的查询语句,以及 INSERT 语句。默认为 5 分钟,单位为秒。
-
resource_group
暂不使用。
-
sql_mode
用于指定 SQL 模式,以适应某些 SQL 方言。
-
sql_safe_updates
用于兼容 MySQL 客户端。无实际作用。
-
sql_select_limit
用于兼容 MySQL 客户端。无实际作用。
-
system_time_zone
显示当前系统时区。不可更改。
-
time_zone
用于设置当前会话的时区。时区会对某些时间函数的结果产生影响,详情可以参阅 时区。
-
tx_isolation
用于兼容 MySQL 客户端。无实际作用。
-
version
用于兼容 MySQL 客户端。无实际作用。
-
performance_schema
用于兼容 8.0.16及以上版本的MySQL JDBC。无实际作用。
-
version_comment
用于显示 PALO 的版本。不可更改。
-
wait_timeout
用于设置空闲连接的连接时长。当一个空闲连接在该时长内与 PALO 没有任何交互,则 PALO 会主动断开这个链接。默认为 8 小时,单位为秒。
-
rewrite_count_distinct_to_bitmap_hll
是否将 bitmap 和 hll 类型的 count distinct 查询重写为 bitmap_union_count 和 hll_union_agg 。
-
prefer_join_method
在选择 join 的具体实现方式是 broadcast join 还是 shuffle join 时,如果 broadcast join cost 和 shuffle join cost 相等时,优先选择哪种 join 方式。
目前该变量的可选值为
broadcast
或者shuffle
。