Use DTS to synchronize data from RDS for MySQL to Elasticsearch - Data Transmission Service

Prerequisites

A target Elasticsearch cluster is required. For more information, see Create an Alibaba Cloud Elasticsearch cluster.
The available storage space of the target Elasticsearch cluster must exceed the storage space used by the source ApsaraDB RDS for MySQL instance.

Precautions

Type	Description
Source database limits	The tables to synchronize must have a primary key or a unique constraint, and the fields must be unique. Otherwise, duplicate data may appear in the destination database. If you synchronize at the table level and need to edit mappings (such as column name mapping), each synchronization task supports up to 1,000 tables. If you exceed this limit, the task fails with an error. To fix this, split the tables across multiple tasks or configure a full-database synchronization task. Binary logs: ApsaraDB RDS for MySQL enables binary logging by default. Ensure that the binlog_row_image parameter is set to full. Otherwise, the precheck fails and the synchronization task cannot start. For instructions, see Configure instance parameters. Important If your source instance is a self-managed MySQL database, enable binary logging and set binlog_format to row and binlog_row_image to full. If your self-managed MySQL database is a dual-primary cluster (where both nodes act as primary and secondary), enable the log_slave_updates parameter so DTS can capture all binary log events. For instructions, see Create an account and configure binary logging for a self-managed MySQL database. The local binary logs for an ApsaraDB RDS for MySQL instance must be retained for at least three days (seven days is recommended). For a self-managed MySQL database, retain local binary logs for at least seven days. Otherwise, DTS may fail to retrieve binary logs, causing the task to fail. In extreme cases, this may cause data inconsistency or data loss. Issues caused by binary log retention periods shorter than DTS requires are not covered under the DTS SLA. Note To configure the retention period for local binary logs on an ApsaraDB RDS for MySQL instance, see Automatically delete local logs. Do not run DDL operations that change database or table schemas during schema synchronization or full synchronization. Otherwise, the synchronization task fails. Note During full synchronization, DTS queries the source database. This creates metadata locks that may block DDL operations on the source database. Data generated by changes that do not write to binary logs—such as data restored from physical backups or created by cascade operations—is not synchronized to the destination database. Note If this occurs, remove the affected database or table from the synchronization objects. Then add it back. You can do this only if your business allows it. For more information, see Modify synchronization objects. If your source database is MySQL 8.0.23 or later and contains invisible hidden columns, DTS may not read those columns. This may cause data loss. Note Run the `ALTER TABLE <table_name> ALTER COLUMN <column_name> SET VISIBLE;` command to make the hidden column visible. For more information, see Invisible Columns. MySQL compatibility: When DTS synchronizes data from a MySQL-family source database, it relies on the standard MySQL protocol and Binlog format, and behaviors incompatible with standard MySQL are not supported. If your source database claims MySQL compatibility but behaves differently from MySQL (for example, when OceanBase is connected as a source in MySQL mode, the timestamp of the trailing rotate event in the Binlog is 0, which differs from MySQL), the DTS synchronization task may fail.
Other limits	DTS does not support synchronizing indexes, partitions, views, stored procedures, functions, triggers, or foreign keys. You cannot synchronize data to Elasticsearch indexes that contain parent-child relationships or Join field types. Doing so may cause task errors or query failures in the destination. Assess the performance of both the source and destination databases before starting synchronization. Run synchronization during off-peak hours. Otherwise, full initialization consumes read and write resources on both databases and may increase database load. Full initialization runs INSERT operations concurrently. This fragments destination tables. After full initialization, the tablespace of the destination instance is larger than that of the source instance. If you synchronize one or more tables—not a full database—do not use tools like pt-online-schema-change to perform online DDL operations on the source tables. Otherwise, synchronization fails. If your source table needs to add a column, first modify the corresponding mapping in the Elasticsearch instance. Then run the DDL operation in the source MySQL database. Finally, pause and restart the DTS synchronization task. Do not write data to the destination database except through DTS while synchronization is running. Otherwise, data inconsistency may occur between the source and destination databases. For example, if you use DMS to perform online DDL operations while other data is written to the destination database, data loss may occur. If data synchronized from MySQL to Elasticsearch contains null characters, DTS converts them to LONG type values. This causes the task to fail. If data synchronized from MySQL to Elasticsearch contains location information with reversed latitude and longitude values, writing to Elasticsearch fails. Development and test specifications of Elasticsearch instances are not supported. If your ApsaraDB RDS for MySQL instance has Always-Encrypted enabled, full data synchronization is not supported. Note ApsaraDB RDS for MySQL instances with Transparent Data Encryption (TDE) enabled support schema synchronization, full data synchronization, and incremental data synchronization. If a task fails, DTS support staff will attempt to restore it within eight hours. During restoration, they may restart the task or adjust its parameters. Note Only DTS task parameters are modified—not database parameters. Parameters that may be adjusted include those listed in Modify instance parameters.
Special cases	For a self-managed MySQL source database: If a primary/secondary switchover occurs in the source database during synchronization, the task fails. DTS calculates latency by comparing the timestamp of the last synchronized record with the current time. If no DML operations run for a long time in the source database, latency reporting may become inaccurate. If latency appears too high, run a DML operation in the source database to update the latency. Note If you select a full database for synchronization, create a heartbeat table. Update or write to this table every second. DTS periodically runs the CREATE DATABASE IF NOT EXISTS `test` command in the source database to advance the binary log offset. If your source database is Amazon Aurora MySQL or another clustered MySQL instance, ensure the domain name or IP address used in the task configuration—and its DNS resolution—always points to a read/write (RW) node. Otherwise, synchronization may fail. For an ApsaraDB RDS for MySQL source database: Read-only instances—such as ApsaraDB RDS for MySQL 5.6 read-only instances—that do not record transaction logs cannot serve as source databases. DTS periodically runs the CREATE DATABASE IF NOT EXISTS `test` command in the source database to advance the binary log offset.

Billing

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

Synchronized SQL operations

Operation type	SQL statement
DML	INSERT, UPDATE, and DELETE Note Column removal using UPDATE is not synchronized.

Database account permissions

Database	Permissions	Actions
Source ApsaraDB RDS for MySQL instance	Read permissions on the objects to be synchronized.	Create an account and modify account permissions.
Destination Elasticsearch instance	The username (elastic by default) and password you set when you created the Elasticsearch instance.

Note

For a source database account created outside the ApsaraDB RDS for MySQL console, ensure it has the REPLICATION CLIENT, REPLICATION SLAVE, SHOW VIEW, and SELECT permissions.

Data type mapping

A source database and an Elasticsearch instance support different data types that cannot always be mapped directly. During structure initialization, DTS maps data types based on those supported by the target Elasticsearch instance. For more information, see Data type mapping for structure initialization.

Note
During the DTS schema migration process, DTS does not set the dynamic parameter in mapping. The behavior of this parameter depends on the settings of your Elasticsearch instance. If your source data is of the JSON type, you must ensure that for a specific key, its corresponding values have the same data type across all rows in a table. Otherwise, DTS may encounter synchronization issues. For more information, see dynamic.

The mapping between Elasticsearch and a relational database varies by Elasticsearch version.

Important

Starting with Elasticsearch 7.0, an index no longer supports multiple types, and types were completely removed in Elasticsearch 8.0. By default, when you configure a synchronization or migration task, DTS maps a table from a relational database to an index in Elasticsearch. You can change this mapping when you configure the objects to synchronize or migrate.

Elasticsearch 7.0 and later

Elasticsearch	Relational database
index	table
document	row
field	column
mapping	schema

Versions before Elasticsearch 7.0

Elasticsearch	Relational database
index	database
type	table
document	row
field	column
mapping	schema

Procedure

Go to the data synchronization task list page in the destination region. You can do this in one of two ways.
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 DMS console layout and style.
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.
Click Create Task to open 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. Note In 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 MySQL.
	Connection Type	Select Alibaba Cloud Instance.
	Instance Region	Select the region where the source ApsaraDB RDS for MySQL instance is located.
	Replicate Data Across Alibaba Cloud Accounts	In this example, data is synchronized within the same Alibaba Cloud account. Select No.
	RDS Instance ID	Select the ID of the source ApsaraDB RDS for MySQL instance.
	Database Account	Enter the database account of the source ApsaraDB RDS for MySQL instance. For more information about the required permissions, see Permissions required for database accounts.
	Database Password	Enter the password for the specified database account.
	Encryption	Select Non-encrypted or SSL-encrypted as needed. If you set this to SSL-encrypted, you must enable SSL encryption for the RDS for MySQL instance beforehand. For more information, see Use a cloud certificate to quickly enable SSL link encryption.
Destination Database	Select Existing Connection	Select the registered database instance with DTS from the drop-down list. The database information below is automatically configured. Note In 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 Elasticsearch.
	Connection Type	Select Alibaba Cloud Instance.
	Instance Region	Select the region where the destination Elasticsearch instance is located.
	Type	Select Cluster or Serverless as needed.
	Instance ID	Select the ID of the destination Elasticsearch instance.
	Database Account	Enter the account used to connect to the Elasticsearch instance. This is the Username you specified when you created the Elasticsearch instance. The default account is elastic.
	Database Password	Enter the password for the specified database account.
	Encryption	Select HTTP or HTTPS as needed.

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.

Configure the task objects.

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

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 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 Object 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.
Index Name	If you select Table Name, the index created in the destination Elasticsearch instance has the same name as the table. If you select Database Name_Table Name, the index name in the destination Elasticsearch instance is a concatenation of the database name, an underscore (_), and the table name. Note The index name mapping configuration applies to all tables.
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 either tables or databases to synchronize. If you select tables, DTS does not synchronize other object types, such as views, triggers, or stored procedures.
Selected Objects	If you need to change the name of a synchronized field, right-click the corresponding table name in the Selected Objects box, specify the index name, Type name, and other information for the table in the destination Elasticsearch instance, and then click OK. For more information, see Map individual database, table, and column names. Note Only underscores (_) are supported as special characters in index names and Type names. You can set SQL conditions to filter the data to be synchronized. Only data that meets the conditions is synchronized to the destination instance. For more information, see Filter data by using SQL conditions.

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?.
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. Note 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).
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	Specifies the method used to index strings that are synchronized to the destination Elasticsearch instance. analyzed: The strings are analyzed before being indexed. You must also select a specific analyzer. For more information about analyzer types and their functions, see Analyzers. not analyzed: The strings are indexed with their original values without analysis. no: The strings are not indexed.
Time Zone	When DATETIME or TIMESTAMP data is synchronized to the destination Elasticsearch instance, you can select a time zone. Note If the date and time data types in the destination instance do not require a time zone, you must first set the document type (type) for these data types in the destination instance.
DOCID	You do not need to configure this parameter. The DOCID defaults to the primary key of the table. If the table has no primary key, the DOCID is an ID column automatically generated by Elasticsearch.
Environment Tag	You can select an environment tag to identify the instance as needed. In this example, you do not need to select a tag.
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.
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.
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.

After completing the preceding configuration, click Next: Configure Database and Table Fields at the bottom of the page to set the _routing policy and _id value for the tables to be synchronized in the destination Elasticsearch instance.

Type	Description
Set _routing	The _routing feature routes documents to be stored on a specific shard of the destination Elasticsearch instance. For more information, see _routing. If you select Yes, you can specify custom columns for routing. If you select No, the _id value is used for routing. Note If the destination Elasticsearch instance is version 7.x, you must select No.
_routing Column	Select the column to use for routing. Note This parameter is required only when Set _routing is set to Yes.
Value of _id	Select the column to use as the document ID.

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.

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