Synchronize data from a PolarDB-X 1.0 instance to an Elasticsearch cluster - Data Transmission Service

This topic describes how to synchronize data from a PolarDB-X 1.0 instance to an Elasticsearch cluster by using Data Transmission Service (DTS).

Prerequisites

The storage type of the source PolarDB-X 1.0 instance is ApsaraDB RDS for MySQL, including custom ApsaraDB RDS instances and purchased ApsaraDB RDS instances. PolarDB for MySQL is not supported as the storage type.
The destination Elasticsearch cluster is created. For more information, see Create an Alibaba Cloud Elasticsearch cluster.
The available storage space of the destination Elasticsearch cluster is larger than the total size of the data in the source PolarDB-X 1.0 instance.

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. The tables that only have UNIQUE constraints do not support schema synchronization. Therefore, we recommend that you synchronize the tables that have PRIMARY KEY constraints. The tables that have secondary indexes cannot be synchronized. If you select tables as the objects to be synchronized and you need to modify the tables in the destination database, such as renaming tables or columns, you can synchronize up to 1,000 tables in a single data synchronization task. If you run a task to synchronize more than 1,000 tables, a request error occurs. In this case, we recommend that you configure multiple tasks to synchronize the tables in batches or configure a task to synchronize the entire database. The ApsaraDB RDS for MySQL instances attached to the PolarDB-X 1.0 instance must meet the following requirements for binary logs: By default, the binary logging feature is enabled for an ApsaraDB RDS for MySQL instance. Make sure that the binlog_row_image parameter is set to full. For more information, see View the parameters of an ApsaraDB RDS for MySQL instance. Otherwise, error messages are returned during the precheck and the data synchronization task cannot be started. If you perform only incremental data synchronization, the binary logs of the source database must be retained for at least 24 hours. If you perform both full data synchronization and incremental data synchronization, the binary logs of the source database must be retained for at least seven days. Otherwise, DTS may fail to obtain the binary logs, which causes the task to fail, or even data inconsistency and data loss. After full data synchronization is complete, you can set the retention period to more than 24 hours. Make sure that you set the retention period of binary logs based on the preceding requirements. Otherwise, the Service Level Agreement (SLA) of DTS does not guarantee service reliability or performance. Limits on operations to be performed on the source database: If you change the network type of the PolarDB-X 1.0 instance during data synchronization, you must also modify the network connection information of the data synchronization task. During data synchronization, do not scale the capacity of the source instance, synchronize frequently accessed tables, change shards, or perform DDL operations. Otherwise, the data synchronization task fails or data inconsistency occurs. If you perform only full data synchronization, do not write data to the source instance during data synchronization. Otherwise, data inconsistency may occur between the source and destination instances. To ensure data consistency, we recommend that you select schema synchronization, full data synchronization, and incremental data synchronization as the synchronization types.
Other limits	To add columns to a table that you want to synchronize, perform the following operations: Modify the mappings of the table in the Elasticsearch cluster, perform DDL operations in the source PolarDB-X 1.0 instance, and then pause and start the data synchronization task. 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 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. DTS attempts to resume data synchronization tasks that failed within the last seven days. Before you switch workloads to the destination instance, you must stop or release the failed tasks. You can also execute the `REVOKE` statement to revoke the write permissions from the accounts that are used by DTS to access the destination instance. Otherwise, the data in the source instance overwrites the data in the destination instance after a failed task is resumed.
Special cases	DTS updates the `dts_health_check`.`ha_health_check` table in the source database as scheduled to move forward the binary log file position.

Billing

Synchronization type	Task configuration fee
Schema synchronization and full data synchronization	Free of charge.
Incremental data synchronization	Charged. For more information, see Billing overview.

SQL operations that can be incrementally synchronized

Operation type	SQL statement
DML	INSERT, UPDATE, and DELETE

Data type mappings

For more information, see Data type mappings for initial schema synchronization.

Permissions required for database accounts

Instance type	Required permission	References
Source PolarDB-X 1.0 instance	The read permissions on the objects to be synchronized.	Manage accounts
Destination Elasticsearch cluster	The read and write permissions on the destination cluster. In most cases, the account is elastic.

Procedure

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
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.
DMS console
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 Development 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.
From the drop-down list to the right of Data Synchronization Tasks, select the region in which the data synchronization instance resides.

Click Create Task. In the Create 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	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 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.
	Database Type	The type of the source database. Select PolarDB-X 1.0.
	Access Method	The access method of the source database. Select Alibaba Cloud Instance.
	Instance Region	The region in which the source PolarDB-X 1.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 1.0 instance.
	Database Account	The database account of the source PolarDB-X 1.0 instance.
	Database Password	The password that is used to access the database.
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 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.
	Database Type	The type of the destination database. Select Elasticsearch.
	Access Method	The access method of the destination database. Select Alibaba Cloud Instance.
	Instance Region	The region in which the destination Elasticsearch cluster resides.
	Instance ID	The ID of the destination Elasticsearch cluster.
	Database Account	The username that is used to connect to the Elasticsearch cluster. Enter the username that you specified when you created the Elasticsearch cluster. The default account in an Elasticsearch clusters is elastic.
	Database Password	The password that is used to access the database.

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 instance or an 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 the "CIDR blocks of DTS servers" section of the Add the CIDR blocks of DTS servers topic.
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.

Configure the objects to be synchronized and advanced settings.

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 cluster. The historical data is the basis for subsequent incremental synchronization.
Processing Mode of Conflicting Tables	Precheck and Report Errors: checks whether the destination cluster contains indexes that have the same names as the source tables. If the destination cluster does not contain indexes that have the same names as the source tables, 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 cluster. You can use this feature if the source instance and destination cluster contain identical table names and the tables in the destination cluster cannot be deleted or renamed. For more information, see Rename an object to be synchronized. Ignore Errors and Proceed: skips the precheck for indexes in the destination cluster that have the same names as the source tables. 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 instance and destination cluster have the same mappings and the primary key of a record in the destination cluster is the same as that in the source instance, the record remains unchanged during initial data synchronization. However, the record is overwritten during incremental data synchronization. If the source instance and destination cluster have different mappings, initial data synchronization may fail. In this case, only some columns are synchronized or the data synchronization task fails.
Index Name	If you select Table Name, the index created in the destination Elasticsearch cluster uses the same name as the table in the PolarDB-X 1.0 instance. If you select Database Name_Table Name, the index created in the destination Elasticsearch cluster is named in the format of Database name_Table name. Note The index name mapping rule takes effect for all tables.
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 tables or databases as the objects to be synchronized.
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 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 Specify 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.

Click Next: Advanced Settings to configure advanced settings.

Parameter	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.
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: 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.
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.
Environment Tag	The environment tag that is used to identify the DTS instance. You can select an environment tag based on your business requirements.
Shard Configuration	The number of primary shards and replica shards based on the shard configurations of indexes of the destination Elasticsearch cluster.
String Index	The method used to index the strings that are synchronized to the destination Elasticsearch cluster. Valid values: analyzed: The strings are analyzed before indexing. You must select a specific analyzer. For more information about the analyzer types, see Built-in analyzer reference. not analyzed: The strings are indexed with the original values. no: The strings are not indexed.
Time Zone	The time zone of the date and time data types such as DATETIME and TIMESTAMP. You can select a time zone for synchronizing date and time data to the destination Elasticsearch cluster. Note If the date and time data types in the destination cluster do not need a time zone, you must specify the document type for the date and time data types in the destination cluster before you perform data synchronization.
DOCID	The default value of the parameter is the primary key of the table in the Elasticsearch cluster. If the table does not have a primary key, the value of the parameter is the ID column that is automatically generated by Elasticsearch.
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.

In the lower part of the page, click Next: Configure Database and Table Fields. On the page that appears, set the _routing policy and _id value of the tables that you want to synchronize to the destination Elasticsearch cluster.

Parameter	Description
Set _routing	Specifies whether to store a document on a specific shard of the destination Elasticsearch cluster. For more information, see _routing. Valid values: Yes: You can specify custom columns for routing. No: The _id value is used for routing. Note If the version of the destination Elasticsearch cluster is 7.x, you must select No.
_routing Column	The column that is used for routing. Note This parameter is required only if the Set _routing parameter is set to Yes.
Value of _id	The column that is used to store the IDs of documents.

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.
Wait until the Success Rate becomes 100%. Then, click Next: Purchase Instance.

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

Read and select Data Transmission Service (Pay-as-you-go) Service Terms.
Click Buy and Start. In the dialog box that appears, click OK.
You can view the progress of the task in the task list.
Wait until the Success Rate becomes 100%. Then, click Next: Purchase Instance.