Data Transmission Service:Data Transmission Service:Synchronize PolarDB-X 2.0 to Elasticsearch

DTS console

1. Log on to the DTS console.

2. In the navigation pane on the left, click Data Synchronization.

3. In the upper-left corner of the page, select the region where the synchronization instance is located.

DMS console

__

Note

The actual steps may vary depending 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.

1. Log on to the DMS console.

2. In the top menu bar, choose Data + AI > DTS (DTS) > Data Synchronization.

3. To the right of Data Synchronization Tasks , select the region of the synchronization instance.

1. Click Create Task to open the task configuration page.

2. Configure the source and destination databases.

__

Warning

After you select the source and destination instances, review the Limits at the top of the page. Otherwise, the task may fail or data inconsistency may occur.

1. After completing the configuration, click Test Connectivity and Proceed at the bottom of the page.

__

Note

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

1. Configure the task objects.

   1. On the Configure Objects page, specify the objects to synchronize.

• Table Name If you select Table Name , the index name created in the destination Elasticsearch instance matches the table name. In this example, the index name is order.

• Database_Table If you select Database_Table , the index name created in the destination Elasticsearch instance is database_table. In this example, the index name is dtstest_order.

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.__Note If 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 Database Table Column Name Mapping.

• Ignore Errors and Proceed : Skips the check for tables with the same name in the destination database.__Warning Selecting 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.

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. __Note You can select objects at the database, table, or column level. If you select only tables or columns, DTS does not synchronize other object types (such as views, triggers, and stored procedures). Selected Objects |

• To rename a single object in the destination instance, right-click the object in the Selected Objects box. For more information, see Map a single object name.

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

__Note

• Index names and type names support only underscores (_) as special characters.

• To select SQL operations to synchronize at the database or table level, right-click the object in Selected Objects and select the SQL operations to synchronize in the dialog box that appears.

• To filter data using a WHERE clause, right-click the table in Selected Objects and set the filter condition in the dialog box that appears. For more information, see Filter task data using SQL conditions.

• If you use the object name mapping feature, synchronization of other objects that depend on this object may fail.

1. Click Next: Advanced Settings.

• If 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.__Important The 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).__Note

• This 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 | Select an environment tag to identify the instance based on your needs. This example does not require a selection. Shard Configuration | Set the number of primary and replica shards for indexes based on the maximum shard configuration of indexes in the destination Elasticsearch instance. String Index | Specify how strings are indexed in the destination Elasticsearch instance.

• analyzed: Analyze the string before indexing. You must also select a specific analyzer. For analyzer types and functions, see Analyzers.

• not analyzed: Do not analyze. Index the original value directly.

• no: Do not index.

Time Zone | When synchronizing time-type data (such as DATETIME or TIMESTAMP) to the destination Elasticsearch instance, select the time zone to include. __Note If time-type data in the destination instance does not require a time zone, set the document type (type) for this time-type data in the destination instance before synchronization. DOCID | By default, DOCID is the table's primary key. If the table has no primary key, DOCID is an ID column automatically generated by Elasticsearch. Whether to delete SQL operations on heartbeat tables of forward and reverse tasks | Choose whether DTS writes heartbeat SQL information to the source database while the instance is running.

• Yes : Does not write heartbeat SQL information to the source database. The DTS instance may display latency.

• No : Writes heartbeat SQL information to the source database. This may interfere with source database operations like physical backups and cloning.

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.

1. After the configuration is complete, click Next: Configure Table And Field at the bottom of the page to set the _routing policy and _id value for the tables to synchronize to the destination Elasticsearch.

• Select Yes to use custom columns for routing.

• Select No to use _id for routing.

__Note If the created destination Elasticsearch instance is version 7._x_ , you must select No. _id Value|

• Primary Key Column Of The Table Composite primary keys are merged into one column.

• Business Primary Key If you select Business Primary Key , you also need to set the corresponding Business Primary Key Column.

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

__

Note

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

1. Purchase the instance.

   1. When the Success Rate reaches 100%, click Next: Purchase Instance.

   2. On the Purchase page, select the billing method and link specifications for the data synchronization instance. For more information, see the following table.

• 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.__Note This option appears only when the billing method is Subscription.

1. Read and select the checkbox for Data Transmission Service (Pay-as-you-go) Service Terms.

2. Click Buy and Start , and then click OK in the OK dialog box.

You can monitor the task progress on the data synchronization page.