Skip to content

Commit e1322e5

Browse files
committed
docs:update
1 parent 311512f commit e1322e5

File tree

17 files changed

+430
-430
lines changed

17 files changed

+430
-430
lines changed

docs/supported-commands/Redis/CLUSTER.md

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -2,132 +2,132 @@
22
## Unsupported cluster commands
33
> To implement support for a command, see [here](/guides/implement-command/)
44
5-
#### [ASKING](https://redis.io/commands/asking/) <small>(not implemented)</small>
6-
7-
Signals that a cluster client is following an -ASK redirect.
8-
9-
#### [CLUSTER](https://redis.io/commands/cluster/) <small>(not implemented)</small>
10-
11-
A container for Redis Cluster commands.
12-
135
#### [CLUSTER ADDSLOTS](https://redis.io/commands/cluster-addslots/) <small>(not implemented)</small>
146

157
Assigns new hash slots to a node.
168

17-
#### [CLUSTER ADDSLOTSRANGE](https://redis.io/commands/cluster-addslotsrange/) <small>(not implemented)</small>
9+
#### [CLUSTER HELP](https://redis.io/commands/cluster-help/) <small>(not implemented)</small>
1810

19-
Assigns new hash slot ranges to a node.
11+
Returns helpful text about the different subcommands.
2012

21-
#### [CLUSTER BUMPEPOCH](https://redis.io/commands/cluster-bumpepoch/) <small>(not implemented)</small>
13+
#### [CLUSTER INFO](https://redis.io/commands/cluster-info/) <small>(not implemented)</small>
2214

23-
Advances the cluster config epoch.
15+
Returns information about the state of a node.
2416

25-
#### [CLUSTER COUNT-FAILURE-REPORTS](https://redis.io/commands/cluster-count-failure-reports/) <small>(not implemented)</small>
17+
#### [CLUSTER KEYSLOT](https://redis.io/commands/cluster-keyslot/) <small>(not implemented)</small>
2618

27-
Returns the number of active failure reports active for a node.
19+
Returns the hash slot for a key.
2820

29-
#### [CLUSTER COUNTKEYSINSLOT](https://redis.io/commands/cluster-countkeysinslot/) <small>(not implemented)</small>
21+
#### [CLUSTER BUMPEPOCH](https://redis.io/commands/cluster-bumpepoch/) <small>(not implemented)</small>
3022

31-
Returns the number of keys in a hash slot.
23+
Advances the cluster config epoch.
3224

33-
#### [CLUSTER DELSLOTS](https://redis.io/commands/cluster-delslots/) <small>(not implemented)</small>
25+
#### [CLUSTER GETKEYSINSLOT](https://redis.io/commands/cluster-getkeysinslot/) <small>(not implemented)</small>
3426

35-
Sets hash slots as unbound for a node.
27+
Returns the key names in a hash slot.
3628

37-
#### [CLUSTER DELSLOTSRANGE](https://redis.io/commands/cluster-delslotsrange/) <small>(not implemented)</small>
29+
#### [ASKING](https://redis.io/commands/asking/) <small>(not implemented)</small>
3830

39-
Sets hash slot ranges as unbound for a node.
31+
Signals that a cluster client is following an -ASK redirect.
4032

41-
#### [CLUSTER FAILOVER](https://redis.io/commands/cluster-failover/) <small>(not implemented)</small>
33+
#### [CLUSTER RESET](https://redis.io/commands/cluster-reset/) <small>(not implemented)</small>
4234

43-
Forces a replica to perform a manual failover of its master.
35+
Resets a node.
4436

45-
#### [CLUSTER FLUSHSLOTS](https://redis.io/commands/cluster-flushslots/) <small>(not implemented)</small>
37+
#### [CLUSTER SAVECONFIG](https://redis.io/commands/cluster-saveconfig/) <small>(not implemented)</small>
4638

47-
Deletes all slots information from a node.
39+
Forces a node to save the cluster configuration to disk.
4840

49-
#### [CLUSTER FORGET](https://redis.io/commands/cluster-forget/) <small>(not implemented)</small>
41+
#### [CLUSTER REPLICATE](https://redis.io/commands/cluster-replicate/) <small>(not implemented)</small>
5042

51-
Removes a node from the nodes table.
43+
Configure a node as replica of a master node.
5244

53-
#### [CLUSTER GETKEYSINSLOT](https://redis.io/commands/cluster-getkeysinslot/) <small>(not implemented)</small>
45+
#### [CLUSTER COUNTKEYSINSLOT](https://redis.io/commands/cluster-countkeysinslot/) <small>(not implemented)</small>
5446

55-
Returns the key names in a hash slot.
47+
Returns the number of keys in a hash slot.
5648

57-
#### [CLUSTER HELP](https://redis.io/commands/cluster-help/) <small>(not implemented)</small>
49+
#### [CLUSTER SETSLOT](https://redis.io/commands/cluster-setslot/) <small>(not implemented)</small>
5850

59-
Returns helpful text about the different subcommands.
51+
Binds a hash slot to a node.
6052

61-
#### [CLUSTER INFO](https://redis.io/commands/cluster-info/) <small>(not implemented)</small>
53+
#### [CLUSTER NODES](https://redis.io/commands/cluster-nodes/) <small>(not implemented)</small>
6254

63-
Returns information about the state of a node.
55+
Returns the cluster configuration for a node.
6456

65-
#### [CLUSTER KEYSLOT](https://redis.io/commands/cluster-keyslot/) <small>(not implemented)</small>
57+
#### [CLUSTER FAILOVER](https://redis.io/commands/cluster-failover/) <small>(not implemented)</small>
6658

67-
Returns the hash slot for a key.
59+
Forces a replica to perform a manual failover of its master.
6860

6961
#### [CLUSTER LINKS](https://redis.io/commands/cluster-links/) <small>(not implemented)</small>
7062

7163
Returns a list of all TCP links to and from peer nodes.
7264

73-
#### [CLUSTER MEET](https://redis.io/commands/cluster-meet/) <small>(not implemented)</small>
65+
#### [CLUSTER SET-CONFIG-EPOCH](https://redis.io/commands/cluster-set-config-epoch/) <small>(not implemented)</small>
7466

75-
Forces a node to handshake with another node.
67+
Sets the configuration epoch for a new node.
7668

77-
#### [CLUSTER MYID](https://redis.io/commands/cluster-myid/) <small>(not implemented)</small>
69+
#### [CLUSTER DELSLOTSRANGE](https://redis.io/commands/cluster-delslotsrange/) <small>(not implemented)</small>
7870

79-
Returns the ID of a node.
71+
Sets hash slot ranges as unbound for a node.
8072

81-
#### [CLUSTER MYSHARDID](https://redis.io/commands/cluster-myshardid/) <small>(not implemented)</small>
73+
#### [CLUSTER SLOTS](https://redis.io/commands/cluster-slots/) <small>(not implemented)</small>
8274

83-
Returns the shard ID of a node.
75+
Returns the mapping of cluster slots to nodes.
8476

85-
#### [CLUSTER NODES](https://redis.io/commands/cluster-nodes/) <small>(not implemented)</small>
77+
#### [CLUSTER COUNT-FAILURE-REPORTS](https://redis.io/commands/cluster-count-failure-reports/) <small>(not implemented)</small>
8678

87-
Returns the cluster configuration for a node.
79+
Returns the number of active failure reports active for a node.
8880

89-
#### [CLUSTER REPLICAS](https://redis.io/commands/cluster-replicas/) <small>(not implemented)</small>
81+
#### [CLUSTER SHARDS](https://redis.io/commands/cluster-shards/) <small>(not implemented)</small>
9082

91-
Lists the replica nodes of a master node.
83+
Returns the mapping of cluster slots to shards.
9284

93-
#### [CLUSTER REPLICATE](https://redis.io/commands/cluster-replicate/) <small>(not implemented)</small>
85+
#### [CLUSTER DELSLOTS](https://redis.io/commands/cluster-delslots/) <small>(not implemented)</small>
9486

95-
Configure a node as replica of a master node.
87+
Sets hash slots as unbound for a node.
9688

97-
#### [CLUSTER RESET](https://redis.io/commands/cluster-reset/) <small>(not implemented)</small>
89+
#### [CLUSTER FLUSHSLOTS](https://redis.io/commands/cluster-flushslots/) <small>(not implemented)</small>
9890

99-
Resets a node.
91+
Deletes all slots information from a node.
10092

101-
#### [CLUSTER SAVECONFIG](https://redis.io/commands/cluster-saveconfig/) <small>(not implemented)</small>
93+
#### [CLUSTER MYSHARDID](https://redis.io/commands/cluster-myshardid/) <small>(not implemented)</small>
10294

103-
Forces a node to save the cluster configuration to disk.
95+
Returns the shard ID of a node.
10496

105-
#### [CLUSTER SET-CONFIG-EPOCH](https://redis.io/commands/cluster-set-config-epoch/) <small>(not implemented)</small>
97+
#### [READONLY](https://redis.io/commands/readonly/) <small>(not implemented)</small>
10698

107-
Sets the configuration epoch for a new node.
99+
Enables read-only queries for a connection to a Redis Cluster replica node.
108100

109-
#### [CLUSTER SETSLOT](https://redis.io/commands/cluster-setslot/) <small>(not implemented)</small>
101+
#### [CLUSTER REPLICAS](https://redis.io/commands/cluster-replicas/) <small>(not implemented)</small>
110102

111-
Binds a hash slot to a node.
103+
Lists the replica nodes of a master node.
112104

113-
#### [CLUSTER SHARDS](https://redis.io/commands/cluster-shards/) <small>(not implemented)</small>
105+
#### [READWRITE](https://redis.io/commands/readwrite/) <small>(not implemented)</small>
114106

115-
Returns the mapping of cluster slots to shards.
107+
Enables read-write queries for a connection to a Reids Cluster replica node.
108+
109+
#### [CLUSTER ADDSLOTSRANGE](https://redis.io/commands/cluster-addslotsrange/) <small>(not implemented)</small>
110+
111+
Assigns new hash slot ranges to a node.
116112

117113
#### [CLUSTER SLAVES](https://redis.io/commands/cluster-slaves/) <small>(not implemented)</small>
118114

119115
Lists the replica nodes of a master node.
120116

121-
#### [CLUSTER SLOTS](https://redis.io/commands/cluster-slots/) <small>(not implemented)</small>
117+
#### [CLUSTER FORGET](https://redis.io/commands/cluster-forget/) <small>(not implemented)</small>
122118

123-
Returns the mapping of cluster slots to nodes.
119+
Removes a node from the nodes table.
124120

125-
#### [READONLY](https://redis.io/commands/readonly/) <small>(not implemented)</small>
121+
#### [CLUSTER MEET](https://redis.io/commands/cluster-meet/) <small>(not implemented)</small>
126122

127-
Enables read-only queries for a connection to a Redis Cluster replica node.
123+
Forces a node to handshake with another node.
128124

129-
#### [READWRITE](https://redis.io/commands/readwrite/) <small>(not implemented)</small>
125+
#### [CLUSTER](https://redis.io/commands/cluster/) <small>(not implemented)</small>
130126

131-
Enables read-write queries for a connection to a Reids Cluster replica node.
127+
A container for Redis Cluster commands.
128+
129+
#### [CLUSTER MYID](https://redis.io/commands/cluster-myid/) <small>(not implemented)</small>
130+
131+
Returns the ID of a node.
132132

133133

docs/supported-commands/Redis/CONNECTION.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,9 @@ Changes the selected database.
4444
## Unsupported connection commands
4545
> To implement support for a command, see [here](/guides/implement-command/)
4646
47-
#### [CLIENT](https://redis.io/commands/client/) <small>(not implemented)</small>
48-
49-
A container for client connection commands.
50-
51-
#### [CLIENT CACHING](https://redis.io/commands/client-caching/) <small>(not implemented)</small>
52-
53-
Instructs the server whether to track the keys in the next request.
54-
55-
#### [CLIENT GETREDIR](https://redis.io/commands/client-getredir/) <small>(not implemented)</small>
56-
57-
Returns the client ID to which the connection's tracking notifications are redirected.
58-
59-
#### [CLIENT KILL](https://redis.io/commands/client-kill/) <small>(not implemented)</small>
47+
#### [CLIENT NO-TOUCH](https://redis.io/commands/client-no-touch/) <small>(not implemented)</small>
6048

61-
Terminates open connections.
49+
Controls whether commands sent by the client affect the LRU/LFU of accessed keys.
6250

6351
#### [CLIENT LIST](https://redis.io/commands/client-list/) <small>(not implemented)</small>
6452

@@ -68,36 +56,48 @@ Lists open connections.
6856

6957
Sets the client eviction mode of the connection.
7058

71-
#### [CLIENT NO-TOUCH](https://redis.io/commands/client-no-touch/) <small>(not implemented)</small>
59+
#### [CLIENT TRACKINGINFO](https://redis.io/commands/client-trackinginfo/) <small>(not implemented)</small>
7260

73-
Controls whether commands sent by the client affect the LRU/LFU of accessed keys.
61+
Returns information about server-assisted client-side caching for the connection.
7462

7563
#### [CLIENT PAUSE](https://redis.io/commands/client-pause/) <small>(not implemented)</small>
7664

7765
Suspends commands processing.
7866

79-
#### [CLIENT REPLY](https://redis.io/commands/client-reply/) <small>(not implemented)</small>
80-
81-
Instructs the server whether to reply to commands.
82-
83-
#### [CLIENT TRACKING](https://redis.io/commands/client-tracking/) <small>(not implemented)</small>
67+
#### [CLIENT GETREDIR](https://redis.io/commands/client-getredir/) <small>(not implemented)</small>
8468

85-
Controls server-assisted client-side caching for the connection.
69+
Returns the client ID to which the connection's tracking notifications are redirected.
8670

87-
#### [CLIENT TRACKINGINFO](https://redis.io/commands/client-trackinginfo/) <small>(not implemented)</small>
71+
#### [RESET](https://redis.io/commands/reset/) <small>(not implemented)</small>
8872

89-
Returns information about server-assisted client-side caching for the connection.
73+
Resets the connection.
9074

9175
#### [CLIENT UNBLOCK](https://redis.io/commands/client-unblock/) <small>(not implemented)</small>
9276

9377
Unblocks a client blocked by a blocking command from a different connection.
9478

79+
#### [CLIENT CACHING](https://redis.io/commands/client-caching/) <small>(not implemented)</small>
80+
81+
Instructs the server whether to track the keys in the next request.
82+
83+
#### [CLIENT](https://redis.io/commands/client/) <small>(not implemented)</small>
84+
85+
A container for client connection commands.
86+
87+
#### [CLIENT KILL](https://redis.io/commands/client-kill/) <small>(not implemented)</small>
88+
89+
Terminates open connections.
90+
91+
#### [CLIENT TRACKING](https://redis.io/commands/client-tracking/) <small>(not implemented)</small>
92+
93+
Controls server-assisted client-side caching for the connection.
94+
9595
#### [CLIENT UNPAUSE](https://redis.io/commands/client-unpause/) <small>(not implemented)</small>
9696

9797
Resumes processing commands from paused clients.
9898

99-
#### [RESET](https://redis.io/commands/reset/) <small>(not implemented)</small>
99+
#### [CLIENT REPLY](https://redis.io/commands/client-reply/) <small>(not implemented)</small>
100100

101-
Resets the connection.
101+
Instructs the server whether to reply to commands.
102102

103103

docs/supported-commands/Redis/GENERIC.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,14 @@ Asynchronously deletes one or more keys.
9696
## Unsupported generic commands
9797
> To implement support for a command, see [here](/guides/implement-command/)
9898
99-
#### [COPY](https://redis.io/commands/copy/) <small>(not implemented)</small>
100-
101-
Copies the value of a key to a new key.
102-
10399
#### [WAIT](https://redis.io/commands/wait/) <small>(not implemented)</small>
104100

105101
Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed.
106102

103+
#### [COPY](https://redis.io/commands/copy/) <small>(not implemented)</small>
104+
105+
Copies the value of a key to a new key.
106+
107107
#### [WAITAOF](https://redis.io/commands/waitaof/) <small>(not implemented)</small>
108108

109109
Blocks until all of the preceding write commands sent by the connection are written to the append-only file of the master and/or replicas.

docs/supported-commands/Redis/GEO.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Returns the longitude and latitude of members from a geospatial index.
2020

2121
Queries a geospatial index for members within a distance from a coordinate, optionally stores the result.
2222

23+
## [GEORADIUS_RO](https://redis.io/commands/georadius_ro/)
24+
25+
Returns members from a geospatial index that are within a distance from a coordinate.
26+
2327
## [GEORADIUSBYMEMBER](https://redis.io/commands/georadiusbymember/)
2428

2529
Queries a geospatial index for members within a distance from a member, optionally stores the result.
@@ -28,10 +32,6 @@ Queries a geospatial index for members within a distance from a member, optional
2832

2933
Returns members from a geospatial index that are within a distance from a member.
3034

31-
## [GEORADIUS_RO](https://redis.io/commands/georadius_ro/)
32-
33-
Returns members from a geospatial index that are within a distance from a coordinate.
34-
3535
## [GEOSEARCH](https://redis.io/commands/geosearch/)
3636

3737
Queries a geospatial index for members inside an area of a box or a circle.

docs/supported-commands/Redis/HASH.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,11 @@ Returns all values in a hash.
104104
## Unsupported hash commands
105105
> To implement support for a command, see [here](/guides/implement-command/)
106106
107-
#### [HGETF](https://redis.io/commands/hgetf/) <small>(not implemented)</small>
107+
#### [HSETF](https://redis.io/commands/hsetf/) <small>(not implemented)</small>
108108

109109
For each specified field, returns its value and optionally set the field's remaining expiration time in seconds / milliseconds
110110

111-
#### [HSETF](https://redis.io/commands/hsetf/) <small>(not implemented)</small>
111+
#### [HGETF](https://redis.io/commands/hgetf/) <small>(not implemented)</small>
112112

113113
For each specified field, returns its value and optionally set the field's remaining expiration time in seconds / milliseconds
114114

0 commit comments

Comments
 (0)