blob: 35ea017f2ac8bc9466f6bc2f1b72f19507279b83 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
Return documentary information about commands.
By default, the reply includes all of the server's commands.
You can use the optional _command-name_ argument to specify the names of one or more commands.
The reply includes a map for each returned command.
The following keys may be included in the mapped reply:
* **summary:** short command description.
* **since:** the Redis version that added the command (or for module commands, the module version).
* **group:** the functional group to which the command belongs.
Possible values are:
- _bitmap_
- _cluster_
- _connection_
- _generic_
- _geo_
- _hash_
- _hyperloglog_
- _list_
- _module_
- _pubsub_
- _scripting_
- _sentinel_
- _server_
- _set_
- _sorted-set_
- _stream_
- _string_
- _transactions_
* **complexity:** a short explanation about the command's time complexity.
* **doc_flags:** an array of documentation flags.
Possible values are:
- _deprecated:_ the command is deprecated.
- _syscmd:_ a system command that isn't meant to be called by users.
* **deprecated_since:** the Redis version that deprecated the command (or for module commands, the module version)..
* **replaced_by:** the alternative for a deprecated command.
* **history:** an array of historical notes describing changes to the command's behavior or arguments.
Each entry is an array itself, made up of two elements:
1. The Redis version that the entry applies to.
2. The description of the change.
* **arguments:** an array of maps that describe the command's arguments.
Please refer to the [Redis command arguments][td] page for more information.
[td]: /topics/command-arguments
@return
@array-reply: a map as a flattened array as described above.
@examples
```cli
COMMAND DOCS SET
```
|
