Data Transmission Service:Synchronize data from a self-managed Oracle database to an ApsaraMQ for Kafka instance

Prerequisites

• The source self-managed Oracle database and the destination ApsaraMQ for Kafka instance are created.

  Note

  For more information about the supported versions of the source database and the destination instance, see Overview of data synchronization scenarios.

• The self-managed Oracle database is running in ARCHIVELOG mode. Archived log files are accessible, and an appropriate retention period is set for archived log files. For more information, see Managing Archived Redo Log Files.

• The supplemental logging feature is enabled for the self-managed Oracle database, and the SUPPLEMENTAL_LOG_DATA_PK and SUPPLEMENTAL_LOG_DATA_UI parameters are set to Yes. For more information, see Supplemental Logging.

• The available storage space of the destination ApsaraMQ for Kafka instance is larger than the total size of the data in the self-managed Oracle database.

• In the destination ApsaraMQ for Kafka instance, a topic is created to receive the synchronized data. For more information, see the Step 1: Create a topic section of the "Step 3: Create resources" topic.

• You are familiar with the capabilities and limits that DTS has if DTS is used to synchronize data from an Oracle database. Advanced Database & Application Migration (ADAM) is used for database evaluation. This helps you smoothly synchronize data to the cloud. For more information, see Prepare an Oracle database and Overview.

Limits

Billing

Size limit of a single record

The maximum size of a single record that can be written to Kafka is 10 MB. Therefore, if a row of source data exceeds 10 MB in size, the relevant DTS task is interrupted because DTS cannot write the record to Kafka. In this scenario, we recommend that you do not synchronize the whole tables that contain large fields but synchronize only some fields of the tables. When you configure a DTS task, you must exclude the records of these large fields. If tables that contain large fields are included in the objects of the task, you must remove the tables, add the tables to the objects again, and then set filter conditions to exclude the large fields.

Supported synchronization topologies

• One-way one-to-one synchronization

• One-way one-to-many synchronization

• One-way many-to-one synchronization

• One-way cascade synchronization

For more information about the synchronization topologies that are supported by DTS, see Synchronization topologies.

SQL operations that can be synchronized

Permissions required for 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

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

   • You can also go to the Data Synchronization Tasks page of the new DTS console.

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. In the Create Data Synchronization Task wizard, configure the source and destination databases.

   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	Database Type	The type of the source database. Select Oracle.
   	Access Method	The access method of the source database. In this example, Self-managed Database on ECS is selected. Note If your source database is a self-managed database, you must deploy the network environment for the database. For more information, see Preparation overview.
   	Instance Region	The region in which the self-managed Oracle database resides.
   	ECS Instance ID	The ID of the Elastic Compute Service (ECS) instance that hosts the self-managed Oracle database.
   	Port Number	The service port number of the self-managed Oracle database. Default value: 1521.
   	Oracle Type	The architecture of the self-managed Oracle database. If you select Non-RAC Instance, you must configure the SID parameter. If you select RAC or PDB Instance, you must configure the Service Name parameter. Important RAC instances are not supported. In this example, Non-RAC Instance is selected.
   	Database Account	The account of the self-managed Oracle database. For information about the permissions that are required for the account, see the Permissions required for database accounts section of this topic.
   	Database Password	The password of the database account.
   Destination Database	Database Type	The type of the destination database. Select Kafka.
   	Access Method	The access method of the destination database. Select Express Connect, VPN Gateway, or Smart Access Gateway. Note DTS does not provide ApsaraMQ for Kafka as an access method. You can use ApsaraMQ for Kafka as a self-managed Kafka cluster to configure data synchronization.
   	Instance Region	The region in which the destination ApsaraMQ for Kafka instance resides.
   	Connected VPC	The ID of the virtual private cloud (VPC) to which the destination ApsaraMQ for Kafka instance belongs. To obtain the VPC ID, perform the following operations: Log on to the Message Queue for Apache Kafka console and go to the Instance Details page of the ApsaraMQ for Kafka instance. In the Configuration Information section of the Instance Information tab, view the VPC ID.
   	IP Address or Domain Name	An IP address that is included in the values of the Default Endpoint parameter of the ApsaraMQ for Kafka instance. Note To obtain an IP address, perform the following operations: Log on to the Message Queue for Apache Kafka console and go to the Instance Details page of the ApsaraMQ for Kafka instance. In the Endpoint Information section of the Instance Information tab, obtain an IP address from the Default Endpoint parameter.
   	Port Number	The service port number of the ApsaraMQ for Kafka instance. Default value: 9092.
   	Database Account	The database account of the ApsaraMQ for Kafka instance. Note If the ApsaraMQ for Kafka instance is a VPC-connected instance, you do not need to configure the Database Account and Database Password parameters.
   	Database Password	The password of the database account.
   	Kafka Version	The version of the destination ApsaraMQ for Kafka instance.
   	Encryption	Specifies whether to encrypt the connection. Select Non-encrypted or SCRAM-SHA-256 based on your business and security requirements.
   	Topic	The topic that is used to receive the synchronized data. Select a topic from the drop-down list.
   	Topic That Stores DDL Information	The topic that is used to store the DDL information. Select a topic from the drop-down list. If you do not configure this parameter, the DDL information is stored in the topic that is specified by the Topic parameter.
   	Use Kafka Schema Registry	Specifies whether to use Kafka Schema Registry. Kafka Schema Registry provides a serving layer for your metadata. It provides a RESTful API to store and retrieve your Avro schemas. Valid values: No Yes If you select Yes, you must enter the URL or IP address that is registered in Kafka Schema Registry for your Avro schemas.

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 make sure that the ECS instance can access the database. If the database is deployed on multiple ECS instances, you must manually add the CIDR blocks of DTS servers to the security group rules of each ECS instance. 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 synchronization types. By default, Incremental Data Synchronization is selected. You must also select Schema Synchronization and Full Data 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.
   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 identical table 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 the following 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.
   Data Format in Kafka	The format in which data is stored in the destination ApsaraMQ for Kafka instance. If you select DTS Avro, data is parsed based on the schema definition of DTS Avro. For more information, visit GitHub. If you select SharePlex JSON, data is stored in the SharePlex JSON format. For more information, see the Shareplex Json section of the "Data formats of a Kafka cluster" topic.
   Policy for Shipping Data to Kafka Partitions	The policy for synchronizing data to Kafka partitions. Select a policy based on your business requirements. For more information, see Specify the policy for migrating data to Kafka partitions.
   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 move the objects to the Selected Objects section. Note You can select columns, tables, or databases as the objects to be synchronized. If you select tables or columns as the objects to be synchronized, DTS does not synchronize other objects such as views, triggers, and stored procedures to the destination database.
   Selected Objects	To rename an object that you want to synchronize to the destination instance, right-click the object in the Selected Objects section. For more information, see the Map the name of a single object section of the "Map object names" topic. To rename multiple objects at a time, click Batch Edit in the upper-right corner of the Selected Objects section. For more information, see the Map multiple object names at a time section of the "Map object names" topic. Note To select the SQL operations performed on a specific database or table, right-click an object in the Selected Objects section. In the dialog box that appears, select the SQL operations that you want to synchronize. For more information, see the SQL operations that can be synchronized section of this topic. To specify filter conditions to filter data, right-click a table in the Selected Objects section. In the dialog box that appears, specify the conditions. For more information, see Set filter conditions. If you use the object name mapping feature to rename an object, other objects that are dependent on the object may fail to be synchronized.

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

   Parameter	Description
   Select the dedicated cluster used to schedule the task	By default, DTS schedules tasks to shared clusters. You do not need to configure this parameter. You can purchase a dedicated cluster of specific specifications to run DTS data synchronization tasks. 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.
   The wait time before a retry when other issues occur in the source and destination databases.	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 The wait time before a retry when other issues occur in the source and destination databases. 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.
   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, no environment tag is selected.
   Actual Write Code	The encoding format in which data is written to the destination database. You can select an encoding format based on your business requirements.
   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 configure alerting. Yes: configures alerting. In this case, you must also configure the alert threshold and alert contacts. For more information, see Configure monitoring and alerting.

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

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. Pay-as-you-go: A pay-as-you-go instance is billed on an hourly basis. We recommend that you select the pay-as-you-go billing method 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	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 provide 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 Specifications of data synchronization instances.
   	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 displayed only if you select the subscription billing method.Subscription

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.