Skip to content

Commit 45461b8

Browse files
authored
DOC-5650 RS: Fixed outdated rladmin commands for shard placement (#2138)
1 parent 16789e0 commit 45461b8

File tree

6 files changed

+14
-2
lines changed

6 files changed

+14
-2
lines changed

content/operate/rs/7.8/databases/configure/shard-placement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,5 @@ To see the shard placement policy for a database in `rladmin status`.
4040
To change the shard placement policy for a database, run:
4141

4242
```sh
43-
rladmin placement db [ database name | database ID ] [ dense | sparse ]
43+
rladmin tune db { db:<ID> | <database-name> } shards_placement { dense | sparse }
4444
```

content/operate/rs/7.8/references/cli-utilities/rladmin/placement.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ rladmin placement
2121
{ dense | sparse }
2222
```
2323
24+
{{< note >}}
25+
`rladmin placement db` is deprecated and will be removed in a future version. Use [`rladmin tune db`]({{< relref "/operate/rs/7.8/references/cli-utilities/rladmin/tune#tune-db" >}}) with the `shards_placement` parameter instead.
26+
{{< /note >}}
27+
2428
### Parameters
2529
2630
| Parameter | Type/Value | Description |

content/operate/rs/7.8/references/cli-utilities/rladmin/tune.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,7 @@ rladmin tune db { db:<id> | <name> }
149149
[ data_internode_encryption { enabled | disabled } ]
150150
[ db_conns_auditing { enabled | disabled } ]
151151
[ resp3 { enabled | disabled } ]
152+
[ shards_placement { dense | sparse } ]
152153
[ tracking_table_max_keys <size> ]
153154
```
154155
@@ -189,6 +190,7 @@ rladmin tune db { db:<id> | <name> }
189190
| repl_timeout | time in seconds | Replication timeout (in seconds) |
190191
| resp3 | `enabled`<br /> `disabled` | Enables or deactivates RESP3 support (defaults to `enabled`) |
191192
| schedpolicy | `cmp`<br /> `mru`<br /> `spread`<br /> `mnp` | Controls how server-side connections are used when forwarding traffic to shards |
193+
| shards_placement | `dense`<br /> `sparse` | Configures the [shard placement policy]({{< relref "/operate/rs/7.8/databases/memory-performance/shard-placement-policy" >}}) for the database |
192194
| skip_import_analyze | `enabled`<br /> `disabled` | Skips the analyzing step when importing a database |
193195
| slave_buffer | `auto`<br />value in MB<br /> hard:soft:time | Redis replica output buffer limits<br />`auto`: dynamically adjusts the buffer limit based on the shard’s current used memory<br />• value in MB: sets the buffer limit in MB<br />• hard:soft:time: sets the hard limit (maximum buffer size in MB), soft limit in MB, and the time in seconds that the soft limit can be exceeded |
194196
| slave_ha | `enabled`<br /> `disabled` | Activates or deactivates replica high availability (defaults to the cluster setting) |

content/operate/rs/databases/configure/shard-placement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,5 +39,5 @@ To see the shard placement policy for a database in `rladmin status`.
3939
To change the shard placement policy for a database, run:
4040

4141
```sh
42-
rladmin placement db [ database name | database ID ] [ dense | sparse ]
42+
rladmin tune db { db:<ID> | <database-name> } shards_placement { dense | sparse }
4343
```

content/operate/rs/references/cli-utilities/rladmin/placement.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ rladmin placement
2020
{ dense | sparse }
2121
```
2222
23+
{{< note >}}
24+
`rladmin placement db` is deprecated and will be removed in a future version. Use [`rladmin tune db`]({{< relref "/operate/rs/references/cli-utilities/rladmin/tune#tune-db" >}}) with the `shards_placement` parameter instead.
25+
{{< /note >}}
26+
2327
### Parameters
2428
2529
| Parameter | Type/Value | Description |

content/operate/rs/references/cli-utilities/rladmin/tune.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ rladmin tune db { db:<id> | <name> }
148148
[ data_internode_encryption { enabled | disabled } ]
149149
[ db_conns_auditing { enabled | disabled } ]
150150
[ resp3 { enabled | disabled } ]
151+
[ shards_placement { dense | sparse } ]
151152
[ tracking_table_max_keys <size> ]
152153
```
153154
@@ -188,6 +189,7 @@ rladmin tune db { db:<id> | <name> }
188189
| repl_timeout | time in seconds | Replication timeout (in seconds) |
189190
| resp3 | `enabled`<br /> `disabled` | Enables or deactivates RESP3 support (defaults to `enabled`) |
190191
| schedpolicy | `cmp`<br /> `mru`<br /> `spread`<br /> `mnp` | Controls how server-side connections are used when forwarding traffic to shards |
192+
| shards_placement | `dense`<br /> `sparse` | Configures the [shard placement policy]({{< relref "/operate/rs/databases/memory-performance/shard-placement-policy" >}}) for the database |
191193
| skip_import_analyze | `enabled`<br /> `disabled` | Skips the analyzing step when importing a database |
192194
| slave_buffer | `auto`<br />value in MB<br /> hard:soft:time | Redis replica output buffer limits<br />`auto`: dynamically adjusts the buffer limit based on the shard’s current used memory<br />• value in MB: sets the buffer limit in MB<br />• hard:soft:time: sets the hard limit (maximum buffer size in MB), soft limit in MB, and the time in seconds that the soft limit can be exceeded |
193195
| slave_ha | `enabled`<br /> `disabled` | Activates or deactivates replica high availability (defaults to the cluster setting) |

0 commit comments

Comments
 (0)