Upgrade modules

Upgrade a module in Redis Enterprise to get the latest features and fixes.

Prerequisites

Before you upgrade a module enabled in a database, install the new version of the module on the cluster.

Upgrade a module for a database

After you install an updated module on the cluster, you can upgrade databases to use the new module version.

To upgrade a module enabled for a database:

1. Connect to the terminal of a node in the cluster.

2. Run rladmin status to list the databases on the node.

3. Copy the name of the database that uses the module that you want to upgrade.

4. Find the exact module name and version:

   1. Extract the module archive (zip) file.
   2. Open the JSON file.
   3. Find the module name and version number in the file.

   Here's an example of the JSON file for the RediSearch module:

5. To see the versions of the modules on the cluster, run either:

   • rladmin status modules - Shows the latest modules available on the cluster and the modules used by databases.
   • rladmin status modules all - Shows all of the modules available on the cluster and the modules used by databases.

6. To upgrade a database to the latest version of Redis and its modules to the latest version without changing the module arguments:

   • For clusters with Redis Enterprise Software versions 7.8.2 or later, run:

     rladmin upgrade db < database-name | database-ID >
     

   • For clusters with versions earlier than 7.8.2, include the latest_with_modules option:

     rladmin upgrade db < database-name | database-ID > latest_with_modules
     

   Warning:

   The upgrade process does not validate the module upgrade arguments, and incorrect arguments can cause unexpected downtime. Test module upgrade commands in a test environment before you upgrade modules in production.

   • Use keep_redis_version to upgrade the modules without upgrading the database to the latest Redis version.

     keep_redis_version is deprecated as of Redis Enterprise Software version 7.8.2. To upgrade modules without upgrading the Redis database version, set redis_version to the current Redis database version instead.

   • To specify the modules to upgrade, add the following for each module:

     and module module_name <module_name> version <new_module_version_number> module_args "<module arguments>"
     

     For the module arguments, use one of the following:

     • module_args "<module_arguments>" to replace the existing module arguments.

     • module_args "" without arguments to remove the existing module arguments.

     • module_args keep_args to use the existing module arguments.

Examples for Redis Software v7.8.2 and later

The following module upgrade examples are supported for Redis Enterprise Software versions 7.8.2 and later:

• Keep the current Redis database version, which is 7.2 in this example, and upgrade to the latest version of the enabled modules:

  rladmin upgrade db shopping-cart redis_version 7.2
  

• Upgrade the database to use the latest version of Redis and the latest versions of the enabled modules:

  rladmin upgrade db shopping-cart
  

Deprecated examples

As of Redis Enterprise Software version 7.8.2, the following module upgrade examples are deprecated but still supported.

• Keep the current version of Redis and upgrade to the latest version of the enabled modules:

  rladmin upgrade db shopping-cart keep_redis_version latest_with_modules
  

• Upgrade the database to the latest Redis version and upgrade RediSearch to 1.6.7 with the specified arguments:

  rladmin upgrade db shopping-cart and module db_name shopping-cart module_name ft version 10607 module_args "PARTITIONS AUTO"
  

• Upgrade the database to the latest Redis version and upgrade RedisBloom to version 2.2.1 without arguments:

  rladmin upgrade db db:3 and module db_name shopping-cart module_name bf version 20201 module_args ""
  

• Upgrade RedisJSON to 1.0.4 with the existing arguments and RedisBloom to version 2.2.1 without arguments:

  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 ""
  

• Upgrade the database to use the latest version of Redis and use the latest version of the enabled modules:

  rladmin upgrade db shopping-cart latest_with_modules