Data Transmission Service (DTS) supports one-way synchronization between Tair (Redis OSS-Compatible) 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 Tair (Redis OSS-Compatible) instances.
Prerequisites
The destination Tair (Redis OSS-Compatible) instance is created. For more information, see Step 1: Create an instance.
The available storage space of the destination Tair (Redis OSS-Compatible) instance is larger than the total size of the data in the source Tair (Redis OSS-Compatible) instance.
Usage notes
Category | Description |
Limits on the source database |
|
Other limits |
|
Billing
Synchronization type | Task configuration fee |
Schema synchronization and full data synchronization | Free of charge. |
Incremental data synchronization | Charged. 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
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
Database type | Permissions and authorization method |
Source Tair (Redis OSS-Compatible) 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 Tair (Redis OSS-Compatible) 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
Go to the Data Synchronization Tasks page.
Log on to the Data Management (DMS) console.
In the top navigation bar, click DTS.
In the left-side navigation pane, choose .
NoteOperations may vary based on the mode and layout of the DMS console. For more information, see Simple mode and Customize the layout and style of the DMS console.
You can also go to the Data Synchronization Tasks page of the new DTS console.
On the right side of Data Synchronization Tasks, select the region in which the data synchronization instance resides.
NoteIf you use the new DTS console, you must select the region in which the data synchronization instance resides in the top navigation bar.
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 DTS task. DTS automatically generates a task name. 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 that you want to use. You can choose whether to use an existing database based on your business requirements.
If you select an existing database, DTS automatically populates the parameters for the database.
If you do not select an existing database, you must configure the following database information.
Database Type
The type of the source database. Select Tair/Redis.
Access Method
The access method of the source database. Select Alibaba Cloud Instance.
Instance Region
The region in which the source Tair (Redis OSS-Compatible) instance resides.
Replicate Data Across Alibaba Cloud Accounts
Specifies whether data is synchronized across Alibaba Cloud accounts. In this example, No is selected.
Instance ID
The ID of the source Tair (Redis OSS-Compatible) instance.
Database Password
The database password of the source Tair (Redis OSS-Compatible) instance. For information about the permissions that are required for the database account, see the Permissions required for database accounts section of this topic.
NoteThe 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 Tair (Redis OSS-Compatible) database is admin and the password is Rp829dlwa, the database password is admin:Rp829dlwa.
Destination Database
Select a DMS database instance
The database that you want to use. You can choose whether to use an existing database based on your business requirements.
If you select an existing database, DTS automatically populates the parameters for the database.
If you do not select an existing database, you must configure the following database information.
Database Type
The type of the destination database. Select Tair/Redis.
Access Method
The access method of the destination database. Select Alibaba Cloud Instance.
Instance Region
The region in which the destination Tair (Redis OSS-Compatible) instance resides.
Replicate Data Across Alibaba Cloud Accounts
Specifies whether data is synchronized across Alibaba Cloud accounts. In this example, No is selected.
Instance ID
The ID of the destination Tair (Redis OSS-Compatible) instance.
Database Password
The database password of the destination Tair (Redis OSS-Compatible) instance. For information about the permissions that are required for the database account, see the Permissions required for database accounts section of this topic.
NoteThe database password is in the <user>:<password> format. For example, if the username of the account that you use to log on to the destination Tair (Redis OSS-Compatible) instance is admin and the password is Rp829dlwa, the database password is admin:Rp829dlwa.
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.
WarningIf 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.
Configure the objects to be synchronized and the 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.
NoteYou 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.
WarningIf 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 add the objects to the Selected Objects section.
NoteYou 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 Specify filter conditions.
NoteYou cannot map multiple object names at a time.
Click Next: Advanced Settings to configure advanced settings. The following table describes the parameters.
Data Verification Settings
For more information about how to configure data verification, 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:
No: does not enable alerting.
Yes: configures alerting. In this case, you must also configure the alert threshold and alert notification settings. For more information, see the "Configure monitoring and alerting when you create a DTS task" section of the Configure monitoring and alerting topic.
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.
NoteIf 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.
ImportantThe 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:
Yes: configures the ETL feature. You can enter data processing statements in the code editor. For more information, see Configure ETL in a data migration or data synchronization task.
No: does not configure the ETL feature.
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.
NoteBefore 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 data synchronization task fails the precheck, click View Details next to each failed item. After you analyze the causes based on the check results, troubleshoot the issues. Then, rerun the precheck.
If an alert is triggered for an item during the precheck:
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.
Wait until the Success Rate becomes 100%. Then, click Next: Purchase Instance.
On the buy 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 a subscription when you create a data synchronization instance. The subscription billing method is more cost-effective than the pay-as-you-go billing method for long-term use.
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 data synchronization instance, you can release the instance to reduce costs.
Resource Group Settings
The resource group to which the data synchronization instance belongs. Default value: default resource group. For more information, see What is Resource Management?
Instance Class
DTS provides instance classes that vary in synchronization speed. You can select an instance class based on your business requirements. For more information, see Instance classes of data synchronization instances.
Subscription Duration
If you select the subscription billing method, specify the subscription duration and the number of data synchronization instances that you want to create. The subscription duration can be one to nine months, one year, two years, three years, or five years.
NoteThis parameter is available only if you select the Subscription billing method.
Read and select Data Transmission Service (Pay-as-you-go) Service Terms.
Click Buy and Start. In the dialog box that appears, click OK.
You can view the progress of the task in the task list.