You can use DTS to stream data from AnalyticDB for PostgreSQL instances to Message Queue for Apache Kafka.
This feature is in beta testing. To use it, please Submit a ticket to request access.
Scope
You must create a topic in the target Message Queue for Apache Kafka instance to receive synchronized data. For more information, see Step 1: Create a topic.
The target Message Queue for Apache Kafka instance must have more storage space than is used by the source AnalyticDB for PostgreSQL instance.
Usage notes
Source restrictions
Type | Limits |
Before synchronization |
|
During synchronization |
|
Destination restrictions
Type | Limits |
Before synchronization |
|
During synchronization |
|
Supported synchronization SQL |
|
Supported synchronization objects |
|
Pricing
|
Synchronization type |
Fees |
|
Schema synchronization and full synchronization |
Free. |
|
Incremental synchronization |
Fees apply. See billing overview. |
Procedure
Go to the data synchronization task list page in the destination region. You can do this in one of two ways.
DTS console
Log on to the DTS console.
In the navigation pane on the left, click Data Synchronization.
In the upper-left corner of the page, select the region where the synchronization instance is located.
DMS console
NoteThe actual steps may vary depending on the mode and layout of the DMS console. For more information, see Simple mode console and Customize DMS console layout and style.
Log on to the DMS console.
In the top menu bar, choose .
To the right of Data Synchronization Tasks, select the region of the synchronization instance.
-
Click Create Task to navigate to the task configuration page.
Configure the source and destination databases.
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
Select the registered database instance with DTS from the drop-down list. The database information below is automatically configured.
NoteIn the DMS console, this configuration item is Select a DMS database instance.
If you have not registered the database instance or do not need to use a registered instance, manually configure the database information below.
Database Type
Select AnalyticDB for PostgreSQL.
Access Method
Select Alibaba Cloud Instance.
Instance Region
Select the region of the source AnalyticDB for PostgreSQL instance.
Replicate Data Across Alibaba Cloud Accounts
In this example, data is synchronized within the same Alibaba Cloud account. Select No.
Instance ID
Select the instance ID of the source AnalyticDB for PostgreSQL instance.
Database Name
Enter the name of the source database to synchronize.
Database Account
Enter the database account of the source AnalyticDB for PostgreSQL instance. The account must have read permissions on the objects to synchronize.
Database Password
Enter the password for the specified database account.
Destination Database
Select Existing Connection
Select the registered database instance with DTS from the drop-down list. The database information below is automatically configured.
NoteIn the DMS console, this configuration item is Select a DMS database instance.
If you have not registered the database instance or do not need to use a registered instance, manually configure the database information below.
Database Type
Select Kafka.
Access Method
Select Alibaba Cloud Instance.
Instance Region
Select the region of the target Message Queue for Apache Kafka instance.
Kafka Instance ID
Select the instance ID of the target Message Queue for Apache Kafka instance.
Encryption
Based on your business and security requirements, select Non-encrypted or SCRAM-SHA-256.
Topic
Select the topic to receive the synchronized data.
Use Kafka Schema Registry
Kafka Schema Registry provides a RESTful interface for storing and retrieving Avro schemas.
No: Does not use Kafka schema registry.
Yes: Uses Kafka schema registry. You must enter the URL or IP address where the Avro schema is registered in Kafka schema registry.
After completing the configuration, click Test Connectivity and Proceed at the bottom of the page.
NoteEnsure that you add the CIDR blocks of the DTS servers (either automatically or manually) to the security settings of both the source and destination databases to allow access. For more information, see Add the IP address whitelist of DTS servers.
If the source or destination is a self-managed database (i.e., the Access Method is not Alibaba Cloud Instance), you must also click Test Connectivity in the CIDR Blocks of DTS Servers dialog box.
Configure the task objects.
On the Configure Objects page, specify the objects to synchronize.
Parameter
Description
Synchronization Types
DTS always selects Incremental Data Synchronization. By default, you must also select Schema Synchronization and Full Data Synchronization. After the precheck, DTS initializes the destination cluster with the full data of the selected source objects, which serves as the baseline for subsequent incremental synchronization.
NoteWhen the Access Method for the target Kafka instance is set to Alibaba Cloud Instance, Schema Synchronization is not supported.
Processing Mode of Conflicting Tables
Precheck and Report Errors: Checks for tables with the same names in the destination database. If any tables with the same names are found, an error is reported during the precheck and the data synchronization task does not start. Otherwise, the precheck is successful.
NoteIf you cannot delete or rename the table with the same name in the destination database, you can map it to a different name in the destination. For more information, see Object name mapping.
Ignore Errors and Proceed: Skips the check for tables with the same name in the destination database.
WarningSelecting Ignore Errors and Proceed may cause data inconsistency and put your business at risk. For example:
If the table schemas are consistent and a record in the destination database has the same primary key or unique key value as a record in the source database:
During full data synchronization, DTS retains the destination record and skips the source record.
During incremental synchronization, DTS overwrites the destination record with the source record.
If the table schemas are inconsistent, data initialization may fail. This can result in only partial data synchronization or a complete synchronization failure. Use with caution.
Data Format in Kafka
Select the format for storing data synchronized to the Kafka instance.
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 examples.
If you select Canal JSON, see Canal JSON format for parameter descriptions and examples.
Kafka Data Compression Format
Select a compression format for Kafka messages.
LZ4 (Default): Low compression ratio, high compression speed.
GZIP: High compression ratio, low compression speed.
NoteThis format has high CPU overhead.
Snappy: Medium compression ratio, medium compression speed.
Policy for Shipping Data to Kafka Partitions
Select a strategy based on your business requirements.
Message acknowledgement mechanism
Select a message acknowledgment mechanism based on your business requirements.
Topic That Stores DDL Information
Select the topic for storing DDL information.
NoteIf you do not select a topic, DDL information is stored in the data-receiving topic by default.
Capitalization of Object Names in Destination Instance
Configure the case-sensitivity policy for database, table, and column names in the destination instance. By default, the DTS default policy is selected. You can also choose to use the default policy of the source or destination database. For more information, see Case policy for destination object names.
Source Objects
In the Source Objects box, click the objects, and then click
to move them to the Selected Objects box.NoteYou can select objects at the table level.
Selected Objects
No additional configuration is required. You can use the mapping feature to set the topic name, number of topic partitions, or column names for the source table in the target Kafka instance.
NoteTo select the SQL operations to be synchronized at the schema or table level, right-click the object in the Selected Objects pane and select the desired SQL operations in the dialog box that appears.
If you use the object name mapping feature, other objects that depend on the mapped object may fail to be synchronized.
Click Next: Advanced Settings.
Parameter
Description
Dedicated Cluster for Task Scheduling
By default, DTS uses a shared cluster for tasks, so you do not need to make a selection. For greater task stability, you can purchase a dedicated cluster to run the DTS synchronization task. For more information, see What is a DTS dedicated cluster?.
Enable Encryption of Data In-Transit?
Encrypted data transmission may affect synchronization performance. Enable this feature based on your security requirements.
No (Default)
Yes
Retry Time for Failed Connections
If the connection to the source or destination database fails after the synchronization task starts, 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 1,440 minutes. We recommend a duration of 30 minutes or more. If the connection is restored within this period, the task resumes automatically. Otherwise, the task fails.
NoteIf multiple DTS instances (e.g., Instance A and B) share a source or destination, DTS uses the shortest configured retry duration (e.g., 30 minutes for A, 60 for B, so 30 minutes is used) for all instances.
DTS charges for task runtime during connection retries. Set a custom duration based on your business needs, or release the DTS instance promptly after you release the source/destination instances.
Retry Time for Other Issues
If a non-connection issue (e.g., a DDL or DML execution error) occurs, DTS reports an error and immediately retries the operation. The default retry duration is 10 minutes. You can also customize the retry time to a value from 1 to 1,440 minutes. We recommend a duration of 10 minutes or more. If the related operations succeed within the set retry time, the synchronization task automatically resumes. Otherwise, the task fails.
ImportantThe value of Retry Time for Other Issues must be less than that of Retry Time for Failed Connections.
Enable Throttling for Full Data Synchronization
During full data synchronization, DTS consumes read and write resources from the source and destination databases, which can increase their load. To mitigate pressure on the destination database, you can limit the migration rate by setting Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s).
NoteThis parameter is available only if Synchronization Types is set to Full Data Synchronization.
You can also adjust the rate of full data synchronization when the synchronization instance is running.
Enable Throttling for Incremental Data Synchronization
You can also limit the incremental synchronization rate to reduce pressure on the destination database by setting RPS of Incremental Data Synchronization and Data synchronization speed for incremental synchronization (MB/s).
Environment Tag
You can select an environment tag to identify the instance as needed. This example does not require a selection.
Scene Label
You can select a scenario tag to identify the use case of the instance as needed. The scenario tag does not affect the normal operation of the task. This example does not require a selection.
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
Choose whether to set up alerts. If the synchronization fails or the latency exceeds the specified threshold, DTS sends a notification to the alert contacts.
No: No alerts are configured.
Yes: Configures alerts. You must also set the alert threshold and alert notifications. For more information, see Configure monitoring and alerting during task configuration.
Save the task and perform a precheck.
To view the parameters for configuring this instance via an API operation, hover over the Next: Save Task Settings and Precheck button and click Preview OpenAPI parameters in the tooltip.
If you have finished viewing the API parameters, click Next: Save Task Settings and Precheck at the bottom of the page.
NoteBefore a synchronization task starts, DTS performs a precheck. You can start the task only if the precheck passes.
If the precheck fails, click View Details next to the failed item, fix the issue as prompted, and then rerun the precheck.
If the precheck generates warnings:
For non-ignorable warning, click View Details next to the item, fix the issue as prompted, and run the precheck again.
For ignorable warnings, you can bypass them by clicking Confirm Alert Details, then Ignore, and then OK. Finally, click Precheck Again to skip the warning and run the precheck again. Ignoring precheck warnings may lead to data inconsistencies and other business risks. Proceed with caution.
Purchase the instance.
When the Success Rate reaches 100%, click Next: Purchase Instance.
On the Purchase page, select the billing method and link specifications for the data synchronization instance. For more information, see the following table.
Category
Parameter
Description
New Instance Class
Billing Method
Subscription: You pay upfront for a specific duration. This is cost-effective for long-term, continuous tasks.
Pay-as-you-go: You are billed hourly for actual usage. This is ideal for short-term or test tasks, as you can release the instance at any time to save costs.
Resource Group Settings
The resource group to which the instance belongs. The default is default resource group. For more information, see What is resource management?.
Instance Class
DTS offers synchronization specifications at different performance levels that affect the synchronization rate. Select a specification based on your business requirements. For more information, see Data synchronization link specifications.
Subscription Duration
In subscription mode, select the duration and quantity of the instance. Monthly options range from 1 to 9 months. Yearly options include 1, 2, 3, or 5 years.
NoteThis option appears only when the billing method is Subscription.
Read and select the checkbox for Data Transmission Service (Pay-as-you-go) Service Terms.
Click Buy and Start, and then click OK in the OK dialog box.
You can monitor the task progress on the data synchronization page.
FAQ
Can I change the Kafka Data Compression Format?
Yes, you can use the Modify Synchronization Objects feature to make the change.
Can I change the Message acknowledgement mechanism?
Yes, you can use the Modify Synchronization Objects feature to make the change.