RDS MySQL Synchronization to ApsaraMQ for RocketMQ

Prerequisites

• An instance of the non-Serverless edition of ApsaraMQ for RocketMQ must be created. For more information, see Instance Management or Instance Management.

  Note

  For supported versions of source and destination databases, see Synchronization Solution Overview.

• A Topic must be created in the target ApsaraMQ for RocketMQ instance to receive the synchronized data. For more information, see Topic Management or Topic Management.

  Important

  For 4.x series: The Message Type of the Topic must be set to Partitionally Ordered Message.

  For 5.x series: The Message Type of the Topic must be set to Ordered Message.

Considerations

Billing

SQL operations that can be synchronized

Permissions required for database accounts

Procedure

1. Use one of the following methods to go to the Data Synchronization page and select the region in which the data synchronization instance resides.

   DTS console

   DMS console

   1. Log on to the DTS console.

   2. In the left-side navigation pane, click Data Synchronization.

   3. In the upper-left corner of the page, select the region in which the data synchronization instance resides.

   Note

   The actual operations 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.

   1. Log on to the DMS console.

   2. In the top navigation bar, move the pointer over Data + AI and choose DTS (DTS) > Data Synchronization.

   3. From the drop-down list to the right of Data Synchronization Tasks, select the region in which the data synchronization instance resides.

2. Click Create Task to go to the task configuration page.

3. Configure the source and destination databases. The following table describes the parameters.

   Category	Configuration	Description

   Category	Configuration	Description
   None	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 Existing Connection	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. Note In the DTS console, register a database with DTS on the Database Connections page or the new configuration page. For more information, see Manage database connections. In the DMS console, you can select an existing database from the Select a DMS database instance. drop-down list. You can also click Add DMS Database Instance or go back to the homepage of the DMS console to register a database with DMS. For more information, see Register an Alibaba Cloud database instance and Register a database hosted on a third-party cloud service or a self-managed database.
   	Database Type	Select MySQL.
   	Access Method	Select Alibaba Cloud Instance.
   	Instance Region	Select the region where the source RDS MySQL instance resides.
   	Replicate Data Across Alibaba Cloud Accounts	In this example, a database of the current Alibaba Cloud account is used. Select No.
   	RDS Instance ID	Select the ID of the source RDS MySQL instance.
   	Database Account	Enter the database account of the source RDS MySQL instance. For permission requirements, see Permissions required for database accounts.
   	Database Password	The password that is used to access the database.
   	Encryption	Specifies whether to encrypt the connection to the database. You can select Non-encrypted or SSL-encrypted based on your business requirements. If you want to set this parameter to SSL-encrypted, you must enable SSL encryption for the ApsaraDB RDS for MySQL instance before you configure the DTS task. For more information, see Use a cloud certificate to enable SSL encryption.
   Destination Database	Select Existing Connection	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. Note In the DTS console, register a database with DTS on the Database Connections page or the new configuration page. For more information, see Manage database connections. In the DMS console, you can select an existing database from the Select a DMS database instance. drop-down list. You can also click Add DMS Database Instance or go back to the homepage of the DMS console to register a database with DMS. For more information, see Register an Alibaba Cloud database instance and Register a database hosted on a third-party cloud service or a self-managed database.
   	Database Type	Select RocketMQ.
   	Access Method	Select Alibaba Cloud Instance.
   	Instance Region	Select the region where the target ApsaraMQ for RocketMQ instance resides.
   	RocketMQ version	Select the version of the target ApsaraMQ for RocketMQ instance.
   	Instance ID	Select the ID of the target ApsaraMQ for RocketMQ instance.
   	Database Account	Enter the database account of the target ApsaraMQ for RocketMQ instance and the password of the account. Note You need to enter this information only when RocketMQ version is set to 5.x. You can obtain it on the ApsaraMQ for RocketMQ console Resource Access Management Intelligent Identity Detection tab.
   	Database Password
   	Topic	Select the Topic to receive data from the drop-down list.
   	Topic That Stores DDL Information	Select the Topic to store DDL information from the drop-down list. Note If no Topic is selected, the DDL information is stored in the Topic selected in Topic by default.

4. Click Test Connectivity and Proceed in the lower part of the page.

   Note

   • Make sure that the CIDR blocks of DTS servers can be automatically or manually added to the security settings of the source and destination databases to allow access from DTS servers. For more information, see Add the CIDR blocks of DTS servers.

   • If the source or destination database is a self-managed database and its Access Method is not set to Alibaba Cloud Instance, click Test Connectivity in the CIDR Blocks of DTS Servers dialog box.

5. Configure the objects to be synchronized.

   1. In the Configure Objects step, configure the objects that you want to synchronize.

      Configuration	Description

      Configuration	Description
      Synchronization Types	By default, Incremental Data Synchronization is selected. You can select only Full Data Synchronization. You cannot select Schema Synchronization. After the precheck is complete, DTS synchronizes the historical data of the selected objects from the source database to the destination database. The historical data is the basis for subsequent incremental synchronization. Note When the destination database is an ApsaraMQ for RocketMQ instance, Schema Synchronization is not supported.
      Processing Mode of Conflicting Tables	Precheck and Report Errors: checks whether the destination database contains tables that have the same names as tables in the source database. If the source and destination databases do not contain tables that have identical table names, the precheck is passed. Otherwise, an error is returned during the precheck, and the data synchronization task cannot be started. Note If the source and destination databases contain tables with identical names and the tables in the destination database cannot be deleted or renamed, you can use the object name mapping feature to rename the tables that are synchronized to the destination database. For more information, see Map object names. Ignore Errors and Proceed: skips the precheck for identical table names in the source and destination databases. Warning If you select Ignore Errors and Proceed, data inconsistency may occur and your business may be exposed to potential risks. If the source and destination databases have the same schema and a data record in the destination database has the same primary key value or unique key value as a data record in the source database: During full data synchronization, DTS does not synchronize the data record to the destination database. The existing data record in the destination database is retained. During incremental data synchronization, DTS synchronizes the data record to the destination database. The existing data record in the destination database is overwritten. If the source and destination databases have different schemas, data may fail to be initialized. In this case, only some columns are synchronized, or the data synchronization task fails. Proceed with caution.
      Format of the data delivered to RocketMQ.	Select the storage format for writing the synchronized data to the destination Topic based on your needs. For more information, see Data Storage Format in Message Queue.
      Synchronize all fields	You can select whether to synchronize only the pre-image of the fields updated by the UPDATE statement (that is, the data before the UPDATE statement is executed) to the old field of the destination Topic based on your actual needs. Yes: Synchronizes the pre-image of the row corresponding to the fields updated by the UPDATE statement. No (default): Synchronizes only the pre-image of the fields updated by the UPDATE statement.
      Rules of the ordered messages delivered to RocketMQ.	Select the message order rule for writing the synchronized data to the destination Topic based on your needs. For more information, see Message Order Rule in RocketMQ.
      Name of DTS producer group	You can configure the producer group (ProducerGroup) to send messages to the desired Topic, according to your specific requirements. Note The default value is dts-producer-group.
      Limits of RocketMQ messaging transactions per second (TPS)	Set the TPS limit for sending and receiving messages when writing the synchronized data to the destination Topic based on your needs. For more information about TPS limits, see Specification Calculation Description. Important The value must not exceed the maximum TPS of the ApsaraMQ for RocketMQ instance. For more information, see Instance Specification Limits. The actual TPS for sending and receiving messages of the ApsaraMQ for RocketMQ instance may fluctuate within the set range during the operation of the synchronization instance.
      Whether to filter large size of records.	Choose whether to filter message bodies larger than 4 MB when writing them to the destination Topic based on your needs. Important If you select No, the synchronization instance will fail if the message body exceeds 4 MB.
      Capitalization of Object Names in Destination Instance	The capitalization of database names, table names, and column names in the destination instance. By default, DTS default policy is selected. You can select other options to ensure that the capitalization of object names is consistent with that in the source or destination database. For more information, see Specify the capitalization of object names in the destination instance.
      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. Note You can select databases or tables as the objects to be synchronized.
      Selected Objects	This example does not require additional configuration. Use the mapping feature to set the Topic name of the target ApsaraMQ for RocketMQ instance to which the data to be synchronized is written, set filter conditions, select the SQL operations to be synchronized, and set the Partition Key. For more information, see Mapping Information.

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

      Configuration	Description

      Configuration	Description
      Dedicated Cluster for Task Scheduling	By default, DTS schedules the task to the shared cluster if you do not specify a dedicated cluster. If you want to improve the stability of data synchronization tasks, purchase a dedicated cluster. For more information, see What is a DTS dedicated cluster.
      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 Full Data Migration	During full data synchronization, DTS uses the read and write resources of the source and destination databases. This may increase the load on the database servers. You can configure the Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s) parameters for full data synchronization tasks to reduce the load on the destination database server. Note This parameter is displayed only if Full Data Synchronization is selected for the Synchronization Types 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.
      Whether to delete SQL operations on heartbeat tables of forward and reverse tasks	Specifies whether to write SQL operations on heartbeat tables to the source database while the DTS instance is running. Valid values: Yes: does not write SQL operations on heartbeat tables. In this case, a latency of the DTS instance may be displayed. No: writes SQL operations on heartbeat tables. In this case, features such as physical backup and cloning of the source database may be affected.
      Environment Tag	Select an environment tag to identify the instance based on your needs. This example does not require a selection.
      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.
      Monitoring and Alerting	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.

6. 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 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.

7. Purchase an instance.

   1. Wait until the Success Rate becomes 100%. Then, click Next: Purchase Instance.

   2. 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

      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. Note This parameter is available only if you select the Subscription billing method.

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

   4. Click Buy and Start. In the dialog box that appears, click OK.

      You can view the progress of the task in the task list.

Mapping information

1. In the Selected Objects list box, hover over the name of the target Topic.

2. Click Edit that appears after the name of the target Topic.

3. Configure the mapping information in the dialog box that appears.

   Note

   • If both schema-level and table-level mapping are used, table-level mapping takes precedence, and schema-level mapping does not take effect.

   • Configure schema-level mapping in the Edit Schema dialog box and table-level mapping in the Edit Table dialog box.

   Schema level

   Table level

   Configuration	Description
   Schema Name	The name of the destination topic where the data to be synchronized is written. The default is the Configurations for Source and Destination Databases stage, selected in Destination Database as Topic. Important The specified Topic name must exist in the target ApsaraMQ for RocketMQ instance. Otherwise, the data synchronization will fail. If you modify the Schema Name, the data will be written to the Topic you specified.
   Select DDL and DML Operations to Be Synchronized	You can select the SQL operations to be incrementally synchronized based on your actual needs.

   Configuration	Description
   Table Name	The name of the destination topic where the data to be synchronized is written. The default is the Configurations for Source and Destination Databases stage, selected in Destination Database as Topic. Important The specified Topic name must exist in the target ApsaraMQ for RocketMQ instance. Otherwise, the data synchronization will fail. If you modify the Table Name, the data will be written to the Topic you specified.
   Filter Conditions	For more information, see Set Filter Conditions.
   Select DDL and DML Operations to Be Synchronized	You can select the SQL operations to be incrementally synchronized based on your actual needs.
   Partition Key	If Rules of the ordered messages delivered to RocketMQ. is set to Deliver data based on hash values of a specified column., you can configure this parameter to specify one or more columns as the Partition Key to calculate the hash value. DTS delivers different rows to each partition of the destination Topic based on the calculated hash value.

4. Click OK.