You can use the restore mode of the redis-shake tool to migrate data from ApsaraDB for Redis to on-premises Redis through a backup file.

Prerequisites

  • An on-premises Redis instance is created as the destination of data migration.
  • The 64-bit Linux operating system is running on the server for running the redis-shake tool.
  • The Linux server can access the on-premises Redis instance.
  • The data of the source ApsaraDB for Redis instance is backed up in the console. For more information, see Back up and recover data in the console.

Download a backup file in the ApsaraDB for Redis console

  1. Log on to the ApsaraDB for Redis console.
  2. In the top navigation bar, select the region where the instance resides.
  3. On the Instance List page, find the target instance. Then, click the instance ID or click Manage in the Actions column.
  4. In the left-side navigation pane, click Backup and Recovery.
  5. On the Backup and Recovery page, find the backup file to migrate and click Download in the Actions column.
    Note A backup file is generated for each node of an ApsaraDB for Redis cluster.

Download the redis-shake tool

Download the redis-shake tool.

Note We recommend that you download the latest version.

Run the following command to decompress the redis-shake.tar.gz package:

# tar -xvf redis-shake.tar.gz
Note In the decompressed folder, the redis-shake file is a binary file that can run in the 64-bit Linux operating system. The redis-shake.conf file is the configuration file of the redis-shake tool. You must modify this configuration file in the next step.

Use a backup file to migrate data

  1. Modify the redis-shake.conf file. The following table describes the parameters for the restore mode of the redis-shake tool.
    Table 1. Parameters for the restore mode of the redis-shake tool
    Parameter Description Example
    rdb.input The path of the RDB file. You can specify either a relative path or an absolute path. /root/tools/RedisShake/demo.rdb
    target.address The endpoint and port of the destination on-premises Redis instance. r-bp1xxxxxxxxxxxxx.redis.rds.aliyuncs.com:6379
    target.password_raw The password of the destination on-premises Redis instance. TargetPass233
    Note If you use a database account other than the default database account to connect to the on-premises Redis instance, set this parameter in the following format: account:password.
    target.db The database to which the data is recovered in the destination on-premises Redis instance. Default value: 0. For example, to recover the data of the source ApsaraDB for Redis instance to DB10 of the destination on-premises Redis instance, set this parameter to 10. If you set this parameter to a value less than 0, data is recovered to DB0. 0
    rewrite Specifies whether to overwrite the existing keys that are identical to those in the RDB file. Valid values:
    • true
    • false
    Note Default value: true. We recommend that you back up the valid data of the destination on-premises Redis instance before migration. If you set this parameter to false and any keys are duplicate in the source and destination databases, an error message is returned.
    true
    parallel The number of concurrent threads used to synchronize the RDB file. More concurrent threads improve synchronization performance.
    Note
    • Minimum value: 1.
    • Maximum value: depends on the server performance.
    • Recommended value: 64.
    64
    Note You can use the default values for other parameters unless otherwise specified.
  2. Run the following command to recover data:
    # ./redis-shake -type=restore -conf=redis-shake.conf
    Note You must run this command in the same directory as the redis-shake and redis-shake.conf files. Otherwise, you must specify the correct file path in the command.
  3. When restore: rdb done appears in logs, the data is recovered. You can press Ctrl+C to exit the tool.
    Note You must repeat the preceding procedure to migrate the backup data of all nodes in an ApsaraDB for Redis cluster.
    Figure 1. Example