All Products
Search
Document Center

Data Transmission Service:Configure one-way synchronization between ApsaraDB for Redis instances

Last Updated:Jul 22, 2024

Data Transmission Service (DTS) supports one-way synchronization between ApsaraDB for Redis instances. This feature is applicable to scenarios such as active geo-redundancy and geo-disaster recovery. This topic describes how to configure one-way synchronization between ApsaraDB for Redis instances.

Prerequisites

  • The destination ApsaraDB for Redis instance is created. For more information, see Step 1: Create an ApsaraDB for Redis instance.

    Note

    DTS also supports one-way synchronization between ApsaraDB for Redis Enhanced Edition (Tair) instances and between self-managed Redis databases. You can configure one-way synchronization for these databases by following the procedure described in this topic.

  • The available storage space of the destination ApsaraDB for Redis instance is larger than the total size of the data in the source ApsaraDB for Redis instance.

Usage notes

Category

Description

Limits on the source database

  • To ensure the synchronization quality, Data Transmission Service (DTS) adds a key prefixed with DTS_REDIS_TIMESTAMP_HEARTBEAT to the source database. This key is used to record the time when data is synchronized to the destination database. If the source database is deployed in a cluster architecture, DTS adds this key to each shard. The key is filtered out during data synchronization. After the data synchronization task is complete, the key expires.

  • If the source database is a read-only database or the source database account that is used to run the data synchronization task does not have the permissions to run the SETEX command, the reported latency may be inaccurate.

  • To ensure the stability of data synchronization, we recommend that you increase the value of the repl-backlog-size parameter in the redis.conf file.

  • We recommend that you do not run the FLUSHDB or FLUSHALL command in the source database. If you run one of the commands, data inconsistency may occur between the source and destination databases.

  • You must enable the append-only file (AOF) logging feature for the source database.

  • If an expiration policy is enabled for specific keys in the source database, these keys may not be deleted at the earliest opportunity after they expire. Therefore, the number of keys in the destination database may be smaller than that in the source database. You can run the INFO command to view the number of keys in the destination database.

  • If the source database is a Tair persistent memory-optimized instance, you must set the appendonly parameter to yes for the instance.

  • If the source database is a self-managed Redis database, take note of the following limits:

    • If the source database runs Redis 2.8, incremental data synchronization is not supported.

    • Limits on synchronizing data from a standalone Redis instance to a Redis cluster: Each command can be run only on a single slot in a Redis cluster. If you perform operations on multiple keys in the source database and the keys belong to different slots, the following error occurs:

      CROSSSLOT Keys in request don't hash to the same slot

      We recommend that you perform operations on only one key during data synchronization. Otherwise, the data synchronization task is interrupted.

Other limits

  • The timeout period for data replication between the master and replica nodes in a Redis database is specified by the repl-timeout parameter. We recommend that you run the config set repl-timeout 600 command to set the timeout period to 600 seconds for the source instance. If the source instance stores a large amount of data, you can increase the value of the repl-timeout parameter based on your business requirements.

  • During data synchronization, if the number of shards in the source ApsaraDB for Redis instance is increased or decreased, or if you change the database specifications, such as scaling up the memory capacity, you must reconfigure the data synchronization task. To ensure data consistency, we recommend that you clear the data that has been synchronized to the destination Redis database before you reconfigure the data synchronization task.

  • If the source or destination instance is a self-managed Redis database and the connection address of the self-managed Redis database changes during the data synchronization, you need to reconfigure the data synchronization task.

  • To ensure compatibility, the version of the destination database must be the same as or later than that of the source database. If the version of the destination database is earlier than that of the source database, database compatibility issues may occur.

  • During initial full data synchronization, DTS uses the read and write resources of the source and destination databases. This may increase the loads of the database servers. Before you synchronize data, evaluate the impact of data synchronization on the performance of the source and destination databases. We recommend that you synchronize data during off-peak hours.

  • Data inconsistency between the source and destination databases may occur if data from other sources is written to the destination database during data synchronization.

  • If the destination instance is deployed in a cluster architecture and the amount of memory used by a shard in the destination instance reaches the upper limit, or if the available storage space of the destination instance is insufficient, the data synchronization task fails due to out of memory (OOM).

  • By default, the maxmemory-policy parameter that specifies how data is evicted is set to volatile-lru for ApsaraDB for Redis instances. If the destination instance has insufficient memory, data inconsistency may occur between the source and destination instances due to data eviction. In this case, the data synchronization task does not stop running.

    To prevent data inconsistency, we recommend that you set maxmemory-policy to noeviction for the destination instance. This way, the data synchronization task fails if the destination instance has insufficient memory, but data loss can be prevented for the destination instance.

    Note

    For more information about data eviction policies, see What is the default eviction policy of ApsaraDB for Redis?

  • If the transparent data encryption (TDE) feature is enabled for the source or destination instance, you cannot use DTS to synchronize data from the source database to the destination database.

  • During data synchronization, if resumable upload fails due to transient connections that occur on the source Redis database, full data may be re-synchronized to the destination database. This may cause data inconsistency between the source and destination databases.

Billing

Synchronization typeTask configuration fee
Schema synchronization and full data synchronizationFree of charge.
Incremental data synchronizationCharged. For more information, see Billing overview.

Supported synchronization topologies

  • One-way one-to-one synchronization

  • One-way one-to-many synchronization

  • One-way cascade synchronization

For more information, see Synchronization topologies.

Commands that can be synchronized

  • APPEND

  • BITOP, BLPOP, BRPOP, and BRPOPLPUSH

  • DECR, DECRBY, and DEL

  • EVAL, EVALSHA, EXEC, EXPIRE, and EXPIREAT

  • GEOADD and GETSET

  • HDEL, HINCRBY, HINCRBYFLOAT, HMSET, HSET, and HSETNX

  • INCR, INCRBY, and INCRBYFLOAT

  • LINSERT, LPOP, LPUSH, LPUSHX, LREM, LSET, and LTRIM

  • MOVE, MSET, MSETNX, and MULTI

  • PERSIST, PEXPIRE, PEXPIREAT, PFADD, PFMERGE, and PSETEX

  • RENAME, RENAMENX, RESTORE, RPOP, RPOPLPUSH, RPUSH, and RPUSHX

  • SADD, SDIFFSTORE, SELECT, SET, SETBIT, SETEX, SETNX, SETRANGE, SINTERSTORE, SMOVE, SPOP, SREM, and SUNIONSTORE

  • ZADD, ZINCRBY, ZINTERSTORE, ZREM, ZREMRANGEBYLEX, ZUNIONSTORE, ZREMRANGEBYRANK, and ZREMRANGEBYSCORE

  • SWAPDB and UNLINK. These two commands can be synchronized only if the engine version of the source database is Redis 4.0.

  • XADD, XCLAIM, XDEL, XAUTOCLAIM, XGROUP CREATECONSUMER, and XTRIM

Note
  • PUBLISH commands cannot be synchronized.

  • If you run the EVAL or EVALSHA command to call Lua scripts, DTS cannot identify whether these Lua scripts are executed in the destination database. This is because the destination database does not explicitly return the execution results of Lua scripts during incremental data synchronization.

  • If you run the SYNC or PSYNC command to transfer data of the LIST type, DTS does not clear the existing data in the destination database. As a result, the destination database may contain duplicate data records.

Permissions required for database accounts

Instance

Permissions and authorization method

Source ApsaraDB for Redis instance

The database account must have read permissions. For more information about how to grant permissions to an account, see Create and manage database accounts.

Destination ApsaraDB for Redis instance

The database account must have read and write permissions. For more information about how to grant permissions to an account, see Create and manage database accounts.

Procedure

  1. Go to the Data Synchronization Tasks page.

    1. Log on to the Data Management (DMS) console.

    2. In the top navigation bar, click DTS.

    3. In the left-side navigation pane, choose DTS (DTS) > Data Synchronization.

    Note
  2. On the right side of Data Synchronization Tasks, select the region in which the data synchronization instance resides.

    Note

    If you use the new DTS console, you must select the region in which the data synchronization instance resides in the top navigation bar.

  3. Click Create Task. On the Create Data Synchronization Task page, configure the source and destination databases. The following table describes the parameters.

    Section

    Parameter

    Description

    N/A

    Task Name

    The name of the task. DTS automatically assigns a name to the task. We recommend that you specify a descriptive name that makes it easy to identify the task. You do not need to specify a unique task name.

    Source Database

    Select a DMS database instance

    The database instance that you want to use. You can choose whether to use an existing instance based on your business requirements.

    • If you select an existing instance, DTS automatically populates the parameters for the database.

    • If you do not select an existing instance, you must configure parameters for the source database.

    Database Type

    The type of the source database. Select ApsaraDB for Redis Enhanced Edition (Tair).

    Access Method

    The access method of the source database. Select Alibaba Cloud Instance.

    Instance Region

    The region in which the source ApsaraDB for Redis instance resides.

    Replicate Data Across Alibaba Cloud Accounts

    Specifies whether to synchronize data across Alibaba Cloud accounts. In this example, No is selected.

    Instance ID

    The ID of the source ApsaraDB for Redis instance.

    Database Password

    The database password of the source ApsaraDB for Redis instance. For information about the permissions that are required for the database account, see the Permissions required for database accounts section of this topic.

    Note

    The database password is in the <user>:<password> format. For example, if the username of the account that you use to log on to the source ApsaraDB for Redis instance is admin and the password is Rp829dlwa, the database password is admin:Rp829dlwa.

    Destination Database

    Select a DMS database instance

    The database instance that you want to use. You can choose whether to use an existing instance based on your business requirements.

    • If you select an existing instance, DTS automatically populates the parameters for the database.

    • If you do not select an existing instance, you must configure parameters for the source database.

    Database Type

    The type of the destination database. Select ApsaraDB for Redis Enhanced Edition (Tair).

    Access Method

    The access method of the destination database. Select Alibaba Cloud Instance.

    Instance Region

    The region in which the destination ApsaraDB for Redis instance resides.

    Instance ID

    The ID of the destination ApsaraDB for Redis instance.

    Database Password

    The database password of the destination ApsaraDB for Redis instance. For information about the permissions that are required for the database account, see the Permissions required for database accounts section of this topic.

    Note

    The database password is in the <user>:<password> format. For example, if the username of the account that you use to log on to the source ApsaraDB for Redis instance is admin and the password is Rp829dlwa, the database password is admin:Rp829dlwa.

  4. In the lower part of the page, click Test Connectivity and Proceed.

    If the source or destination database is an Alibaba Cloud database instance, such as an ApsaraDB RDS for MySQL or ApsaraDB for MongoDB instance, DTS automatically adds the CIDR blocks of DTS servers to the whitelist of the instance. If the source or destination database is a self-managed database hosted on an Elastic Compute Service (ECS) instance, DTS automatically adds the CIDR blocks of DTS servers to the security group rules of the ECS instance, and you must ensure that the ECS instance can access the database. If the source or destination database is a self-managed database that is deployed in a data center or provided by a third-party cloud service provider, you must manually add the CIDR blocks of DTS servers to the whitelist of the database to allow DTS to access the database. For more information, see Add the CIDR blocks of DTS servers.

    Warning

    If the CIDR blocks of DTS servers are automatically or manually added to the whitelist of the database or instance, or to the ECS security group rules, security risks may arise. Therefore, before you use DTS to synchronize data, you must understand and acknowledge the potential risks and take preventive measures, including but not limited to the following measures: enhancing the security of your username and password, limiting the ports that are exposed, authenticating API calls, regularly checking the whitelist or ECS security group rules and forbidding unauthorized CIDR blocks, or connecting the database to DTS by using Express Connect, VPN Gateway, or Smart Access Gateway.

  5. Configure the objects to be synchronized and advanced settings. The following table describes the parameters.

    Parameter

    Description

    Synchronization Types

    The data synchronization type. By default, Full Data Synchronization and Incremental Data Synchronization are selected.

    Note

    You cannot select only Incremental Data Synchronization.

    Processing Mode of Conflicting Tables

    • Precheck and Report Errors: checks whether data exists in the destination database. If no data exists in the destination database, the precheck is passed. If data exists in the destination database, an error is returned during the precheck, and the data synchronization task cannot be started.

    • Ignore Errors and Proceed: skips the Check the existence of objects in the destination database. check item.

      Warning

      If you select Ignore Errors and Proceed, data loss may occur in the destination database because data records in the source database overwrite the data records that have the same keys in the destination database. Proceed with caution.

    Source Objects

    Select one or more objects from the Source Objects section and click the 向右 icon to move the objects to the Selected Objects section.

    Note

    You can select only databases as the objects to be synchronized. You cannot select keys as the objects to be synchronized.

    Selected Objects

    If you want to select a database to which data is synchronized from DB 0 to DB 255 or filter the data to be synchronized by prefix, you can use the object name mapping feature or the filtering feature. In the Selected Objects section, right-click the database that you want to synchronize. In the Edit Schema dialog box, configure the parameters. For more information, see Map object names and Set filter conditions.

    Note

    You cannot map multiple object names at a time.

  6. Click Next: Advanced Settings to configure advanced settings.

    • Data Verification Settings

      For more information about how to configure the data verification feature, see Configure data verification

    • Advanced Settings

      Parameter

      Description

      Set Alerts

      Specifies whether to configure alerting for the data synchronization task. If the task fails or the synchronization latency exceeds the specified threshold, alert contacts will receive notifications. Valid values:

      Retry Time for Failed Connections

      The retry time range for failed connections. If the source or destination database fails to be connected after the data synchronization task is started, DTS immediately retries a connection within the time range. Valid values: 10 to 1440. Unit: minutes. Default value: 720. We recommend that you set this parameter to a value greater than 30. If DTS reconnects to the source and destination databases within the specified time range, DTS resumes the data synchronization task. Otherwise, the data synchronization task fails.

      Note
      • If you specify different retry time ranges for multiple data synchronization tasks that have the same source or destination database, the shortest retry time range takes precedence.

      • When DTS retries a connection, you are charged for the DTS instance. We recommend that you specify the retry time range based on your business requirements. You can also release the DTS instance at your earliest opportunity after the source and destination instances are released.

      Retry Time for Other Issues

      The retry time range for other issues. For example, if the DDL or DML operations fail to be performed after the data synchronization task is started, DTS immediately retries the operations within the time range. Valid values: 1 to 1440. Unit: minutes. Default value: 10. We recommend that you set this parameter to a value greater than 10. If the failed operations are successfully performed within the specified time range, DTS resumes the data synchronization task. Otherwise, the data synchronization task fails.

      Important

      The value of the Retry Time for Other Issues parameter must be smaller than the value of the Retry Time for Failed Connections parameter.

      Enable Throttling for Incremental Data Synchronization

      Specifies whether to enable throttling for incremental data synchronization. You can enable throttling for incremental data synchronization based on your business requirements. To configure throttling, you must configure the RPS of Incremental Data Synchronization and Data synchronization speed for incremental synchronization (MB/s) parameters. This reduces the load on the destination database server.

      Environment Tag

      The environment tag that is used to identify the DTS instance. You can select an environment tag based on your business requirements. In this example, you do not need to configure this parameter.

      Extend Expiration Time of Destination Database Key

      The extended time period for keys synchronized from the source database to the destination instance to remain valid. Unit: seconds. If specific commands, such as the following commands, are used, we recommend that you set this parameter to 600 to ensure data consistency.

      EXPIRE key seconds
      PEXPIRE key milliseconds
      EXPIREAT key timestamp
      PEXPIREAT key timestampMs

      Configure ETL

      Specifies whether to enable the extract, transform, and load (ETL) feature. For more information, see What is ETL? Valid values:

  7. Save the task settings and run a precheck.

    • To view the parameters to be specified when you call the relevant API operation to configure the DTS task, move the pointer over Next: Save Task Settings and Precheck and click Preview OpenAPI parameters.

    • If you do not need to view or have viewed the parameters, click Next: Save Task Settings and Precheck in the lower part of the page.

    Note
    • Before you can start the data synchronization task, DTS performs a precheck. You can start the data synchronization task only after the task passes the precheck.

    • If the task fails to pass the precheck, click View Details next to each failed item. After you analyze the causes based on the check results, troubleshoot the issues. Then, run a precheck again.

    • If an alert is generated for an item during the precheck, perform the following operations based on the scenario:

      • If an alert item cannot be ignored, click View Details next to the failed item and troubleshoot the issue. Then, run a precheck again.

      • If an alert item can be ignored, click Confirm Alert Details. In the View Details dialog box, click Ignore. In the message that appears, click OK. Then, click Precheck Again to run a precheck again. If you ignore the alert item, data inconsistency may occur and your business may be exposed to potential risks.

  8. Wait until the success rate becomes 100%. Then, click Next: Purchase Instance.

  9. On the Purchase Instance page, configure the Billing Method and Instance Class parameters for the data synchronization instance. The following table describes the parameters.

    Section

    Parameter

    Description

    New Instance Class

    Billing Method

    • Subscription: You pay for your subscription when you create an instance. The subscription billing method is more cost-effective than the pay-as-you-go billing method for long-term use. You are offered lower prices for longer subscription durations.

    • Pay-as-you-go: A pay-as-you-go instance is billed on an hourly basis. The pay-as-you-go billing method is suitable for short-term use. If you no longer require a pay-as-you-go instance, you can release the instance to reduce costs.

    Resource Group Settings

    The resource group to which the instance belongs. Default value: default resource group. For more information, see What is Resource Management?

    Instance Class

    DTS provides various synchronization specifications that support different performance. The synchronization speed varies based on the synchronization specifications that you select. You can select a synchronization specification based on your business requirements. For more information, see Instance classes of data synchronization instances.

    Subscription Duration

    If you select the subscription billing method, set the subscription duration and the number of instances that you want to create. The subscription duration can be one to nine months, one year, two years, three years, or five years.

    Note

    This parameter is available only if you select the Subscription billing method.

  10. Read and select the Data Transmission Service (Pay-as-you-go) Service Terms.

  11. Click Buy and Start to start the data synchronization task. You can view the progress of the task in the task list.