命令文档

Syntax
COMMAND DOCS [command-name [command-name ...]]
Available since:
7.0.0
Time complexity:
O(N) where N is the number of commands to look up
ACL categories:
@slow, @connection,

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

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

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

  • summary: 简短的命令描述。
  • since: 添加该命令的Redis版本(或对于模块命令,模块版本)。
  • group: 命令所属的功能组。 可能的值为:
    • bitmap
    • cluster
    • connection
    • generic
    • geo
    • hash
    • hyperloglog
    • list
    • module
    • pubsub
    • scripting
    • sentinel
    • server
    • set
    • sorted-set
    • stream
    • string
    • transactions
  • 复杂度: 关于命令时间复杂度的简短解释。
  • doc_flags: 一个文档标志的数组。 可能的值为:
    • deprecated: 该命令已被弃用。
    • syscmd: 一个系统命令,不打算由用户调用。
  • deprecated_since: 弃用该命令的Redis版本(或对于模块命令,模块版本)。
  • replaced_by: 已弃用命令的替代方案。
  • 历史记录: 一个描述命令输出或参数更改的历史记录数组。它不应包含行为更改的信息。 每个条目本身也是一个数组,由两个元素组成:
    1. 该条目适用的Redis版本。
    2. 更改的描述。
  • arguments: 描述命令参数的映射数组。 请参阅Redis命令参数页面以获取更多信息。

示例

COMMAND DOCS SET

RESP2 回复

Array reply: a map, as a flattened array, where each key is a command name, and each value is the documentary information.

RESP3 回复

Map reply: a map where each key is a command name, and each value is the documentary information.
RATE THIS PAGE
Back to top ↑