Learn how to use Data Transmission Service (DTS) to migrate data from a PolarDB for PostgreSQL (Compatible with Oracle) cluster to a Message Queue for Apache Kafka instance.
Prerequisites
-
In the source PolarDB for PostgreSQL (Oracle-compatible) cluster, the wal_level parameter must be set to logical to add the information required for logical decoding to write-ahead logging (WAL). For more information, see Set cluster parameters.
-
Create a destination Alibaba Cloud Message Queue for Kafka instance with more storage space than is used by the source PolarDB for PostgreSQL (Compatible with Oracle) instance.
NoteFor information about the supported versions for the source and destination, see Migration solutions overview.
-
Create a topic in the destination Alibaba Cloud Message Queue for Kafka instance to receive migrated data. For instructions, see Step 1: Create a topic.
Limitations
Type | Description |
Source database limits |
|
Other limits |
|
Billing
Migration type | Link configuration fees | Data transfer cost |
Schema migration and full data migration | Free of charge. | You are charged for data transfer when you migrate data out of Alibaba Cloud over the public network. For more information, see Billing overview. |
Incremental data migration | Charged. For more information, see Billing overview. |
Supported SQL operations for incremental migration
|
Type |
SQL statement |
|
DML |
INSERT, UPDATE, and DELETE |
|
DDL |
Important
|
Database account permissions
|
Database |
Permissions |
References |
|
PolarDB for PostgreSQL (Compatible with Oracle) cluster |
privileged account |
Procedure
-
Navigate to the migration task list page for the destination region using one of the following methods.
From the DTS console
-
Log on to the Data Transmission Service (DTS) console.
-
In the navigation pane on the left, click Data Migration.
-
In the upper-left corner of the page, select the region where the migration instance is located.
From the DMS console
NoteThe actual operations may vary based on the mode and layout of the DMS console. For more information, see Simple mode console and Customize the layout and style of the DMS console.
-
Log on to the Data Management (DMS) console.
-
In the top menu bar, choose .
-
To the right of Data Migration Tasks, select the region where the migration instance is located.
-
-
Click Create Task to navigate to the task configuration page.
-
Configure the source and destination databases.
NoteFor information about how to obtain the parameters of the destination Message Queue for Apache Kafka instance, see Configure parameters for a Message Queue for Apache Kafka instance.
Category
Parameter
Description
N/A
Task Name
DTS automatically generates a task name. We recommend that you specify a descriptive name for easy identification. The name does not need to be unique.
Source Database
Select Existing Connection
-
To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured.
NoteIn the DMS console, this parameter is named Select a DMS database instance..
-
If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
Database Type
Select PolarDB (Compatible with Oracle).
Access Method
Select Alibaba Cloud Instance.
Instance Region
Select the region where the source PolarDB (Compatible with Oracle) cluster is located.
Replicate Data Across Alibaba Cloud Accounts
In this example, data is migrated within the same Alibaba Cloud account. Select No.
Instance ID
Select the instance ID of the source PolarDB (Compatible with Oracle) cluster.
Database Name
Enter the name of the database in the source PolarDB (Compatible with Oracle) cluster that contains the objects to migrate.
Database Account
Enter the database account for the source PolarDB (Compatible with Oracle) cluster. For information about the required permissions, see Required permissions for the database account.
Database Password
Enter the password for the specified database account.
Destination Database
Select Existing Connection
-
To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured.
NoteIn the DMS console, this parameter is named Select a DMS database instance..
-
If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
Database Type
Select Kafka.
Access Method
Select Express Connect, VPN Gateway, or Smart Access Gateway.
NoteIn this step, the Message Queue for Apache Kafka instance is configured as a self-managed Kafka database for the migration instance.
Instance Region
Select the region where the destination Message Queue for Apache Kafka instance is located.
Connected VPC
Select the ID of the Virtual Private Cloud (VPC) where the destination Message Queue for Apache Kafka instance is located.
Domain Name or IP
Enter any IP address from the Default Endpoint of the destination Message Queue for Apache Kafka instance.
Port Number
Enter the service port of the destination Message Queue for Apache Kafka instance. The default value is 9092.
Database Account
You do not need to configure these parameters in this example.
Database Password
Kafka Version
Select the version that corresponds to your Kafka instance.
Encryption
Based on your business and security requirements, select Non-encrypted or SCRAM-SHA-256.
Topic
From the drop-down list, select the Topic to receive data.
Use Kafka Schema Registry
Kafka Schema Registry is a service layer for your metadata. It provides a RESTful API to store and retrieve Avro schemas.
-
No: Do not use Kafka Schema Registry.
-
Yes: Use Kafka Schema Registry. In the URL or IP Address of Schema Registry field, enter the URL or IP address that is registered in Kafka Schema Registry for your Avro schema.
-
-
After you complete the configuration, click Test Connectivity and Proceed at the bottom of the page.
Note-
Ensure that the IP address segment of the DTS service is 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 DTS server IP addresses to a whitelist.
-
If the source or destination database is a self-managed database (the Access Method is not Alibaba Cloud Instance), you must also click Test Connectivity in the CIDR Blocks of DTS Servers dialog box that appears.
-
-
Configure the task objects.
-
On the Configure Objects page, configure the objects that you want to migrate.
Parameter
Description
Migration Types
-
If you need to perform only full data migration, select both Schema Migration and Full Data Migration.
-
For zero-downtime migration, select Schema Migration, Full Data Migration, and Incremental Data Migration.
Note-
If the Access Method for the destination Kafka instance is Alibaba Cloud Instance, Schema Migration is not supported.
-
If you do not select Incremental Data Migration, do not write new data to the source instance during data migration to ensure data consistency.
Processing Mode of Conflicting Tables
-
Precheck and Report Errors: Checks whether tables with the same names exist in the destination database. If no tables with the same names exist, the precheck is passed. If tables with the same names exist, an error is reported during the precheck, and the data migration task does not start.
NoteIf a table in the destination database has the same name but cannot be easily deleted or renamed, you can change the name of the table in the destination database. For more information, see Object name mapping.
-
Ignore Errors and Proceed: Skips the check for tables with the same names.
WarningSelecting Ignore Errors and Proceed may cause data inconsistency and business risks. For example:
-
If the table schemas are consistent and a record in the destination database has the same primary key value as a record in the source database:
-
During full migration, DTS keeps the record in the destination database. The record from the source database is not migrated.
-
During incremental migration, DTS does not keep the record in the destination database. The record from the source database overwrites the record in the destination database.
-
-
If the table schemas are inconsistent, only some columns of data may be migrated, or the migration may fail. Proceed with caution.
-
Data Format in Kafka
Select the format for storing data in the Kafka instance based on your business requirements.
-
If you select Canal JSON, see Canal JSON for parameter descriptions and examples.
NoteCurrently, only the China (Qingdao) and China (Beijing) regions support the Canal JSON format.
-
If you select DTS Avro, you must parse the data based on the DTS Avro schema definition. For more information, see DTS Avro Schema Definition and DTS Avro Deserialization Example.
-
If you select Shareplex JSON, see Shareplex JSON for parameter descriptions and examples.
Kafka Data Compression Format
Select the compression format for Kafka messages based on your requirements.
-
LZ4 (Default): Offers a lower compression ratio and a higher compression speed.
-
GZIP: Offers a higher compression ratio and a lower compression speed.
NoteThis format consumes more CPU resources.
-
Snappy: Offers a moderate compression ratio and a moderate compression speed.
Policy for Shipping Data to Kafka Partitions
Select a policy based on your business requirements.
Message acknowledgement mechanism
Select a message acknowledgment mechanism based on your business requirements.
Topic That Stores DDL Information
From the drop-down list, select the Topic to store DDL information.
NoteIf you do not select a Topic, DDL information is stored by default in the Topic that is selected to receive data.
Capitalization of Object Names in Destination Instance
You can configure the case sensitivity policy for the names of migrated objects, such as databases, tables, and columns, in the destination instance. By default, DTS default policy is selected. You can also choose to keep the case sensitivity consistent with the default policy of the source or destination database. For more information, see Case sensitivity of object names in the destination database.
Source Objects
In the Source Objects box, click the objects to migrate, and then click
to move them to the Selected Objects box.NoteYou can select tables as the migration objects.
Selected Objects
No additional configurations are required in this example. You can use the mapping feature to set the Topic name, number of partitions in the Topic, and partition key for the source table in the destination Kafka instance. For more information, see Mapping information.
Note-
If you use the object name mapping feature, other objects that depend on the mapped object may fail to be migrated.
-
To select the SQL operations for incremental migration, right-click a migration object in the Selected Objects box, and select the desired SQL operations in the dialog box that appears.
-
-
Click Next: Advanced Settings to configure advanced parameters.
Parameter
Description
Dedicated Cluster for Task Scheduling
By default, DTS schedules tasks on a shared cluster. You do not need to select one. If you want more stable tasks, you can purchase a dedicated cluster to run DTS migration tasks.
Retry Time for Failed Connections
After the migration task starts, if the connection to the source or destination database fails, DTS reports an error and immediately begins to retry the connection. The default retry duration is 720 minutes. You can customize the retry time to a value from 10 to 1440 minutes. We recommend that you set the duration to more than 30 minutes. If DTS reconnects to the source and destination databases within the specified duration, the migration task automatically resumes. Otherwise, the task fails.
Note-
For multiple DTS instances that share the same source or destination, the network retry time is determined by the setting of the last created task.
-
Because you are charged for the task during the connection retry period, we recommend that you customize the retry time based on your business needs, or release the DTS instance as soon as possible after the source and destination database instances are released.
Retry Time for Other Issues
After the migration task starts, if a non-connectivity issue, such as a DDL or DML execution exception, occurs in the source or destination database, DTS reports an error and immediately begins to retry the operation. The default retry duration is 10 minutes. You can customize the retry time to a value from 1 to 1440 minutes. We recommend that you set the duration to more than 10 minutes. If the related operations succeed within the specified retry duration, the migration task automatically resumes. Otherwise, the task fails.
ImportantThe value of Retry Time for Other Issues must be less than the value of Retry Time for Failed Connections.
Enable Throttling for Full Data Migration
During full migration, DTS consumes read and write resources on the source and destination databases, which may increase the database load. If required, you can enable throttling for the full migration task. You can set Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s) to reduce the load on the destination database.
Note-
This configuration item is available only if you select Full Data Migration for Migration Types.
-
You can also adjust the full migration speed after the migration instance is running.
Enable Throttling for Incremental Data Migration
If required, you can also choose to set speed limits for the incremental migration task. You can set RPS of Incremental Data Migration and Data migration speed for incremental migration (MB/s) to reduce the load on the destination database.
Note-
This configuration item is available only if you select Incremental Data Migration for Migration Types.
-
You can also adjust the incremental migration speed after the migration instance is running.
Environment Tag
You can select an environment tag to identify the instance based on your business requirements. No tag needs to be selected in this example.
Configure ETL
Choose whether to enable the extract, transform, and load (ETL) feature. For more information, see What is ETL? Valid values:
-
Yes: Enables the ETL feature. Enter data processing statements in the code editor. For more information, see Configure ETL in a data migration or data synchronization task.
-
No: Disables the ETL feature.
Monitoring and Alerting
Select whether to set alerts and receive alert notifications based on your business needs.
-
No: Does not set an alert.
-
Yes: Configure alerts by setting an alert threshold and an alert contact. If a migration fails or the latency exceeds the threshold, the system sends an alert notification.
-
-
-
Save the task and run a precheck.
-
To view the parameters for configuring this instance when you call the API operation, move the pointer over the Next: Save Task Settings and Precheck button and click Preview OpenAPI parameters in the bubble that appears.
-
If you do not need to view or have finished viewing the API parameters, click Next: Save Task Settings and Precheck at the bottom of the page.
Note-
Before the migration task starts, DTS performs a precheck. The task starts only after it passes the precheck.
-
If the precheck fails, click View Details next to the failed check item, fix the issue based on the prompt, and then run the precheck again.
-
If a warning is reported during the precheck:
-
For check items that cannot be ignored, click View Details next to the failed item, fix the issue based on the prompt, and then run the precheck again.
-
For check items that can be ignored, you can click Confirm Alert Details, Ignore, OK, and Precheck Again to skip the alert item and run the precheck again. If you choose to ignore a warning, it may cause issues such as data inconsistency and pose risks to your business.
-
-
-
Purchase the instance.
-
When the Success Rate is 100%, click Next: Purchase Instance.
-
On the Purchase page, select the link specification for the data migration instance. For more information, see the following table.
Category
Parameter
Description
New Instance Class
Resource Group Settings
Select the resource group to which the instance belongs. The default value is default resource group. For more information, see What is Resource Management?
Instance Class
DTS provides migration specifications with different performance levels. The link specification affects the migration speed. You can select a specification based on your business scenario. For more information, see Data migration link specifications.
-
After the configuration is complete, read and select Data Transmission Service (Pay-as-you-go) Service Terms.
-
Click Buy and Start. In the OK dialog box that appears, click OK.
You can view the progress of the migration task on the Data Migration Tasks list page.
Note-
If the migration task does not include incremental migration, it stops automatically after the full migration is complete. After the task stops, its Status changes to Completed.
-
If the migration task includes incremental migration, it does not stop automatically. The incremental migration task continues to run. While the incremental migration task is running, the Status of the task is Running.
-
-
Mapping information
-
In the Selected Objects area, hover over the target topic name (at the table level).
-
Click Edit next to the target topic name.
-
In the Edit Table dialog box, configure the mapping information.
Note-
The dialog box is titled Edit Schema at the schema level and Edit Table at the table level. The Edit Schema dialog box contains fewer parameters.
-
If you do not migrate an entire schema, you cannot modify Name of target Topic and Number of Partitions in the Edit Schema dialog box.
Parameter
Description
Name of target Topic
The name of the target topic that receives data from the source table. By default, this is the Topic you selected in the Destination Database section during the Configurations for Source and Destination Databases step.
Important-
For an Alibaba Cloud Message Queue for Apache Kafka instance, the specified topic must already exist. Otherwise, the data migration fails. For a self-managed Kafka database, if the migration task is configured to create the schema and table structure, DTS attempts to create the specified topic.
-
If you modify the Name of target Topic, data is written to the new topic.
Filter Conditions
For more information, see Set filter conditions.
Number of Partitions
Specifies the number of partitions for the target topic.
Partition Key
If you set the Policy for Shipping Data to Kafka Partitions parameter to Ship Data to Separate Partitions Based on Hash Values of Primary Keys, you must configure this parameter. Specify one or more columns as the partition key. DTS calculates a hash value from the key and uses that value to distribute rows across partitions in the target topic. Otherwise, this policy is not applied during the incremental write phase.
NoteYou can select a Partition Key only in the Edit Table dialog box.
-
-
Click OK.