*Redis PUBSUB HELP 命令
返回 PUBSUB 子命令的帮助信息列表。
*语法
PUBSUB HELP
*参数说明
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| 无 | - | - | 本命令无参数 |
*返回值
| 条件 | 返回值 |
|---|---|
| 总是 | 字符串数组，包含所有支持的 PUBSUB 子命令及其说明 |
*时间复杂度
O(1)
*
*示例
*基本用法
> PUBSUB HELP
1) "PUBSUB <subcommand> [<arg> [value] [opt] ...]. Subcommands are:"
2) "CHANNELS [pattern]"
3) " Return the active channels matching pattern."
4) "NUMPAT"
5) " Return the number of pattern subscriptions."
6) "NUMSUB [channel [channel ...]]"
7) " Return the number of subscribers for channels."
8) "SHARDCHANNELS [pattern]"
9) " Return the active shard channels matching pattern."
10) "SHARDNUMSUB [channel [channel ...]]"
11) " Return the number of subscribers for shard channels."
12) "HELP"
13) " Print this help."
*在脚本中获取帮助信息
> EVAL "return redis.call('PUBSUB', 'HELP')" 0
1) "PUBSUB <subcommand> [<arg> [value] [opt] ...]. Subcommands are:"
2) "CHANNELS [pattern]"
...
*验证 PUBSUB 命令可用性
> PUBSUB HELP | HEAD -1
"PUBSUB <subcommand> [<arg> [value] [opt] ...]. Subcommands are:"
*常见错误
| 错误 | 原因 | 解决 |
|---|---|---|
| ERR wrong number of arguments | 传入了多余参数 | PUBSUB HELP 不带任何参数 |
| ERR unknown subcommand | 子命令拼写错误 | 使用 PUBSUB HELP 查看支持的子命令 |
*最佳实践
- 场景：快速查阅 PUBSUB 子命令用法，无需查阅外部文档
- 建议客户端在初始化时缓存帮助信息，避免重复查询
- 脚本中可用 PUBSUB HELP 动态探测 Redis 版本支持的子命令
- 注意：帮助文本格式可能随版本变化，不建议在自动化流程中依赖固定输出格式
*FAQ
Q1: PUBSUB HELP 和 PUBSUB CHANNELS 有什么区别？ A: PUBSUB HELP 返回 PUBSUB 子命令的帮助文本；PUBSUB CHANNELS 返回当前活跃的频道列表。前者是帮助命令，后者是查询命令。
Q2: PUBSUB HELP 会返回所有子命令吗？ A: 是的，返回当前 Redis 服务器版本支持的所有 PUBSUB 子命令及其简要说明。
Q3: PUBSUB HELP 的输出格式稳定吗？ A: 帮助文本可能会在不同 Redis 版本中发生变化。建议仅用于人工查阅，不要编写依赖固定输出格式的自动化脚本。