All Products
Search
Document Center

Data Transmission Service:Synchronize data from a PolarDB-X 2.0 instance to a Tablestore instance

Last Updated:Oct 30, 2023

This topic describes how to synchronize data from a PolarDB-X 2.0 instance to a Tablestore instance by using Data Transmission Service (DTS).

Prerequisites

  • A Tablestore instance is created. For more information, see Use Tablestore.

  • The AccessKey ID and AccessKey secret of the Alibaba Cloud account to which the Tablestore instance belongs are obtained. For more information, see Create an AccessKey pair.

Limits

Category

Description

Limits on the source database

  • The tables to be synchronized must have PRIMARY KEY or UNIQUE constraints, and all fields must be unique. Otherwise, the destination database may contain duplicate data records.

  • If you select tables as the objects to be synchronized and you need to edit the tables in the destination database, such as renaming tables or columns, you can synchronize up to 5,000 tables in a single data synchronization task. If you run a task to synchronize more than 5,000 tables, a request error occurs. In this case, we recommend that you configure multiple tasks to synchronize the tables or configure a task to synchronize the entire database.

  • If the name of a table to be synchronized in the source PolarDB-X 2.0 instance contains uppercase letters, only schema synchronization is supported for the table.

  • By default, the binary logging feature is enabled for the PolarDB-X 2.0 instance. The binlog_row_image parameter must be set to full. For more information, see Parameter settings. Otherwise, error messages are returned during the precheck and the data synchronization task cannot be started.

Other limits

  • Before you synchronize data, evaluate the impact of data synchronization on the performance of the source and destination databases. We recommend that you synchronize data during off-peak hours. During initial full data synchronization, DTS uses the read and write resources of the source and destination databases. This may increase the loads on the database servers.

  • During initial full data synchronization, concurrent INSERT operations cause fragmentation in the tables of the destination database. After initial full data synchronization is complete, the size of the used tablespace of the destination database is larger than that of the source database.

  • During data synchronization, we recommend that you use only DTS to write data to the destination database. This prevents data inconsistency between the source and destination databases.

  • You can synchronize at most 64 tables to the Tablestore instance. Otherwise, an error message is returned. If you want to synchronize more than 64 tables to the Tablestore instance, contact technical support of Tablestore to increase the limit on the number of tables for the destination Tablestore instance.

  • The names of the tables and columns to be synchronized must comply with the naming conventions of the Tablestore instance.

    • The name of a table or column can contain letters, digits, and underscores (_). The name must start with a letter or an underscore (_).

    • The name of a table or column must be 1 to 255 characters in length.

Billing

Synchronization typeTask configuration fee
Schema synchronization and full data synchronizationFree of charge.
Incremental data synchronizationCharged. For more information, see Billing overview.

SQL operations that can be incrementally synchronized

Operation type

SQL statement

DML

INSERT, UPDATE, and DELETE

Procedure

  1. Go to the Data Synchronization Tasks page.

    1. Log on to the DMS console.

    2. In the top navigation bar, click DTS.

    3. In the left-side navigation pane, choose DTS (DTS) > Data Synchronization.

    Note
  2. From the drop-down list to the right of Data Synchronization Tasks, select the region in which you want to create the data synchronization task.

    Note

    If you use the new DTS console, select the region in which you want to create the data synchronization task in the upper-left corner of the page.

  3. Click Create Task. Configure the source and destination databases.

    Section

    Parameter

    Description

    N/A

    Task Name

    The name of the task. DTS automatically assigns a name to the task. 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 an existing DMS database instance. (Optional. If you have not registered a DMS database instance, ignore this option and configure database settings in the section below.)

    The database instance that you want to use. You can choose whether to select an existing instance based on your business requirements.

    • If you select an existing instance, DTS automatically populates the parameters for the database.

    • If you do not select an existing instance, you must manually configure parameters for the database.

    Database Type

    The type of the source database. Select PolarDB-X 2.0.

    Access Method

    The access method of the source database. Select Alibaba Cloud Instance.

    Instance Region

    The region in which the source PolarDB-X 2.0 instance resides.

    Replicate Data Across Alibaba Cloud Accounts

    Specifies whether to synchronize data across Alibaba Cloud accounts. In this example, No is selected.

    Instance ID

    The ID of the source PolarDB-X 2.0 instance.

    Database Account

    The database account of the source PolarDB-X 2.0 instance. The account must have the SELECT permission on the objects to be synchronized, the REPLICATION SLAVE permission, and the REPLICATION CLIENT permission.

    Note

    For more information, see Manage database accounts and the Permissions required for an account to synchronize data section of the "Data synchronization tools for PolarDB-X" topic.

    Database Password

    The password of the database account.

    Destination Database

    Select an existing DMS database instance. (Optional. If you have not registered a DMS database instance, ignore this option and configure database settings in the section below.)

    The database instance that you want to use. You can choose whether to select an existing instance based on your business requirements.

    • If you select an existing instance, DTS automatically populates the parameters for the database.

    • If you do not select an existing instance, you must manually configure parameters for the database.

    Database Type

    The type of the destination database. Select Tablestore.

    Access Method

    The access method of the destination database. Select Alibaba Cloud Instance.

    Instance Region

    The region in which the destination Tablestore instance resides.

    Instance ID

    The ID of the destination Tablestore instance.

    AccessKey ID of Alibaba Cloud Account

    The AccessKey ID of the Alibaba Cloud account to which the destination Tablestore instance belongs.

    Important

    If you enter the AccessKey ID of a Resource Access Management (RAM) user, the data synchronization task may fail due to insufficient permissions.

    AccessKey Secret of Alibaba Cloud Account

    The AccessKey secret of the Alibaba Cloud account to which the destination Tablestore instance belongs.

  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 ensure that the ECS instance can access the database. 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 to the security settings of on-premises databases.

    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 the advanced settings.

    Parameter

    Description

    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 selected objects from the source instance to the destination instance. 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

      You can use the object name mapping feature to rename the tables that are synchronized to the destination database. You can use this feature if the source and destination databases contain identical table names and the tables in the destination database cannot be deleted or renamed. 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 schemas, and a data record has the same primary key value as an existing data record in the destination 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, only some columns are synchronized, or the data synchronization task fails. Operate with caution.

    Operation Types

    The types of operations that you want to synchronize based on your business requirements. All operation types are selected by default.

    Processing Policy of Dirty Data

    The processing policy for handling data write errors. Valid values:

    • Skip

    • Block

    Data Write Mode

    The mode in which data is written. Valid values:

    • Overwrite Row: The UpdateRowChange operation is performed to overwrite rows in the Tablestore instance.

    • Update Row: The PutRowChange operation is performed to update rows in the Tablestore instance.

    Batch Write Mode

    The operation used to write multiple rows of data to the Tablestore instance at a time. Valid values:

    • BulkImportRequest: Data is written offline.

    • BatchWriteRowRequest: Data is written in batches.

    Note

    To achieve higher read and write efficiency and reduce your costs of using the Tablestore instance, we recommend that you select BulkImportRequest.

    More

    You can click More to configure the following parameters based on your business requirements:

    • Queue Size: the length of the queue for writing data to the Tablestore instance.

    • Thread Quantity: the number of callback threads for writing data to the Tablestore instance.

    • Concurrency: the maximum number of concurrent callback threads for writing data to the Tablestore instance.

    • Buckets: the maximum number of concurrent requests for the Tablestore instance.

      Note

      The value of the Buckets parameter must be less than or equal to the value of the Concurrency parameter.

    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 Rightwards arrow icon to add the objects to the Selected Objects section.

    Note
    • You can select tables or databases as the objects to be synchronized. If you select tables as the objects to be synchronized, DTS does not synchronize other objects such as views, triggers, or stored procedures to the destination database.

    • If you select Tablestore as the destination database type, you can synchronize tables only in a single database. You can select only one database or multiple tables in the same 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 Map the name of a single object.

    • To rename multiple objects at a time, click Batch Edit in the upper-right corner of the Selected Objects section. For more information, see Map multiple object names at a time.

    Note
    • The database name mapping feature is not supported. You can use the name mapping feature to rename tables or columns only if you select tables as the objects to be synchronized. 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.

    • When you use the column name mapping feature, you can modify the data types of the corresponding columns in the destination Tablestore instance.

    • To specify WHERE 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 Use SQL conditions to filter data.

  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 specified specifications to run DTS synchronization tasks. For more information, see What is a DTS dedicated cluster.

    Set Alerts

    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:

    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 the 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 set different retry time ranges for multiple DTS tasks that have the same source or destination database, the shortest retry time range that is set 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 the 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 Connection parameter.

    Enable Throttling for Full Data Migration

    During full data migration, DTS uses the read and write resources of the source and destination databases. This may increase the loads of the database servers. You can configure the Queries per second (QPS) to the source database, RPS of Full Data Migration, and BPS of Full Data Migration parameters for full data synchronization tasks to reduce the pressure on the destination database.

    Note

    This parameter can be configured only if Full Data Synchronization is selected as Synchronization Types.

    Enable Throttling for Incremental Data Synchronization

    You can configure the RPS of Incremental Data Migration and BPS of Incremental Data Migration parameters for incremental data synchronization tasks to reduce the pressure on the destination database.

    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.

    Configure ETL

    The extract, transform, and load (ETL) feature is not supported. In this example, No is selected.

    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.

    • 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, specific features such as physical backup and cloning of the source database may be affected.

  7. Click Next: Configure Database and Table Fields. In the Note dialog box, click OK.

    By default, DTS specifies the primary key column of the source table for the Primary Key Column parameter. You can change the primary key column after you set the Definition Status parameter to All.

    Note

    In the Primary Key Column field, you can specify multiple columns to form a composite primary key.

  8. Click Next: Save Task Settings and Precheck in the lower part of the page.

    You can move the pointer over Next: Save Task Settings and Precheck and click Preview OpenAPI parameters to view the parameter settings of the API operation that is called to configure the instance.

    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 troubleshoot the issues based on the causes, 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 issues. 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.

  9. Wait until the success rate becomes 100%. Then, click Next: Purchase Instance.

  10. 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 the instance 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 charged 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 instance, you can release the pay-as-you-go instance to reduce costs.

    Resource Group

    The resource group on which the instance is run. 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 scenario. For more information, see Specifications of data synchronization instances.

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

  11. Read and select the check box to agree to the Data Transmission Service (Pay-as-you-go) Service Terms.

  12. Click Buy and Start to start the data synchronization task. You can view the progress of the task in the task list.