You need to enable JavaScript to run this app.
Database Transmission Service

Database Transmission Service

Copy page
Download PDF
Redis connected over express network as the source
Synchronizing to Redis connected over express network
Copy page
Download PDF
Synchronizing to Redis connected over express network
This topic describes how to create a task for synchronizing the Redis connected over express network to another Redis connected over express network on the Database Transmission Service (DTS) console.​
Prerequisites​
  • A Redis instance has been set up with access via an express network, and a database account and password have been configured.​
  • Set the source and target information as needed, as detailed below:​
  • If data synchronization requires a dedicated line connection, you need to establish a dedicated line connection between a single cloud VPC and a single on-premises data center network. For more information, refer to Configuring direct connections.​
​
  • The network connectivity and service availability of the source and target databases have been confirmed.​
Precautions​
  • The synchronization task performs incremental synchronization by default.​
  • When the source database is a self-managed Cache for Redis, do not restart or switch the source or target database between primary and secondary during synchronization, as this will cause the synchronization task to fail.​
  • If different DBs map to the same DB and the same Key exists in different DBs, it may cause unpredictable results including data inconsistency or task failure during synchronization.​
  • During synchronization, do not change the instance configuration. Otherwise, the synchronization task will fail.​
  • When creating a data synchronization task via express network, the system creates several network cards by default in your selected VPC, and the network cards are mounted by default to the subnet you selected. The network card name format is dts_shuttle_********.​
  • In full and incremental synchronization tasks of Stream, do not perform double-write operations on the target database instance, as this may cause the synchronization task to fail.​
  • Synchronizing instances with SSL enabled is not supported.​
  • During data synchronization, if duplicate key values are encountered in the target database, DTS will not retain the conflicting data at the destination. Instead, the data from the source will overwrite the data at the destination.​
  • When synchronizing to a VPC cluster edition instance, the cluster edition instance must support the Cluster Nodes command. Otherwise, the task can not be created successfully.​
  • When the instance connected to the destination is a VPC cluster edition instance, you need to pay attention to the following information:​
  • Each shard in a VPC Cache for Redis cluster edition instance should belong to the same VPC and subnet.​
  • The VPC Cache for Redis cluster edition instance does not support configuration changes or switching to the primary.​
  • The shard Bind IP of the VPC Cache for Redis cluster edition instance must be an internal IP, not a local IP (e.g., 127.0.0.1).​
  • All shards in the VPC Cache for Redis cluster edition instance must use the same data account password.​
Limits​
​
Type​
Description​
Source database limits​
  • Bandwidth requirements: Adequate egress bandwidth is required on the source database server. Failure to meet this prerequisite will lead to suboptimal synchronization performance.​
  • When certain keys in the source database use an expiration (expire) policy, a situation may arise where expired keys are not deleted promptly. This can result in the target database appearing to have fewer keys than the source database.​
  • During synchronization, if the source database undergoes scaling such as adding or removing shards, or changes in specifications like memory expansion, you need to reconfigure the task. To ensure consistent data, it is recommended to clear data that has been synchronized to the target Cache for Redis instance before reconfiguring the task.​
  • During synchronization, if the source database connection address changes and causes the task to fail, you need to reconfigure the task. If it fails, you can submit a ticket for technical support. If it is not processed for a long time, the source database will reset the AOF file.​
Other limits​
  • It is recommended that the source and target Cache for Redis databases be the same version, or synchronize from a lower version to a higher one to ensure compatibility. If you synchronize from a higher version to a lower version, there may be database compatibility or data loss issues.​
  • During incremental data synchronization, DTS cannot confirm the execution success of Lua scripts called via EVAL or EVALSHA, as the target database does not explicitly return execution results for scripts.​
  • During full data synchronization, DTS consumes certain read/write resources on both the source and target databases, which may lead to an increased load on the database servers. When the database workload is heavy or server specifications are low, it may increase database pressure, even causing the database service to become unavailable and the data synchronization task to fail.​
  • It is recommended to perform data synchronization during off-peak hours. You can also increase the parameter value of the source database's client-output-buffer-limit to prevent buffer overflow when synchronizing large Keys.​
  • The storage space of the target Cache for Redis database must be greater than the storage space occupied by the source Cache for Redis database.​
  • When DTS transfers data using the psync and sync commands, it overwrites data in the target database. If the target database already contains the same Key, it will first execute the del operation.​
  • In the event of a transient connection failure on the source or target instance, a full data re-synchronization may be triggered, potentially leading to data inconsistency.​
  • If the target database's data eviction policy parameter maxmemory-policy is configured to a value other than noeviction, it may cause the target database's data to be inconsistent with the source database.​
  • When synchronizing data from a cluster edition, only database 0 is supported for synchronization.​
​
Supported synchronization architectures​
  • One-to-one unidirectional synchronization​
  • One-to-many unidirectional synchronization​
  • Many-to-one unidirectional synchronization​
  • Cascading unidirectional synchronization​
For information on the types and usage of synchronization topology supported by DTS, refer to Data synchronization topology.​
Supported commands​
  • APPEND​
  • BITOP, BLPOP, BRPOP, BRPOPLPUSH​
  • DECR, DECRBY, DEL​
  • EVAL, EVALSHA, EXPIRE, EXPIREAT​
  • GEOADD, GETSET​
  • HDEL, HINCRBY, HINCRBYFLOAT, HMSET, HSET, HSETNX​
  • INCR, INCRBY, INCRBYFLOAT​
  • LINSERT, LPOP, LPUSH, LPUSHX, LREM, LSET, LTRIM​
  • MOVE, MSET, MSETNX​
  • PERSIST, PEXPIRE, PEXPIREAT, PFADD, PFMERGE, PSETEX​
  • RENAME, RENAMENX, RESTORE, RPOP, RPOPLPUSH, RPUSH, RPUSHX​
  • SADD, SDIFFSTORE, SELECT, SET, SETBIT, SETEX, SETNX, SETRANGE, SINTERSTORE, SMOVE, SPOP, SREM, SUNIONSTORE​
  • ZADD, ZINCRBY, ZINTERSTORE, ZREM, ZREMRANGEBYLEX, ZUNIONSTORE, ZREMRANGEBYRANK, ZREMRANGEBYSCORE​
tip​
Cache for Redis 7.0 does not support Function commands.​
Database account minimum permission policy​
​
Database​
Privilege​
Source database​
You can execute the sync, psync, and config get commands.​
Target database​
You can execute write commands.​
​
Procedure​
  1. Log on to the DTS console.​
  1. On the top menu bar, select the project and region.​
  1. In the left navigation bar, click Data synchronization.​
  1. On the Synchronization task list page, click Create task.​
  1. On the Create synchronization task page, locate the Configure source and target database wizard, and configure the following parameters information.​
  • ​
    Type​
    Parameter​
    Description​
    Basic information​
    Task name​
    Optional. Customize the task name. The length must be within 256 characters.​
    tip​
    If not set, the system generates a task name by default according to the naming rule, starting with dts-.​
    ​
    Link specification​
    Select the link specifications for the synchronization task as needed. Compact, Medium, and Standard are supported.​
    tip​
    The link specification can not be modified after the task is successfully created. For details on the link specifications, refer to Product specifications.​
    ​
    Synchronization topology​
    Currently only unidirectional synchronization is supported.​
    tip​
    For more information about the synchronization topology, refer to Data synchronization topology.​
    Source database configuration​
    Select an existing data source​
    You can choose whether to use an existing instance as needed:​
    • Use existing instances: Click Select an existing data source, then in the Select data source control panel, choose the target region from the Region drop-down list, and select the target data source. Supports selecting data sources by data source name and ID. For methods to create data sources, refer to Data source management.​
    • Do not use existing instances: If not using an existing instance, you need to configure the following database instance information.​
    ​
    Instance type​
    Select Redis.​
    ​
    Access method​
    Select Redis connected over express network.​
    ​
    Region​
    Select the region where the target instance is located.​
    ​
    Architecture type​
    Select the instance architecture type as needed, supporting Standalone edition and Cluster edition.​
    tip​
    If the Redis connected over express network instance cluster has a Proxy service, the instance architecture type must be set to standalone edition.​
    ​
    Host address​
    Enter the host address of the VPC instance.​
    tip​
    • This parameter must be set when Architecture type is set to Standalone edition.​
    • Currently, only IPv4 addresses are supported for access. IPv6 addresses are not yet supported.​
    ​
    Port​
    Enter the port number of the VPC instance.​
    tip​
    This parameter must be set when Architecture type is set to Standalone edition.​
    ​
    Address​
    Enter the IP: port of all primary nodes with assigned slots in each shard of the Cache for Redis cluster in the private network connected via the dedicated line, separated by commas. For example: ip1:port1,ip2:port2,ip3:port3.​
    tip​
    • This parameter must be set when Architecture type is set to Cluster edition.​
    • The IP: port of all primary nodes with assigned slots in each shard of the Cache for Redis cluster must be entered in this parameter.​
    ​
    VPC​
    Select the VPC where the target instance is located from the drop-down list, as shown below:​
    • Direct connect: Select any VPC under the CEN when achieving data connectivity through a dedicated line CEN.​
    • VPN connection: Select the VPC bound to the VPN gateway when achieving data connectivity through VPN.​
    ​
    Subnet​
    Select a subnet within the VPC from the drop-down list.​
    tip​
    When synchronizing a VPC Cache for Redis instance, you need to add subnet CIDR block access permissions to the allowlist or security group policy on the source end in advance. Click View subnet CIDR blocks to view and copy CIDR blocks.​
    ​
    Database account​
    The default account is default, and you can set the database account on a case-by-case basis.​
    ​
    Database password​
    Enter the password corresponding to the database account of the source instance.​
    tip​
    If the Redis instance connected over express network enables passwordless login, you do not need to enter the password for the instance database account.​
    ​
    Test connection​
    Click Test connection to verify the connection to the instance. If the test connection fails, modify the configuration based on the failure prompt, and then click Test connection again to verify the connection. The details are as follows:​
    • Connection authentication failed. Check the network: When this error prompt appears, confirm network connectivity.​
    • Connection authentication failed. Check the username and password: When this error prompt appears, verify your username and password.​
    • Connection authentication failed, unable to create connection normally, contact customer service: When this error prompt appears, submit a ticket to contact technical staff.​
    • Invalid IP address: When this error prompt appears, verify the accuracy of the IP address.​
    • The Express network requires the subnet to have * available IPs. The current number of available IPs in the subnet is insufficient, and the task can not be created. Check the subnet resources in the VPC: When this error prompt appears, adjust the number of available IPs in the VPC subnet to ensure enough IPs in the target VPC subnet.​
    Target database configuration​
    Select an existing data source​
    You can choose whether to use an existing instance as needed:​
    • Use existing instances: Click Select an existing data source, then in the Select data source control panel, choose the target region from the Region drop-down list, and select the target data source. Supports selecting data sources by data source name and ID. For methods to create data sources, refer to Data source management.​
    • Do not use existing instances: If not using an existing instance, you need to configure the following database instance information.​
    ​
    Instance type​
    Select Redis.​
    ​
    Access method​
    Select Redis connected over express network.​
    ​
    Region​
    Select the region where the target instance is located.​
    ​
    Architecture type​
    Select the instance architecture type as needed, supporting Standalone edition and Cluster edition.​
    tip​
    If the Redis connected over express network instance cluster has a Proxy service, the instance architecture type must be set to standalone edition.​
    ​
    Host address​
    Enter the host address of the VPC instance.​
    tip​
    • This parameter must be set when Architecture type is set to Standalone edition.​
    • Currently, only IPv4 addresses are supported for access. IPv6 addresses are not yet supported.​
    ​
    Port​
    Enter the port number of the VPC instance.​
    tip​
    This parameter must be set when Architecture type is set to Standalone edition.​
    ​
    Address​
    Enter the IP: port of all primary nodes with assigned slots in each shard of the Cache for Redis cluster in the private network connected via the dedicated line, separated by commas. For example: ip1:port1,ip2:port2,ip3:port3.​
    tip​
    • This parameter must be set when Architecture type is set to Cluster edition.​
    • The IP: port of all primary nodes with assigned slots in each shard of the Cache for Redis cluster must be entered in this parameter.​
    ​
    VPC​
    Select the VPC where the target instance is located from the drop-down list, as shown below:​
    • Direct connect: Select any VPC under the CEN when achieving data connectivity through a dedicated line CEN.​
    • VPN connection: Select the VPC bound to the VPN gateway when achieving data connectivity through VPN.​
    ​
    Subnet​
    Select a subnet within the VPC from the drop-down list.​
    tip​
    When synchronizing a VPC Cache for Redis instance, you need to add subnet CIDR block access permissions to the allowlist or security group policy on the source end in advance. Click View subnet CIDR blocks to view and copy CIDR blocks.​
    ​
    Database account​
    The default account is default, and you can set the database account on a case-by-case basis.​
    ​
    Database password​
    Enter the password corresponding to the database account of the source instance.​
    tip​
    If the Redis instance connected over express network enables passwordless login, you do not need to enter the password for the instance database account.​
    ​
    Test connection​
    Click Test connection to verify the connection to the instance. If the test connection fails, modify the configuration based on the failure prompt, and then click Test connection again to verify the connection. The details are as follows:​
    • Connection authentication failed. Check the network: When this error prompt appears, confirm network connectivity.​
    • Connection authentication failed. Check the username and password: When this error prompt appears, verify your username and password.​
    • Connection authentication failed, unable to create connection normally, contact customer service: When this error prompt appears, submit a ticket to contact technical staff.​
    • Invalid IP address: When this error prompt appears, verify the accuracy of the IP address.​
    • The Express network requires the subnet to have * available IPs. The current number of available IPs in the subnet is insufficient, and the task can not be created. Check the subnet resources in the VPC: When this error prompt appears, adjust the number of available IPs in the VPC subnet to ensure enough IPs in the target VPC subnet.​
    None​
    Project​
    Optional. Select the affiliated project for the task from the drop-down list. By default, it is under default (default project). You can also click Create new project to create a new project. For more information, refer to Creating a new project.​
    tip​
    • After a task is created successfully, if you need to change its affiliated project, you can move the resource to another project.​
    • A project is a virtual concept that includes a set of resources, users, and roles. A project allows for a unified view and management of a set of resources, and controls the permissions of users and roles within the project for those resources.​
    ​
    Tag​
    (Optional) Click Add tag to add a tag to the instance. Tags can help you categorize cloud resources, control access to them, and allocate bills and costs. A tag is a key-value pair that identifies a cloud resource. You can use tags to categorize resources with the same characteristics from different dimensions, such as purpose or owner, making it easier to filter, aggregate, and manage your cloud resources. For more details about tags, refer to Tag overview. The rules for tag key-value pairs are as follows:​
    • Key​
    • Supports any language, characters, numbers, spaces, or symbols (_.:/=+-@).​
    • Case-sensitive, and the length is 1 to 128 characters.​
    • In UTF-8 encoded Unicode format.​
    • Keys cannot start with any form of volc:, such as Volc: or VOLC:.​
    • (Optional) Value​
    • Supports any language, character, digit, space, or symbol (_.:/=+-@).​
    • Case-sensitive, and the length is 0 to 256 characters.​
    • In UTF-8 encoded Unicode format.​
    tip​
    • Support fuzzy search for selecting existing tag keys and tag values.​
    • A maximum of 20 tags can be associated with a task in a single operation. A maximum of 50 tags can be associated with a single task.​
    • For a single resource, tag keys must be unique, and each tag key can have only one value.​
    ​
    Billing method​
    Select a billing method: Pay-as-you-go or Subscription.​
    tip​
    For detailed billing information, refer to Billing instructions.​
    ​
    Subscription duration​
    Select the duration of the subscription as needed.​
    tip​
    When selecting Subscription in Billing method, you can set the purchase time and also check Automatic renewal. The system automatically renews before task expiration.​
    ​
  1. Click Next: configure synchronization object.​
  1. On the Configure synchronization objects wizard page, configure the following parameter information.​
  • ​
    Name​
    ​
    Description​
    Synchronization type​
    ​
    Select the synchronize type as needed. Currently, Full initialization and Incremental synchronization are supported.​
    tip​
    • Incremental synchronization is selected by default.​
    • A forward synchronization task can select only incremental synchronization. In this case, the historical full data of the source end is not initialized to the destination. Reverse Synchronization does not currently support selecting Full initialization.​
    • When you select Full initialization, after the pre-check is completed, DTS will initialize the data of the objects to be synchronized from the source instance in the target instance, which serves as the basis for subsequent incremental data synchronization.​
    Synchronization object​
    ​
    In the Synchronization objects area, select the objects to be synchronized, and in the Selected object area, confirm the objects to be synchronized.​
    Advanced configuration​
    Error retry time​
    If a synchronization task fails due to a disconnection between the source and target databases, the system immediately retries connecting to them multiple times within the specified time. Value range: 600–86400, in seconds (s). The default value is 600 seconds.​
    ​
    Enable key filtering​
    In a data synchronization task, if you only need to synchronize data that meets the conditions to the target database, you can achieve this by using the key filtering function.​
    Select whether to enable the key filtering function.​
    • Yes: Indicates that the key filtering function is enabled.​
    • After Key filtering is enabled, you must configure Filter rules.​
    • Allowlist: If you select Allowlist for filtering rule, you must enter a regular expression. Indicates that the Keys matched by the regular expression will be synchronized to the Target.​
    • Blocklist: If you select Blocklist for the filtering rule, you must enter a regular expression. Indicates that the Keys matched by the regular expression will be filtered out, that is, they will not be synchronized to the target.​
    • After Key filtering is enabled, to ensure the accuracy of the synchronized data, click Online test. On the VolcDTSRedisKeyFilter page, test whether the regular expression you entered completely meets your filtering requirements online. Based on the test results, you can confirm whether the regular expression has the correct syntax and whether it can meet the filtering requirements, so as to reduce the risk of data loss or synchronization errors during data synchronization.​
    • No: Indicates that the key filtering function is not enabled.​
    ​
    Use KSN for incremental​
    ​
    Enable KSN for incremental synchronization as needed. After enabling, DTS will use Redis keyspace notification to capture incremental data changes that Redis native replication protocol cannot transmit.​
    tip​
    Because the KSN mechanism depends on real-time message pushing from the Redis server, it is highly sensitive to performance. Consider the following risks before enabling this feature:​
    • High performance overhead: KSN increases CPU and network load on the source database, possibly causing significant pressure on live services.​
    • Prohibited in large key scenarios: Frequent operations on large keys in your business can easily cause KSN message accumulation or timeouts, leading to task failure.​
    • Data consistency risk: KSN cannot guarantee 100% reliable message delivery. Network jitter or high source database load may cause message loss, resulting in data inconsistency between master and standby.​
    • SLA not guaranteed: Due to the instability above, the synchronization link after enabling this feature is not covered by the standard SLA.​
    ​
  1. Click Data validation configuration.​
  1. On the Create synchronization task page, locate the Configure data verification wizard, and configure the following parameters.​
  • ​
    Name​
    Description​
    Data verification​
    ​
    Select whether to configure the data verification function directly when creating a synchronization task (built-in).​
    • Enable: Configure data verification tasks directly when creating a data synchronization task.​
    • Disable: (Default) Do not configure data verification tasks when creating data synchronization tasks.​
    Validation type​
    ​
    DTS automatically generates validation types based on the database type and synchronization type, and does not support modification. For more information on validation types, refer to Background.​
    Validation object​
    Select the object to be verified. You can perform the following operations in the Selected object area:​
    • Consistent with the synchronization task: The object to be verified matches the object to be migrated, meaning all migration objects are verified.​
    • Custom: Select the object to be verified as needed.​
    Startup settings​
    Configure the timing of data verification in the synchronization task.​
    • Automatic start: The data verification task starts automatically along with the progress of the synchronization task. Automatic start occurs when full synchronization (if any) is complete and the delay of incremental synchronization is 0.​
    • Manually start: The data verification task does not start automatically with the synchronization task progress. You must manually start the data verification at the appropriate time. It is recommended to manually start data verification only after full synchronization (if any) is complete and the delay of incremental synchronization is 0. Otherwise, verification results may be inaccurate.​
    Billing type​
    Currently, only Pay-as-you-go is supported and can not be modified.​
    ​
  1. Click Pre-check.​
  1. Optional. If a pre-check has been performed for the created task, you can confirm whether to restart the pre-check based on the prompts. If you need to restart, click OK in the Whether to restart the pre-check dialog box.​
  • If the instances of the source and target databases are not modified, there is no need to restart the pre-check.​
  • If you modify the source and target database instance information or the synchronization task parameters, it is recommended to restart the pre-check to avoid task startup failures or interruptions.​
  1. On the Pre-check configuration wizard page, perform the following actions based on the check result:​
  • Click Details in the Actions column of the pre-check results to view detailed alert and failure messages. After modifying the databases and tables accordingly, click Retry.​
  • Click Ignore in the Actions column to ignore the alert and continue starting the synchronization task. You can also click Ignore all to ignore all alert messages with one click.​
tip​
  • If you choose to Ignore the alert and start the synchronization task, it may cause data inconsistencies and business risks.​
  1. At the bottom-right of the Pre-check page, click Confirm order.​
  1. Select the configuration method according to the billing method of the task creation:​
  • For pay-as-you-go, reconfirm the configuration on the Confirm order wizard page. Read the Service-Specific Terms for BytePlus Database Products and Services and check I have read and agree to Service-Specific Terms for BytePlus Database Products and Services, and click Create and start a task.​
  • Subscription​
  1. On the Confirm order configuration wizard page, confirm the configuration information again. Read the Service-Specific Terms for BytePlus Database Products and Services and check I have read and agree to Service-Specific Terms for BytePlus Database Products and Services, and click Create and start a task.​
  1. On the Confirm billing information configuration wizard page, verify the instance’s billing information.​
  1. Optional. Click Voucher redemption. In the Voucher redemption dialog box, enter the voucher code and click Redeem.​
  1. Optional. In the voucher area, select an available voucher as needed. Only one voucher can be selected at a time to offset part of the cost. You can also choose not to use a voucher.​
  1. Click Next step.​
tip​
Once the Payment is completed on the configuration wizard page, a Successful payment message means your task has been created.​
After successfully creating the data synchronization task, you can return to the DTS console to view the data synchronization task information on the data synchronization task list.​
Last updated: 2026.09.02 16:10:48