Skip to content

Commit 603bb7d

Browse files
authored
chore: CLIENT HELP doc added (#453)
* chore: CLIENT HELP doc added * fix: review comments
1 parent 2da5c39 commit 603bb7d

File tree

2 files changed

+81
-0
lines changed

2 files changed

+81
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
description: Learn how to use Redis CLIENT HELP command to list all CLIENT subcommands and their descriptions.
3+
---
4+
5+
import PageTitle from '@site/src/components/PageTitle';
6+
7+
# CLIENT HELP
8+
9+
<PageTitle title="Redis CLIENT HELP Command (Documentation) | Dragonfly" />
10+
11+
## Syntax
12+
13+
CLIENT HELP
14+
15+
**Time complexity:** O(1)
16+
17+
**ACL categories:** @slow
18+
19+
The `CLIENT HELP` command returns a helpful text describing the different `CLIENT` subcommands supported by Dragonfly.
20+
21+
## Return
22+
23+
[Array reply](https://redis.io/docs/latest/develop/reference/protocol-spec/#arrays): a list of subcommands and their descriptions.
24+
25+
## Example
26+
27+
The output of the `CLIENT HELP` command includes entries similar to the following (as implemented in Dragonfly):
28+
29+
```shell
30+
dragonfly> CLIENT HELP
31+
1) CLIENT <subcommand> [<arg> [value] [opt] ...]. Subcommands are:
32+
2) CACHING (YES|NO)
33+
3) Enable/disable tracking of the keys for next command in OPTIN/OPTOUT modes.
34+
4) GETNAME
35+
5) Return the name of the current connection.
36+
6) ID
37+
7) Return the ID of the current connection.
38+
8) KILL <ip:port>
39+
9) Kill connection made from <ip:port>.
40+
10) KILL <option> <value> [<option> <value> [...]]
41+
11) Kill connections. Options are:
42+
12) * ADDR (<ip:port>|<unixsocket>:0)
43+
13) Kill connections made from the specified address
44+
14) * LADDR (<ip:port>|<unixsocket>:0)
45+
15) Kill connections made to specified local address
46+
16) * ID <client-id>
47+
17) Kill connections by client id.
48+
18) LIST
49+
19) Return information about client connections.
50+
20) UNPAUSE
51+
21) Stop the current client pause, resuming traffic.
52+
22) PAUSE <timeout> [WRITE|ALL]
53+
23) Suspend all, or just write, clients for <timeout> milliseconds.
54+
24) SETNAME <name>
55+
25) Assign the name <name> to the current connection.
56+
26) SETINFO <option> <value>
57+
27) Set client meta attr. Options are:
58+
28) * LIB-NAME: the client lib name.
59+
29) * LIB-VER: the client lib version.
60+
30) TRACKING (ON|OFF) [OPTIN] [OPTOUT] [NOLOOP]
61+
31) Control server assisted client side caching.
62+
32) MIGRATE <client-id> <tid>
63+
33) Migrates connection specified by client-id to the specified thread id.
64+
34) HELP
65+
35) Print this help.
66+
```

docs/command-reference/server-management/client.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,19 @@ import PageTitle from '@site/src/components/PageTitle';
1616

1717
This is a container command for client connection commands.
1818

19+
Currently, the following subcommands are supported:
20+
21+
- CLIENT CACHING
22+
- [CLIENT GETNAME](./client-getname.md)
23+
- [CLIENT ID](./client-id.md)
24+
- [CLIENT KILL](./client-kill.md)
25+
- [CLIENT LIST](./client-list.md)
26+
- [CLIENT UNPAUSE](./client-unpause.md)
27+
- [CLIENT PAUSE](./client-pause.md)
28+
- [CLIENT SETNAME](./client-setname.md)
29+
- [CLIENT SETINFO](./client-setinfo.md)
30+
- [CLIENT TRACKING](./client-tracking.md)
31+
- CLIENT MIGRATE
32+
- [CLIENT HELP](./client-help.md)
33+
1934
<!-- To see the list of available commands you can call `CLIENT HELP`. -->

0 commit comments

Comments
 (0)