Data Transmission Service：Synchronize data from PolarDB-X 2.0 to Elasticsearch

Prerequisites

• A source PolarDB-X 2.0 instance is created.

• A destination Elasticsearch instance is created. For more information, see Create an Alibaba Cloud Elasticsearch instance.

• The versions of the source and destination instances are supported. For more information, see Overview of synchronization solutions.

• The storage space of the destination Elasticsearch instance is larger than that of the source PolarDB-X 2.0 instance.

Notes

Billing

Supported synchronization topologies

• One-way one-to-one synchronization

• One-way one-to-many synchronization

• One-way many-to-one synchronization

For more information about the synchronization topologies and their limits, see Synchronization topologies.

Supported SQL operations

Procedure

1. 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 task 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 + AI 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.

2. Click Create Task to go to the task configuration page.

3. Configure the source and destination databases. The following table describes the parameters.

   Warning

   After you configure the source and destination databases, we recommend that you read the Limits that are displayed on the page. Otherwise, the task may fail or data inconsistency may occur.

   Category	Configuration	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	Select PolarDB-X 2.0.
   	Access Method	Select Cloud Instance.
   	Instance Region	Select the region where the source PolarDB-X 2.0 instance resides.
   	Replicate Data Across Alibaba Cloud Accounts	In this example, a database of the current Alibaba Cloud account is used. Select No.
   	Instance ID	Select the ID of the source PolarDB-X 2.0 instance.
   	Database Account	Enter the database account of the source PolarDB-X 2.0 instance. The account must have the REPLICATION SLAVE, REPLICATION CLIENT, and SELECT permissions on the objects to be synchronized. Note For more information about how to grant the permissions to the database account, see Data synchronization tools for PolarDB-X.
   	Database Password	The password that is used to access the database.
   Destination Database	Database Type	Select Elasticsearch.
   	Access Method	Select Cloud Instance.
   	Instance Region	Select the region where the destination Elasticsearch instance resides.
   	Type	Select Cluster or Serverless as needed.
   	Instance ID	Select the ID of the destination Elasticsearch instance.
   	Database Account	Enter the database account of the destination Elasticsearch instance. The account must have read and write permissions. The default account is elastic.
   	Database Password	The password that is used to access the database.
   	Encryption	Select HTTP or HTTPS as needed.

4. Click Test Connectivity and Proceed in the lower part of the page.

   Note

   • Make sure that the CIDR blocks of DTS servers can be 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 and its Access Method is not set to Alibaba Cloud Instance, click Test Connectivity in the CIDR Blocks of DTS Servers dialog box.

5. Configure the objects to be synchronized.

   1. In the Configure Objects step, configure the objects that you want to synchronize.

      Configuration	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.
      Index Name	Table Name If you select Table Name, the index name created in the destination Elasticsearch instance is the same as the table name. In this example, the name is order. DatabaseName_TableName If you select DatabaseName_TableName, the index name created in the destination Elasticsearch instance is in the format of `Database name_Table name`. In this example, the name is dtstest_order.
      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 tables with identical 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 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 instance fails. Proceed with caution.
      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 columns, tables, or databases as objects to synchronize. 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 to be synchronized at the database or table level, right-click the object in the Selected Objects box and select the desired SQL operations in the dialog box that appears. To set a WHERE clause to filter data, right-click the table in the Selected Objects box and set the filter condition in the dialog box that appears. For more information, see Filter data using SQL conditions. If you use the object name mapping feature, other objects that depend on the mapped object may fail to be synchronized.

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

      Configuration	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 instances, purchase a dedicated cluster. 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.
      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 Synchronization	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 You can configure this parameter 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	If needed, you can select an environment tag to identify the instance. In this example, no selection is needed.
      Shard Configuration	Set the number of primary shards and replica shards for the index based on the maximum shard configuration of the index in the destination Elasticsearch instance.
      String Index	The method used to index strings that are synchronized to the destination Elasticsearch instance. analyzed: Analyzes the string before indexing. You also need to select a specific analyzer. For information about analyzer types and their functions, see Analyzers. not analyzed: Indexes the string with its original value without analysis. no: Does not index the string.
      Time Zone	When DTS synchronizes time-related data types, such as DATETIME and TIMESTAMP, to the destination Elasticsearch instance, you can select the time zone. Note If the time data in the destination instance does not require a time zone, you must set the document type (type) for this data in the destination instance before synchronization.
      DOCID	The DOCID defaults to the primary key of the table. If the table has no primary key, the DOCID is the ID column automatically generated by Elasticsearch.
      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. Valid values: 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, features such as physical backup and cloning of the source database may be affected.
      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 instance. 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.

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

      Category	Description
      Set _routing	Specifies whether to store a document on a 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.
      Value of _id	Primary key column Composite primary keys are merged into one column. Business key If you select a business key, you must specify the business key column.

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

7. Purchase the instance.

   1. Wait until the Success Rate becomes 100%. Then, click Next: Purchase Instance.

   2. On the buy page, configure the Billing Method and Instance Class parameters for the data synchronization task. 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.

   3. Read and select Data Transmission Service (Pay-as-you-go) Service Terms.

   4. Click Buy and Start. In the dialog box that appears, click OK.

      You can view the progress of the task in the task list.

Check the index and data

After the state of the data synchronization task changes to Running, you can use the data visualization software Kibana to connect to the Elasticsearch instance. This lets you check whether the index is created and data is synchronized as expected. For more information about how to log on to the Kibana console, see Log on to the Kibana console.