*Redis CONFIG-HELP 命令

CONFIG-HELP 返回指定配置参数的帮助说明和允许的值范围。


*语法

CONFIG HELP <parameter>

*参数说明

参数 类型 必填 说明
parameter String 配置参数名称,如 maxmemory、appendonly

*返回值

返回该参数的帮助文本、数据类型、允许值范围等描述数组。


*时间复杂度

O(1)

*

*示例

*查看 maxmemory 帮助

> CONFIG HELP maxmemory
1) "maxmemory <bytes>"
2) "Set a memory usage limit to the specified amount of bytes."
3) "Since Redis 2.0"

*查看 appendonly 帮助

> CONFIG HELP appendonly
1) "appendonly <yes|no>"
2) "If appendonly is set to yes..."
...

*常见错误

错误 原因 解决
ERR No such configuration parameter 参数名不存在 检查参数名拼写,注意大小写不敏感
ERR wrong number of arguments 缺少参数 必须提供 parameter

*最佳实践

  • CLI 中快速查看配置含义,无需翻阅官方文档。
  • 用于自动化配置校验,先 HELP 再 SET 避免非法值。

*FAQ

CONFIG HELP 和 CONFIG GET 有什么区别? CONFIG GET 返回当前运行值;CONFIG HELP 返回参数的定义、类型和帮助文本。

所有参数都有帮助信息吗? 是的,Redis 内置参数均有;模块自定义参数依赖模块实现。

参数名区分大小写吗? CONFIG HELP 的参数名通常不区分大小写。