Skip to content

Commit d233679

Browse files
Ben Mansheimbmansheim
authored andcommitted
Update docs for upgrade module parameter changes (#726)
1 parent ea9aad1 commit d233679

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

content/modules/upgrading-rs.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ This causes a short interruption in the availability of this database across the
4949
When you upgrade the module for a database, you can either:
5050

5151
- Specify the module arguments to replace the current arguments.
52-
- Specify the 'keep_module_args' flag to use the current argument.
52+
- Specify the `keep_args` flag to use the current argument.
5353

5454
1. Connect to the terminal of a node in the cluster
5555
1. Run `rladmin status` to list the databases on the node.
@@ -70,27 +70,31 @@ When you upgrade the module for a database, you can either:
7070
1. To upgrade the module for the database, run:
7171

7272
```src
73-
rladmin upgrade module db_name <database_name> module_name <module_name> version <new_module_version_number> module_args <module arguments>
73+
rladmin upgrade db <database_name> and module module_name <module_name> version <new_module_version_number> module_args "<module arguments>"
7474
```
7575
76+
- If you want to remove the existing module arguments, enter `""` without arguments.
77+
- If you want to use the exisintg module arguments, enter `"keep_args"`
78+
- If you want to update multiple modules, use the `and module` parameter for each module.
79+
7680
## Examples
7781
7882
Here are some examples of module upgrades:
7983
80-
- To upgrade the version of RediSearch to 1.6.7:
84+
- To upgrade the version of RediSearch to 1.6.7 and specify arguments:
8185
8286
```src
83-
rladmin upgrade module db_name MyAwesomeDB module_name ft version 10607 module_args "PARTITIONS AUTO"
87+
rladmin upgrade db <database_name> and module db_name MyAwesomeDB module_name ft version 10607 module_args "PARTITIONS AUTO"
8488
```
8589
86-
- To upgrade RedisBloom to version 2.2.1:
90+
- To upgrade RedisBloom to version 2.2.1 and remove arguments:
8791
8892
```src
89-
rladmin upgrade module db_name MyDB module_name bf version 20201 module_args ""
93+
rladmin upgrade db <database_name> and module db_name MyDB module_name bf version 20201 module_args ""
9094
```
9195
92-
- To upgrade RedisJSON to 1.0.4:
96+
- To upgrade RedisJSON to 1.0.4 and keep existing arguments and RedisBloom to version 2.2.1 and remove arguments:
9397
9498
```src
95-
rladmin upgrade module db_name MyDB module_name ReJSON version 10004 module_args ""
99+
rladmin upgrade module db_name MyDB module_name ReJSON version 10004 module_args "keep_args" and module db_name MyDB module_name bf version 20201 module_args ""
96100
```

0 commit comments

Comments
 (0)