Docs

Database Transmission Service

Volcano Engine veDB for MySQL as the source

Synchronizing to BytePlus Cloud Search

This topic describes how to create a task for synchronizing the BytePlus NDB for MySQL to BytePlus Cloud Search on the Database Transmission Service (DTS) console.

Prerequisites

An instance and database for veDB for MySQL have been created. For details, refer to Creating an instance (veDB for MySQL) and Creating a database.

A Cloud Search instance has been created, and the password for the default username admin has been set. For details, refer to Creating a BytePlus Cloud Search instance.

The network connectivity and service availability of the source and destination have been confirmed.

Optional. Check each synchronization object in the source and target databases according to the instructions in the pre-check items. For more details, refer to Pre-check items (MySQL) and Pre-check items (Elasticsearch).

Precautions

During data synchronization, if duplicate primary keys or unique keys are encountered in the target database, DTS will not retain the conflicting data at the destination. Instead, the data from the source will overwrite the data at the destination. When a conflict overwrite occurs, if there is a table with the same name in the target database, it may cause data inconsistency issues or task failures as detailed below. It is recommended to use table name mapping or delete or rename the table with the same name in the target database to avoid data inconsistency and reduce business risks.

When the table structure is consistent, data from full synchronization overwrites records in the target table with the same primary key or unique key values as in the source database.

When the table structure is inconsistent, initialization of data may fail, and only partial column data can be synchronized or synchronization may fail.

On the source end, if a database is not included in the synchronization objects, DDL operations can not be performed on databases that are included in the synchronization objects, or the synchronization task will fail.

Do not perform frequent DDL operations on the same table on the source end, as repeated DDL operations may cause DTS metadata update failures and risk transmission interruptions. The mitigation measures are as follows:

Method 1: in the console, DDL operations should be performed at intervals of at least 1–3 seconds.

Method 2: perform DDL operations using lock-free schema change tickets or lock-free data change tickets of Database Workshop (DBW).

Limits

Application limits

Type	Description
Source database limits	Database version: MySQL 5.7 and 8.0 instances are supported. tip veDB for MySQL 5.7 is currently in beta testing. To use it, submit a ticket for technical support. Bandwidth requirements: Adequate egress bandwidth is required on the source database server. Failure to meet this prerequisite will lead to suboptimal synchronization performance. Supports the InnoDB database storage engine. MariaDB database engine is not supported currently. Tables to be synchronized must have a primary key or a unique non-null constraint, and their fields must be unique. Otherwise, data inconsistency may occur. Binlogs must meet the following requirements: The Binlog feature must be enabled, and the parameter binlog_format set to row, binlog_row_image set to full. Otherwise, pre-check will report an error, and data synchronization tasks can not start successfully. Binlogs must be retained for at least 24 hours, and a retention period of more than seven days is recommended. Otherwise, the DTS task may fail because it cannot obtain the logs, potentially leading to data loss. Tables with foreign key dependencies must be synchronized together, or data synchronization will fail. It is recommended that the number of tables in a single task should not exceed 20,000, and the number of databases should not exceed 1,000. When a large number of databases and tables need to be synchronized, it is recommended to split them into multiple tasks.
Target database limits	Current support for the following instance versions: Elasticsearch instances: versions 6.7.1, 6.8.23, and 7.10.2. Opensearch instances: versions 2.9.0 and 3.3.0.
Other limits	Prior to executing data synchronization, assess the performance of both source and target databases. It is also advised to perform synchronization during off-peak business hours. Otherwise, during full data initiation, DTS consumes certain read/write resources on both source and target databases, which may lead to an increase in database load. If the source database is RDS for MySQL 8.0, when configuring synchronization tasks, you must manually grant the relevant data synchronization permissions directly to the following accounts: The accounts for the source or target database are granted relevant permissions through the Role. The accounts that need to perform User synchronization are granted relevant permissions through the Role. Synchronization tasks only support synchronizing tables.

Operation limits

Currently, only synchronous DML statements are supported to be synced to Elasticsearch.

Supported synchronization architectures

One-to-one unidirectional synchronization

One-to-many unidirectional synchronization

Many-to-one unidirectional synchronization

For information on the types and usage of synchronization topology supported by DTS, refer to Data synchronization topology.

Supported SQL operations

Operation type	SQL statement
DML	INSERT, UPDATE, DELETE

Database account minimum permission policy

Database	Schema initialization	Full initialization	Incremental synchronization
Source database	SELECT permission	SELECT permission	REPLICATION SLAVE, REPLICATION CLIENT, and SELECT permissions.
Elasticsearch normal user	Index: read, write, edit, and delete permissions Document: add, delete, modify, and query permissions

On the Create synchronization task page, locate the Configure source and target database wizard, and configure the following parameters.

Type	Name	Description
Basic information	Task name	Optional. Customize the task name. The length must be within 256 characters. tip If not set, the system generates a task name by default according to the naming rule, starting with dts-.
		Link specification	Select the link specifications for the synchronization task as needed. Compact, Medium, and Standard are supported. tip The link specification can not be modified after the task is successfully created. For details on the link specifications, refer to Product specifications.
		Synchronization topology	Select a synchronization topology based on your business needs. Only Unidirectional synchronization is currently supported. tip For more information about the synchronization topology, refer to Data synchronization topology.
Source database configuration	Select an existing data source	You can choose whether to use an existing instance as needed: Use existing instances: Click Select an existing data source, then in the Select data source control panel, choose the target region from the Region drop-down list, and select the target data source. Supports selecting data sources by data source name and ID. For methods to create data sources, refer to Data source management. Do not use existing instances: If not using an existing instance, you need to configure the following database instance information.
		Instance type	Select MySQL.
		Access method	Select Volcano Engine veDB for MySQL.
		Region	Select the region where the target instance is located.
		Cross-Volcano Engine account?	Select whether to transmit data cross-account as needed, with the following options: This account: Selecting this means data transmission occurs only within this account. Cross-account: Selecting this means data transmission occurs between two accounts. tip When transmitting data across accounts, log on to the Database Transmission Service (DTS) console through the account of the destination. Before cross-account data transmission, create and authorize an IAM role in the source root user. For detailed steps, refer to How to authorize users for cross-account data transmission.
		Cross-account ID	Enter the Volcano Engine account ID to which the source database belongs.
		Cross-account roles	Enter the IAM role authorized for DTS to access cross-account resources.
		MySQL instance	Select the target instance of Volcano Engine veDB for MySQL from the drop-down list. tip You can also search for the target instance by instance ID or name.
		Node type	Select node types as needed, currently supporting Primary node and Read-only node. tip Select read-only nodes when read-only nodes are created within the instance. For specific steps on creating a read-only node, refer to Read-only node overview.
		MySQL read-only node	Select the target read-only node from the drop-down list. tip When a read-only node is created in the instance and Node type selects Read-only node, this parameter can be configured.
		Database account	Enter the database account of the target instance.
		Database password	Enter the password corresponding to the database account of the target instance.
		Test connection	Click Test connection to verify the connection to the instance. If the test connection fails, modify the configuration based on the failure prompt, and then click Test connection again to verify the connection. The specific prompts are as follows: Connection authentication failed. Check if the username and password are correct: When this error prompt appears, verify your username and password. Connection authentication failed, unable to create connection normally, contact customer service: When this error prompt appears, submit a ticket for technical support.
Target database configuration	Select an existing data source	You can choose whether to use an existing instance as needed: Use existing instances: Click Select an existing data source, then in the Select data source control panel, choose the target region from the Region drop-down list, and select the target data source. Supports selecting data sources by data source name and ID. For methods to create data sources, refer to Data source management. Do not use existing instances: If not using an existing instance, you need to configure the following database instance information.
		Instance type	Select Elasticsearch.
		Access method	Select BytePlus Cloud Search.
		ES instance	Select the target Elasticsearch instance from the drop-down list. tip Select the target Elasticsearch instance from the drop-down list. Before creating a data synchronization task, confirm whether your Cloud Search instance has configured the allowlist. If an allowlist has been configured, the CIDR block of the VPC subnet where the instance resides must be added to it. If no allowlist has been configured for the instance, no changes are required to the instance allowlist. For details, refer to Configuring the instance private IP allowlist.
		Database account	Currently, only the default account admin is supported.
		Database password	Enter the password corresponding to the database account of the target instance.
		Test connection	Click Test connection to verify the connection to the instance. tip If the test connection fails, modify the configuration based on the failure prompt, and then click Test connection again to verify the connection.
Project and billing	Project	Optional. Select the affiliated project for the task from the drop-down list. By default, it is under default (default project). You can also click Create new project to create a new project. For more information, refer to Creating a new project. tip To grant sub-user privileges to access resources in a specific project, refer to Modifying project privileges. After a task is created successfully, if you need to change its affiliated project, you can move the resource to another project. For more information, refer to Moving resources to a project. A project is a virtual concept that includes a set of resources, users, and roles. A project allows for a unified view and management of a set of resources, and controls the permissions of users and roles within the project for those resources.
		Tag	(Optional) Click Add tag to add a tag to the instance. Tags can help you categorize cloud resources, control access to them, and allocate bills and costs. A tag is a key-value pair that identifies a cloud resource. You can use tags to categorize resources with the same characteristics from different dimensions, such as purpose or owner, making it easier to filter, aggregate, and manage your cloud resources. For more details about tags, refer to Tag overview. The rules for tag key-value pairs are as follows: Key Supports any language, characters, numbers, spaces, or symbols (_.:/=+-@). Case-sensitive, and the length is 1 to 128 characters. In UTF-8 encoded Unicode format. Keys cannot start with any form of volc:, such as Volc: or VOLC:. (Optional) Value Supports any language, character, digit, space, or symbol (_.:/=+-@). Case-sensitive, and the length is 0 to 256 characters. In UTF-8 encoded Unicode format. tip Support fuzzy search for selecting existing tag keys and tag values. A maximum of 20 tags can be associated with a task in a single operation. A maximum of 50 tags can be associated with a single task. For a single resource, tag keys must be unique, and each tag key can have only one value.
		Billing method	Select a billing method: Pay-as-you-go or Subscription. tip For detailed billing information, refer to Billing instructions.
		Subscription duration	Select the duration of the subscription as needed. tip When selecting Subscription in Billing method, you can set the purchase time and also check Automatic renewal. The system automatically renews before task expiration.

Click Next: configure synchronization object.

On the Configure synchronization object wizard page, configure the related parameter information as shown in the table below.

tip

If you do not need to start the synchronization task immediately, click Save in the lower-right corner of the page after configuring the synchronization object.

After saving, you will be redirected to the Synchronization task list page. The task status will be To be started, and you can configure the synchronization task at a suitable time. For configuration methods, refer to Configuring a synchronization task.

Name			Description
Synchronization type			Select the synchronization type as needed. Currently, Schema initialization, Full initialization, and Incremental synchronization are supported. tip Incremental synchronization is selected by default. When you select Schema initialization or Full initialization, after the pre-check is completed, DTS will initialize the data of the objects to be synchronized from the source instance in the target instance, which serves as the basis for subsequent incremental data synchronization.
Index concatenation rule			Select index concatenation rules as needed, supporting Table name and Database name + Table name options: Table name: When you select Table name, the index name created in the target Elasticsearch instance is the same as the table name. Database name + table name: When you select Database name + table name, the index name created in the target Elasticsearch instance is the database name + table name. tip After a synchronization task is successfully created, modifying the index concatenation rule will reset the names of the synchronization objects. Proceed with caution.
Primary key conflict handling			Select the method to handle when the target database already has rows with the same primary key value. Currently, only Overwrite on conflict is supported, which means using source database data to overwrite target database data, allowing the synchronization task to start normally.
Synchronization starting point			Set to pull Binlog logs from a specified position or timestamp. The values are as follows: System default: The default is the task start time. Specify GTID: Enter the specified GTID in the input box, formatted as source_id:transaction_id. Set GTID_EXECUTED: Enter the specified GTID_EXECUTED in the input box, formatted as source_id:transaction_id. If multiple exist, separate them with commas (,). For how to obtain the instance's GTID_EXECUTED, refer to How to obtain the GTID_EXECUTED of the instance. Specify timestamp: Click the input box to select a date, click Select time to set the time point, then click OK. tip When Synchronization type selects Full initialization, this step is not supported. When Synchronization type selects both Full initiation and Incremental synchronization, the Starting timestamp defaults to the current time point and can not be modified. GTID and GTID_EXECUTED must be legal values from the source end. Otherwise, pre-check reports an error. When selecting Specify timestamp, the time you set must be later than the earliest Binlog time on the source end. If there is no corresponding time Binlog, the closest Binlog starting point will be selected.
Sync type selection			Select the operation types to synchronize. Currently, only DML statements are supported, which include DELETE, Insert, and Update. All DML operations are selected by default and can be adjusted as needed.
Whether to enable foreign key check?			Select whether to enable foreign key check as needed. When enabled, the tool supports synchronizing cascading updates and deletes of foreign keys from the source, ensuring data integrity and consistency throughout the synchronization.
Synchronization object			Select the tables to synchronize. Meanwhile, you can perform the following actions in the Selected object area: Rename databases or tables: Click the pencil icon next to the target database or table to rename them, supporting query of target objects via Normal search and Global search methods. If the entire database is selected in the Synchronization object area, only the database name can be modified in the Selected object area, and the database cannot be expanded. Click Batch mapping to modify database or table names in bulk. For more information, refer to Database and table batch mapping. Filter and delete unnecessary targets: The search box in the Selected object area supports fuzzy search to batch delete unwanted databases, tables, and other targets. Filter data in tables: Check Filter data enables filtering of data within the table. tip Regular expression search for target objects is supported in the Synchronization object or Selected object areas.
Filter condition			Optional. Filtering data during a full data scan improves synchronization performance. Click the pen icon in the Filter condition column for the target database, table, or view, set the filter condition, then click Verification statement to validate the condition. tip This feature is currently in beta testing. To use it, submit a ticket for technical support. This field can be configured only if Filter data is selected for the Synchronization object's database, table, or view. Filter condition currently supported =, !=, <, >, <=, >=, in, is null, and, or.
Database and table field configuration			Configure related information of the database and table fields. You can route documents to shards of the Elasticsearch instance as custom routing: Type name: You can customize the Type name. Click Batch set Type name to batch set Type names. Naming rules are as follows: It can not contain English commas (, ) or symbols (#). It can not start with an English period (.). It can not start with an underscore (_) except for (_doc). The length must be within 255 characters, and the name must not contain blank characters at the beginning or end. tip Currently, only ES instances of version 7.x and earlier support custom Type names. ES instances of version 8.x and later, as well as OpenSearch versions, do not support custom Type names. If the target index already exists, the Type name must be consistent with the custom name you set. Otherwise, schema migration fails. Whether _routing: Specify whether to enable custom routing mode. It also supports setting the _routing of multiple database names to yes or no. Yes: You can custom route documents to shards in Elasticsearch. No: Documents can only route to shards in Elasticsearch via _id. _routing column: Customize indexing a document into an Elasticsearch shard. The default is _id. _id value: Customize the document _id value. When selecting multiple fields to form _id, connect with underscores (_).
Advanced configuration	Enable ETL configuration	Choose whether to enable the ETL function. For more information about ETL, refer to Introduction to ETL. Yes: indicates enabling ETL functions. After enabling ETL rules, click Quick configuration field mapping/filtering rules, configure synchronization objects in the Quick configuration field mapping/filtering rules dialog box, and click OK to quickly generate ETL statements. After enabling the ETL function, you can configure data processing ETL rules by referring to the DSL syntax. Enter the data processing ETL rules, i.e., the DSL script, in the Enter ETL statements or use ETL assistant to generate statements...text box, and click Validate syntax to verify whether the data processing statements are correct. You can also use the ETL assistant to generate ETL statements in natural language. In the upper-right corner of the ETL statement text box, click ETL assistant to input ETL requirements, and press Enter. After generating the ETL, copy the generated ETL statements into the ETL text box. The ETL assistant offers a variety of ETL statement generation capabilities. For more information, refer to ETL assistant capabilities. Click Debug to test the effects of the ETL rules you created. For details on debugging, refer to Verifying ETL rules via ETL Playground tool. No: indicates not enabling ETL functions.
		Error retry time	If a synchronization task fails due to a disconnection between the source and target databases, the system immediately retries connecting to them multiple times within the specified time. Value range: 600–86400, in seconds (s). The default value is 600 seconds.

Last updated: 2026.05.06 16:27:43