-
Notifications
You must be signed in to change notification settings - Fork 24
chore: CLIENT HELP doc added #453
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
description: Learn how to use Redis CLIENT HELP command to list all CLIENT subcommands and their descriptions. | ||
--- | ||
|
||
import PageTitle from '@site/src/components/PageTitle'; | ||
|
||
# CLIENT HELP | ||
|
||
<PageTitle title="Redis CLIENT HELP Command (Documentation) | Dragonfly" /> | ||
|
||
## Syntax | ||
|
||
CLIENT HELP | ||
|
||
**Time complexity:** O(1) | ||
|
||
**ACL categories:** @slow | ||
|
||
The `CLIENT HELP` command returns a helpful text describing the different `CLIENT` subcommands supported by Dragonfly. | ||
|
||
## Return | ||
|
||
[Array reply](https://redis.io/docs/latest/develop/reference/protocol-spec/#arrays): a list of subcommands and their descriptions. | ||
|
||
## Example | ||
|
||
The output of the `CLIENT HELP` command includes entries similar to the following (as implemented in Dragonfly): | ||
|
||
```shell | ||
dragonfly> CLIENT HELP | ||
1) CLIENT <subcommand> [<arg> [value] [opt] ...]. Subcommands are: | ||
2) CACHING (YES|NO) | ||
3) Enable/disable tracking of the keys for next command in OPTIN/OPTOUT modes. | ||
4) GETNAME | ||
5) Return the name of the current connection. | ||
6) ID | ||
7) Return the ID of the current connection. | ||
8) KILL <ip:port> | ||
9) Kill connection made from <ip:port>. | ||
10) KILL <option> <value> [<option> <value> [...]] | ||
11) Kill connections. Options are: | ||
12) * ADDR (<ip:port>|<unixsocket>:0) | ||
13) Kill connections made from the specified address | ||
14) * LADDR (<ip:port>|<unixsocket>:0) | ||
15) Kill connections made to specified local address | ||
16) * ID <client-id> | ||
17) Kill connections by client id. | ||
18) LIST | ||
19) Return information about client connections. | ||
20) UNPAUSE | ||
21) Stop the current client pause, resuming traffic. | ||
22) PAUSE <timeout> [WRITE|ALL] | ||
23) Suspend all, or just write, clients for <timeout> milliseconds. | ||
24) SETNAME <name> | ||
25) Assign the name <name> to the current connection. | ||
26) SETINFO <option> <value> | ||
27) Set client meta attr. Options are: | ||
28) * LIB-NAME: the client lib name. | ||
29) * LIB-VER: the client lib version. | ||
30) TRACKING (ON|OFF) [OPTIN] [OPTOUT] [NOLOOP] | ||
31) Control server assisted client side caching. | ||
32) MIGRATE <client-id> <tid> | ||
33) Migrates connection specified by client-id to the specified thread id. | ||
34) HELP | ||
35) Print this help. | ||
``` | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,4 +16,8 @@ import PageTitle from '@site/src/components/PageTitle'; | |
|
||
This is a container command for client connection commands. | ||
|
||
<!-- To see the list of available commands you can call `CLIENT HELP`. --> | ||
<!-- To see the list of available commands you can call `CLIENT HELP`. --> | ||
|
||
## See also | ||
|
||
- [`CLIENT HELP`](./client-help.md) | ||
|
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please re-copy the output of this command, which doesn't need HTML encoding.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed