COMMAND DOCS

返回有关一个、多个或所有命令的文档信息。

语法

COMMAND DOCS [command-name [command-name ...]]

引入版本：7.0.0

复杂度摘要：O(N)

返回有关命令的文档信息。

默认情况下，回复包含服务器的所有命令。您可以使用可选的 命令名 参数来指定一个或多个命令的名称。

回复包括每个返回命令的映射。映射的回复中可能包含以下键：

• 总结： 短命令说明。
• 自： 添加命令的 Redis 版本（或者对于模块命令，模块版本）。
• 组： 命令所属的功能组。可能的值为：
  • 数组
  • bf
  • 位图
  • cf
  • 集群
  • CMS
  • 连接
  • 通用
  • 地理
  • 哈希
  • 超级日志
  • json
  • 清单
  • 发布订阅
  • 脚本编写
  • 搜索
  • 服务器
  • 设置
  • 有序集合
  • 流
  • 字符串
  • 建议
  • tdigest
  • 时间序列
  • 顶峰
  • 交易
  • 向量集
• 复杂性： 关于命令时间复杂度的简短说明。
• 文档标志： 文档标志数组。可能的值为：
• deprecated：该命令已被弃用。
• syscmd：不供用户调用的系统命令。
• deprecated_since： 弃用该命令的 Redis 版本（或对于模块命令，模块版本）。
• 替换者： 已弃用命令的替代方案。
• 历史： 一组历史注释，描述命令输出或参数的更改。它不应包含有关行为变化的信息。每个条目本身都是一个数组，由两个元素组成： 1. 该条目适用的 Redis 版本。 2、变更情况说明。
• 论据： 描述命令参数的映射数组。请参阅 Redis命令参数 页面了解更多信息。

可选参数

command-name [command-name ...]

要返回文档的一个或多个命令名称。如果省略，则返回所有命令的文档。

示例

redis> COMMAND DOCS SET
1) "set"
2)  1) "summary"
    2) "Sets the string value of a key, ignoring its type. The key is created if it doesn't exist."
    3) "since"
    4) "1.0.0"
    5) "group"
    6) "string"
    7) "complexity"
    8) "O(1)"
    9) "history"
   10) 1) 1) "2.6.12"
          2) "Added the `EX`, `PX`, `NX` and `XX` options."
       2) 1) "6.0.0"
          2) "Added the `KEEPTTL` option."
       3) 1) "6.2.0"
          2) "Added the `GET`, `EXAT` and `PXAT` option."
       4) 1) "7.0.0"
          2) "Allowed the `NX` and `GET` options to be used together."
       5) 1) "8.4.0"
          2) "Added 'IFEQ', 'IFNE', 'IFDEQ', 'IFDNE' options."
   11) "arguments"
   12) 1) 1) "name"
          2) "key"
          3) "type"
          4) "key"
          5) "display_text"
          6) "key"
          7) "key_spec_index"
          8) (integer) 0
       2) 1) "name"
          2) "value"
          3) "type"
          4) "string"
          5) "display_text"
          6) "value"
       3)  1) "name"
           2) "condition"
           3) "type"
           4) "oneof"
           5) "since"
           6) "2.6.12"
           7) "flags"
           8) 1) optional
           9) "arguments"
          10) 1) 1) "name"
                 2) "nx"
                 3) "type"
                 4) "pure-token"
                 5) "display_text"
                 6) "nx"
                 7) "token"
                 8) "NX"
              2) 1) "name"
                 2) "xx"
                 3) "type"
                 4) "pure-token"
                 5) "display_text"
                 6) "xx"
                 7) "token"
                 8) "XX"
              3)  1) "name"
                  2) "ifeq-value"
                  3) "type"
                  4) "string"
                  5) "display_text"
                  6) "ifeq-value"
                  7) "token"
                  8) "IFEQ"
                  9) "since"
                 10) "8.4.0"
              4)  1) "name"
                  2) "ifne-value"
                  3) "type"
                  4) "string"
                  5) "display_text"
                  6) "ifne-value"
                  7) "token"
                  8) "IFNE"
                  9) "since"
                 10) "8.4.0"
              5)  1) "name"
                  2) "ifdeq-digest"
                  3) "type"
                  4) "string"
                  5) "display_text"
                  6) "ifdeq-digest"
                  7) "token"
                  8) "IFDEQ"
                  9) "since"
                 10) "8.4.0"
              6)  1) "name"
                  2) "ifdne-digest"
                  3) "type"
                  4) "string"
                  5) "display_text"
                  6) "ifdne-digest"
                  7) "token"
                  8) "IFDNE"
                  9) "since"
                 10) "8.4.0"
       4)  1) "name"
           2) "get"
           3) "type"
           4) "pure-token"
           5) "display_text"
           6) "get"
           7) "token"
           8) "GET"
           9) "since"
          10) "6.2.0"
          11) "flags"
          12) 1) optional
       5) 1) "name"
          2) "expiration"
          3) "type"
          4) "oneof"
          5) "flags"
          6) 1) optional
          7) "arguments"
          8) 1)  1) "name"
                 2) "seconds"
                 3) "type"
                 4) "integer"
                 5) "display_text"
                 6) "seconds"
                 7) "token"
                 8) "EX"
                 9) "since"
                10) "2.6.12"
             2)  1) "name"
                 2) "milliseconds"
                 3) "type"
                 4) "integer"
                 5) "display_text"
                 6) "milliseconds"
                 7) "token"
                 8) "PX"
                 9) "since"
                10) "2.6.12"
             3)  1) "name"
                 2) "unix-time-seconds"
                 3) "type"
                 4) "unix-time"
                 5) "display_text"
                 6) "unix-time-seconds"
                 7) "token"
                 8) "EXAT"
                 9) "since"
                10) "6.2.0"
             4)  1) "name"
                 2) "unix-time-milliseconds"
                 3) "type"
                 4) "unix-time"
                 5) "display_text"
                 6) "unix-time-milliseconds"
                 7) "token"
                 8) "PXAT"
                 9) "since"
                10) "6.2.0"
             5)  1) "name"
                 2) "keepttl"
                 3) "type"
                 4) "pure-token"
                 5) "display_text"
                 6) "keepttl"
                 7) "token"
                 8) "KEEPTTL"
                 9) "since"
                10) "6.0.0"

Redis Software 与 Redis Cloud 兼容性

Redis 软件	Redis Cloud	说明
✅ 标准 ✅ 主动-主动	✅ 标准 ✅ 主动-主动

返回值

RESP2

数组回复：一个映射，为扁平数组，其中每个键是命令名称，每个值是文档信息。

RESP3

地图回复：一个映射，其中每个键是命令名称，每个值是文档信息。

资料来源：Redis 官方 COMMAND DOCS 文档；中文内容参考 Redis 文档许可。