*Redis CLUSTER HELP 命令

CLUSTER HELP 显示 Redis Cluster 所有子命令的简要说明和用法提示。


*语法

CLUSTER HELP

*参数说明

无参数。


*返回值

  • Array:多行文本数组,每行包含一个子命令的简要说明。

*时间复杂度

O(1)

*

*示例

*查看 Cluster 子命令帮助

> CLUSTER HELP
 1) CLUSTER <subcommand> [<arg> [value] [opt] ...]. Subcommands are:
 2) (no subcommand)
 3)     Return details about all Redis Cluster commands.
 4) COUNT-FAILURE-REPORTS <node-id>
 5)     Return the number of failure reports for the specified node.
 6) COUNTKEYSINSLOT <slot>
 7)     Return the number of local keys in the specified hash slot.
 8) GETKEYSINSLOT <slot> <count>
 9)     Return local key names in the specified hash slot.
10) INFO
11)     Provides info about Redis Cluster node state.
12) ...

*快速查找子命令用法

> CLUSTER HELP

(在 Redis 客户端中执行,会列出所有可用子命令及其用途)

*配合管道过滤

> CLUSTER HELP | grep SLOTS

(在 redis-cli 中使用管道搜索特定子命令)


*常见错误

错误 原因 解决
ERR wrong number of arguments 传入了额外参数 HELP 子命令不接受任何参数
ERR This instance has cluster support disabled 未启用集群模式 在 redis.conf 中设置 cluster-enabled yes

*最佳实践

  • 作为 Redis Cluster 的入门参考,快速了解所有可用子命令
  • 在不确定子命令拼写或用法时,先执行 HELP 查看提示
  • 不同 Redis 版本的 HELP 输出可能不同,新版本中可能包含新增子命令
  • 建议在 redis-cli 中配合 grep 使用,快速定位目标子命令

*FAQ

Q1: CLUSTER HELP 和 Redis 的 COMMAND 命令有什么区别? A: COMMAND 返回所有 Redis 命令的元数据(参数、复杂度等),而 CLUSTER HELP 仅返回 Cluster 子命令的简要文本说明,更易读。

Q2: HELP 的输出会随版本变化吗? A: 会。新版本的 Redis 会增加新的 Cluster 子命令,HELP 输出会自动包含这些新增命令的说明。

Q3: 非集群模式下能执行 CLUSTER HELP 吗? A: 不能。所有 CLUSTER 子命令(包括 HELP)都需要在 cluster-enabled yes 的实例上执行。