*Redis SCRIPT HELP 命令
SCRIPT HELP 返回 SCRIPT 命令所有子命令的帮助信息列表。
*语法
SCRIPT HELP
*参数说明
SCRIPT HELP 不需要任何参数。
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无 | — | — | 无参数 |
*返回值
- String 数组:SCRIPT 各子命令的说明文本列表
*时间复杂度
O(1)
*
*示例
*获取帮助
> SCRIPT HELP
1) "SCRIPT LOAD <script>"
2) " Load a script into the scripts cache without executing it."
3) "SCRIPT EXISTS <sha1> [<sha1> ...]"
4) " Check if a script exists in the scripts cache by SHA1."
5) "SCRIPT FLUSH [ASYNC | SYNC]"
6) " Clear the scripts cache."
7) "SCRIPT KILL"
8) " Kill the currently executing script."
9) "SCRIPT DEBUG (YES | NO | SYNC)"
10) " Set the debug mode for scripts."
*常见错误
| 错误 | 原因 | 解决 |
|---|---|---|
| ERR wrong number of arguments | 传入了多余参数 | SCRIPT HELP 不需要参数 |
*最佳实践
- 快速查阅:不记得子命令语法时,用 SCRIPT HELP 查看可用选项
- 客户端集成:自动化工具可通过解析 HELP 输出动态发现子命令
- 与
COMMAND DOCS SCRIPT配合使用获取更详细的文档信息
*FAQ
Q1: SCRIPT HELP 和 COMMAND DOCS SCRIPT 有什么区别? A: SCRIPT HELP 返回简洁的文本列表;COMMAND DOCS 返回结构化的 JSON 格式文档,包含参数类型、返回值等详细信息。
Q2: SCRIPT HELP 的输出格式稳定吗? A: 基本稳定,但不同 Redis 版本的子命令数量和说明文本可能有差异,不建议硬编码解析。
Q3: 所有 Redis 命令都有 HELP 子命令吗? A: 不是。HELP 子命令通常存在于聚合命令(如 SCRIPT、ACL、SENTINEL、CLUSTER)中。