大网数据广告活动
数据库部署与 SQL 参考

FE/BE 参数和变量模板

· 52CE 我爱测

如果新加的参数或者变量用户不可见,仍然建议将参数描述补充到文档,并 comment out,这样可以对用户屏蔽该参数,同时帮助内部用户理解参数的含义和使用。

FE/BE 参数和变量模板

如果您新增或修改了代码文件中的 FE/BE 参数以及变量,务必更新文档 FE configuration, BE configuration, System variables。

参数和变量描述需要包含以下字段:

  • 默认值:参数默认值。如果不同版本中默认值不同,需要说明。
  • 类型:允许的数据类型。
  • 单位:如果没有单位,可以留空。
  • 取值范围:如果参数有取值范围,需要添加。
  • 是否动态:参数是否支持动态修改。变量不需要该字段。
  • 描述:包括含义,有效值,依赖和互斥关系,风险,调优方式,弃用/删除说明。
  • 引入版本:参数的引入版本,需精确到三位数版本,比如 3.2.1。

参数描述

含义

  • 这个参数是用来干什么的,适用什么场景。
  • 如果该参数和已有参数相似,两者的区别是什么。

依赖和互斥关系

  • 该参数是否依赖其他参数(只有其他参数设置之后,该参数才能生效)。
  • 其他参数是否依赖该参数。
  • 该参数是否与其他参数互斥。

有效值

如果参数有多个取值,需要罗列所有取值,解释每个取值的含义。

风险或注意事项

  • 使用该参数是否会带来风险。
  • 如果参数有取值范围,超过上限或者下限,会引发哪些风险?
  • 如果参数值设置过大,或者过小,会引发哪些问题?

调优方式

如果某个场景有报错,如何调整该参数。

弃用/删除说明

如果参数弃用:

  • 弃用的原因。
  • 是否被其他参数替代。
  • 相关的特性是否也随之下线。

默认值/单位变更

说明默认值或单位变更的背景和原因。

参数名变更

  • 更名的原因。
  • 更名是否会引发兼容性问题,系统怎么处理。

用户不可见的参数

如果新加的参数或者变量用户不可见,仍然建议将参数描述补充到文档,并 comment out,这样可以对用户屏蔽该参数,同时帮助内部用户理解参数的含义和使用。

本文来自 StarRocks 文档贡献者,按 Apache 2.0 整理版式与相对链接,保留正文与代码。图示请参阅原文。作者与贡献记录。

资料来源与适用范围

资料来源
StarRocks 文档贡献者
适用范围
main 文档快照(2026-11-16)
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
Apache 2.0

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。