*Redis SLOWLOG HELP 命令

SLOWLOG HELP 返回描述 SLOWLOG 各子命令用途的帮助文本。


*语法

SLOWLOG HELP

*参数说明

参数 类型 必填 说明
该命令无需任何参数

*返回值

  • Array:子命令名称和描述文本的数组,格式为 ["subcommand", "description", ...]

*时间复杂度

O(1)

*

*示例

*获取帮助信息

> SLOWLOG HELP
1) "SLOWLOG <subcommand> [arg] [arg] ... [arg]"
2) "Subcommands:"
3) "GET [count]"
4) "    Return top [count] entries from the slow log (default: all)."
5) "LEN"
6) "    Return the number of entries in the slow log."
7) "RESET"
8) "    Clear all entries from the slow log."
9) "HELP"
10) "    Print this help."

*在脚本中解析帮助

$ redis-cli SLOWLOG HELP | head -n 10

*常见错误

错误 原因 解决
ERR wrong number of arguments 提供了多余参数 SLOWLOG HELP 不接受任何参数

*最佳实践

  • 命令发现:在 Redis 6.2+ 中,HELP 子命令是 Redis 命令容器(container commands)的标准模式,便于快速了解可用子命令
  • 自动化工具:CLI 客户端或管理工具可解析 SLOWLOG HELP 输出,动态构建命令补全提示
  • 配合 COMMAND DOCS:相比 COMMAND DOCS,HELP 提供更简洁的纯文本说明,适合终端阅读

*FAQ

Q1: SLOWLOG HELP 和 COMMAND DOCS SLOWLOG 有什么区别? A: SLOWLOG HELP 是 SLOWLOG 命令自身的子命令,返回纯文本帮助;COMMAND DOCS 返回 RESP 协议格式的结构化元数据,适合程序解析。

Q2: SLOWLOG HELP 在哪些版本可用? A: Redis 6.2.0 开始引入。早期版本不支持 SLOWLOG HELP 子命令。

Q3: 为什么 SLOWLOG 是容器命令,而有独立的 HELP 子命令? A: Redis 6.2+ 引入的标准模式:容器命令(如 SLOWLOGACLCLIENT)统一提供 HELP 子命令,返回人类可读的帮助文本,改善命令可发现性。