Updated on 2023-04-26 GMT+08:00

From TiDB to GaussDB(for MySQL)

Supported Source and Destination Databases

Table 1 Supported databases

Source DB

Destination DB

TiDB 4.0.0 and later (excluding the development version)

GaussDB(for MySQL)

Only whitelisted users can use this function.

Supported Synchronization Objects

Table 2 lists the objects that can be synchronized in different scenarios. DRS will automatically check the objects you selected before the synchronization.

Table 2 Supported synchronization objects

Type

Precautions

Objects

  • Supported field types:

    BIGINT, BINARY, BIT, BLOB, BOOLEAN, CHAR, DATE, DATETIME, DECIMAL, DOUBLE, ENUM, FLOAT, INT, JSON, LONGBLOB, LONGTEXT, MEDIUMBLOB, MEDIUMINT, SET, SMALLINT, TEXT, TIME, TIMESTAMP, TINYBLOB, TINYINT, TINYTEXT, VARBINARY, VARCHAR, YEAR.

  • Scope of full synchronization
    • The structure, sequence, data, constraints, and indexes of selected tables.
    • The names of the databases and tables to be synchronized cannot contain non-ASCII characters or special characters '< `>/\
    • The database name or mapped name cannot start with ib_logfile or be ib_buffer_pool, ib_doublewrite, ibdata1 or ibtmp1.
    • When table name mapping is used in a synchronization task, foreign key constraints of the table cannot be synchronized.
    • If the database table name contains characters other than letters, digits, and underscores (_), or the mapped database table name contains hyphens (-) and number signs (#), the name length cannot exceed 42 characters.
  • Scope of incremental synchronization
    • Some DML statements, including INSERT, UPDATE, and DELETE
    • Some DDL statements, including CREATE TABLE, DROP TABLE, ALTER TABLE, RENAME TABLE and TRUNCATE TABLE

Database Account Permission Requirements

To start a synchronization task, the source and destination database users must meet the requirements in the following table. Different types of synchronization tasks require different permissions. For details, see Table 3. DRS automatically checks the database account permissions in the pre-check phase and provides handling suggestions.

  • You are advised to create an independent database account for DRS task connection to prevent task failures caused by database account password modification.
  • After changing the account passwords for the source or destination databases, modify the connection information in the DRS task as soon as possible to prevent automatic retry after a task failure. Automatic retry will lock the database accounts.
Table 3 Database account permission

Type

Full+Incremental

Source database user

SELECT and CONFIG permissions.

Destination database user

SELECT, CREATE, DROP, INSERT, DELETE, UPDATE, ALTER, REFERENCE and INDEX permissions.

Suggestions

  • When a task is being started or in the full synchronization phase, do not perform DDL operations on the source database. Otherwise, the task may be abnormal.
  • To keep data consistency before and after the synchronization, ensure that no data is written to the destination database during the synchronization.
  • The success of database synchronization depends on environment and manual operations. To ensure a smooth synchronization, perform a synchronization trial before you start the synchronization to help you detect and resolve problems in advance.
  • Start your synchronization task during off-peak hours. A less active database is easier to synchronize successfully. If the data is fairly static, there is less likely to be any severe performance impacts during the synchronization.
    • If network bandwidth is not limited, the query rate of the source database increases by about 50 MB/s during full synchronization, and two to four CPUs are occupied.
    • To ensure data consistency, tables to be synchronized without a primary key may be locked for 3s.
    • The data being synchronized may be locked by other transactions for a long period of time, resulting in read timeout.
    • When DRS concurrently reads data from a database, it will use about 6 to 10 sessions. The impact of the connections on services must be considered.
    • If you read a table, especially a large table, during the full migration, the exclusive lock on that table may be blocked.
    • For more information about the impact of DRS on databases, see What Is the Impact of DRS on Source and Destination Databases?
  • Data-Level Comparison

    To obtain accurate comparison results, start data comparison at a specified time point during off-peak hours. If it is needed, select Start at a specified time for Comparison Time. Due to slight time difference and continuous operations on data, data inconsistency may occur, reducing the reliability and validity of the comparison results.

Precautions

The full+incremental synchronization consists of four phases: task startup, full synchronization, incremental synchronization, and task completion. To ensure smooth synchronization, read the following notes before creating a synchronization task.

Table 4 Precautions

Type

Constraints

Starting a task

  • Source database parameter requirements:
    CAUTION:
    • TiDB Binlog is incompatible with the following features in TiDB 5.0:

      TiDB clustered index: After TiDB Binlog is enabled, you cannot create a clustered index that is defined as a single non-integer primary key. The insert, delete, and update operations on existing tables with clustered indexes are not synchronized to the downstream applications through TiDB Binlog. To synchronize a table with clustered indexes, upgrade the TiDB version to 5.1.

      TiDB system variable tidb_enable_async_commit: After TiDB Binlog is enabled, the performance cannot be improved if this option is enabled.

      TiDB system variable tidb_enable_1pc: After TiDB Binlog is enabled, the performance cannot be improved if this option is enabled.

    • TiDB Binlog is incompatible with the following features in TiDB 4.0.7:

      TiDB system variable tidb_enable_amend_pessimistic_txn: After TiDB Binlog is enabled, the data replicated from the TiDB Binlog may be inconsistent.

  • Source database object requirements:
    • The names of the source objects to be synchronized cannot contain non-ASCII characters or special characters '< `>/\
  • Destination database parameter requirements:
    • If lower_case_table_names of the destination database is set to 1, databases or tables containing uppercase letters cannot be synchronized.
  • Destination database object requirements:
    • In full+incremental synchronization, if the destination database already has a table structure, ensure that the table structure is the same as that on the source database or contains columns in the source database.
    • The destination table can contain more columns than the source table. However, the following failures must be avoided:

      Assume that extra columns on the destination cannot be null or have default values. If newly inserted data records are synchronized from the source to the destination, the extra columns will become null, which does not meet the requirements of the destination and will cause the task to fail.

      Assume that extra columns on the destination must be fixed at a default value and have a unique constraint. If newly inserted data records are synchronized from the source to the destination, the extra columns will contain multiple default values. That does not meet the unique constraint of the destination and will cause the task to fail.

    • Triggers enabled in the destination database cannot be associated with synchronization tables.
  • Other notes:
    • You can add additional objects during an incremental synchronization.

Full synchronization

  • Do not change the port of the source and destination databases, or change or delete the passwords and permissions of the source and destination database users. Otherwise, the task may fail.
  • Do not run any DDL statement in the source database. Otherwise, data may be inconsistent or the task may fail.
  • Do not write data to the destination database. Otherwise, data may be inconsistent.

Incremental synchronization

  • Do not change the port of the source and destination databases, or change or delete the passwords and permissions of the source and destination database users. Otherwise, the task may fail.
  • Do not write data to the destination database. Otherwise, data may be inconsistent.

Synchronization comparison

  • You are advised to compare data in the source database during off-peak hours to prevent inconsistent data from being falsely reported and reduce the impact on the source database and DRS tasks.
  • During incremental synchronization, if data is written to the source database, the comparison results may be inconsistent.
  • Data cannot be compared during full synchronization.
  • Do not limit the synchronization speed during data comparison.

Prerequisites

  • You have logged in to the DRS console.
  • Your account balance is greater than or equal to $0 USD.
  • For details about the DB types and versions supported by real-time synchronization, see Supported Databases.
  • If a subaccount is used to create a DRS task, ensure that an agency has been added. To create an agency, see Agency Management.

Procedure

This section uses TiDB to GaussDB(for MySQL) synchronization to the cloud as an example to describe how to use DRS to configure a real-time synchronization task over a public network.

  1. On the Data Synchronization Management page, click Create Synchronization Task.
  2. On the Create Synchronization Instance page, select a region and project, specify the task name, description, and the synchronization instance details, and click Create Now.

    • Task information description
      Figure 1 Synchronization task information
      Table 5 Task and recipient description

      Parameter

      Description

      Region

      The region where the synchronization instance is deployed. You can change the region.

      Project

      The project corresponds to the current region and can be changed.

      Task Name

      The task name must start with a letter and consist of 4 to 50 characters. It can contain only letters, digits, hyphens (-), and underscores (_).

      Description

      The description consists of a maximum of 256 characters and cannot contain special characters !=<>'&"\

    • Synchronization instance details
      Figure 2 Synchronization instance details
      Table 6 Synchronization instance settings

      Parameter

      Description

      Data Flow

      Select To the cloud.

      Source DB Engine

      Select TiDB.

      Destination DB Engine

      Select GaussDB(for MySQL).

      Network Type

      Available options: Public network and VPN or Direct Connect. Public network is used as an example.

      Destination DB Instance

      The GaussDB(for MySQL) instance you created.

      Synchronization Instance Subnet

      Select the subnet where the synchronization instance is located. You can also click View Subnet to go to the network console to view the subnet where the instance resides.

      By default, the DRS instance and the destination DB instance are in the same subnet. You need to select the subnet where the DRS instance resides and ensure that there are available IP addresses. To ensure that the synchronization instance is successfully created, only subnets with DHCP enabled are displayed.

      Synchronization Mode

      • Full+Incremental

        This synchronization mode allows you to synchronize data in real time. After a full synchronization initializes the destination database, an incremental synchronization parses logs to ensure data consistency between the source and destination databases.

    • Enterprise Projects and Tags
      Figure 3 Enterprise projects and tags
      Table 7 Enterprise Projects and Tags

      Parameter

      Description

      Enterprise Project

      An enterprise project you would like to use to centrally manage your Global Accelerator resources. Select an enterprise project from the drop-down list. The default project is default. For more information about enterprise project, see Enterprise Management User Guide.

      To customize an enterprise project, click Enterprise in the upper right corner of the console. The Enterprise Management page is displayed. For details, see Creating an Enterprise Project in Enterprise Management User Guide.

      Tags

      • This setting is optional. Adding tags helps you better identify and manage your tasks. Each task can have up to 10 tags.
      • After a task is created, you can view its tag details on the Tags tab. For details, see Tag Management.

    If a task fails to be created, DRS retains the task for three days by default. After three days, the task automatically ends.

  3. On the Configure Source and Destination Databases page, wait until the synchronization instance is created. Then, specify Kafka, source and destination database information and click Test Connection for Kafka and the source and destination databases to check whether they have been connected. After the connection tests are successful, select the check box before the agreement and click Next.

    Establish the connectivity between the DRS instance and the source and destination databases.

    • Network connectivity: Ensure that the source and destination databases accept connections from the DRS instance. To access databases over a public network, configure the database to accept connections from the EIP of the DRS instance. To access databases over a VPC, VPN, or Direct Connect network, configure the database to accept connections from the private IP address of the DRS instance. For details, see Network Preparations.
    • Account connectivity: Ensure that the source and destination databases allows connections from the DRS instance using the username and password.
    Figure 4 Source database information
    Table 8 Source database settings

    Parameter

    Description

    IP Address or Domain Name

    The IP address or domain name of the source TiDB database.

    Port

    The port number must be an integer ranging from 1 to 65535, and the default value is 4000.

    Database Username

    The username for accessing the source TiDB database.

    Database Password

    The password for the database username.

    SSL Connection

    SSL encrypts the connections between the source and destination databases. If SSL is enabled, upload the SSL CA root certificate.

    NOTE:
    • The maximum size of a single certificate file that can be uploaded is 500 KB.
    • If SSL is not enabled, your data may be at risk.
    Figure 5 Kafka information
    Table 9 Kakfa settings

    Parameter

    Description

    IP Address or Domain Name

    IP address or domain name of Kafka DRS obtains the binlog generated by TiDB from Kafka and synchronizes the incremental data to the destination database in real time.

    Security Protocol

    Available options: PLAINTEXT, SSL, SASL_PLAINTEXT, and SASL_SSL. For details, see Kafka Authentication.

    Figure 6 Destination database information
    Table 10 Destination database settings

    Parameter

    Description

    DB Instance Name

    The GaussDB(for MySQL) instance you selected when creating the task. This parameter cannot be changed.

    Database Username

    The username for accessing the destination database.

    Database Password

    The password for the database username.

    The username and password of the source and destination databases are encrypted and stored in the databases and the synchronization instance during the synchronization. After the task is deleted, the username and password are permanently deleted.

  4. On the Set Synchronization Task page, select the synchronization policy, topic, and synchronization object, and click Next.

    Figure 7 Synchronization Mode
    Table 11 Synchronization object

    Parameter

    Description

    Flow Control

    You can choose whether to control the flow.

    • Yes

      You can customize the maximum migration speed.

      In addition, you can set the time range based on your service requirements. The traffic rate setting usually includes setting of a rate limiting time period and a traffic rate value. Flow can be controlled all day or during specific time ranges. The default value is All day. A maximum of three time ranges can be set, and they cannot overlap.

      The flow rate must be set based on the service scenario and cannot exceed 9,999 MB/s.

      Figure 8 Flow control
    • No
      The synchronization speed is not limited and the outbound bandwidth of the source database is maximally used, which will increase the read burden on the source database. For example, if the outbound bandwidth of the source database is 100 MB/s and 80% bandwidth is used, the I/O consumption on the source database is 80 MB/s.
      NOTE:
      • The flow control mode takes effect only in the full synchronization phase.
      • You can also change the flow control mode after creating a task. For details, see Modifying the Flow Control Mode.

    Incremental Conflict Policy

    The conflict policy refers to the conflict handling policy during incremental synchronization. By default, conflicts in the full synchronization phase are ignored. Select any of the following conflict policies:

    • Ignore

      The system will skip the conflicting data and continue the subsequent synchronization process.

    • Overwrite

      Conflicting data will be overwritten.

    Topic

    Select a topic that stores TiDB binlogs in the Kafka, or synchronization will fail.

    Synchronization Object

    The left pane displays the source database objects, and the right pane displays the selected objects. DRS supports table- and database-level synchronization. You can select data for synchronization based on your service requirements.

    If the synchronization objects in source and destination databases have different names, you can map the source object name to the destination one. For details, see Mapping Object Names.

    If the database table name contains characters other than letters, digits, and underscores (_), or the mapped database table name contains hyphens (-) and number signs (#), the name length cannot exceed 42 characters.

    NOTE:
    • To quickly select the desired database objects, you can use the search function.
    • If there are changes made to the source databases or objects, click in the upper right corner to update the objects to be synchronized.
    • If the object name contains spaces, the spaces before and after the object name are not displayed. If there are multiple spaces between the object name and the object name, only one space is displayed.
    • The name of the selected synchronization object cannot contain spaces.

  5. On the Check Task page, check the synchronization task.

    • If any check fails, review the cause and rectify the fault. After the fault is rectified, click Check Again.

      For details about how to handle check failures, see Checking Whether the Source Database Is Connected in Data Replication Service User Guide.

    • If all check items are successful, click Next.
      Figure 9 Pre-check

      You can proceed to the next step only when all checks are successful. If there are any items that require confirmation, view and confirm the details first before proceeding to the next step.

  6. On the displayed page, specify Start Time, Send Notification, SMN Topic, Synchronization Delay Threshold, and Stop Abnormal Tasks After, confirm that the configured information is correct, select the check box before the agreement, and click Submit to submit the task.

    Figure 10 Task startup settings
    Table 12 Task startup settings

    Parameter

    Description

    Started Time

    Set Start Time to Start upon task creation or Start at a specified time based on site requirements.

    NOTE:

    After a synchronization task is started, the performance of the source and destination databases may be affected. You are advised to start a synchronization task during off-peak hours.

    Send Notifications

    SMN topic. This parameter is optional. If an exception occurs during synchronization, the system will send a notification to the specified recipients.

    SMN Topic

    This parameter is available only after you enable Send Notifications and create a topic on the SMN console and add a subscriber.

    For details, see Simple Message Notification User Guide.

    Synchronization Delay Threshold

    During an incremental synchronization, a synchronization delay indicates a time difference (in seconds) of synchronization between the source and destination database.

    If the synchronization delay exceeds the threshold you specify, DRS will send alarms to the specified recipients. The value ranges from 0 to 3,600. To avoid repeated alarms caused by the fluctuation of delay, an alarm is sent only after the delay has exceeded the threshold for six minutes.

    NOTE:
    • If the delay threshold is set to 0, no notifications will be sent to the recipient.
    • In the early stages of an incremental synchronization, the synchronization delay is long because a large quantity of data is awaiting synchronization. In this case, no notifications will be sent.
    • Before setting the delay threshold, enable Send Notification.

    Stop Abnormal Tasks After

    Number of days after which an abnormal task is automatically stopped. The value must range from 14 to 100. The default value is 14.

    NOTE:

    Tasks in the abnormal state are still charged. If tasks remain in the abnormal state for a long time, they cannot be resumed. Abnormal tasks run longer than the period you set (unit: day) will automatically stop to avoid unnecessary fees.

  7. After the task is submitted, you can view and manage it on the Data Synchronization Management page.

    • You can view the task status. For more information about task status, see Task Statuses.
    • You can click in the upper-right corner to view the latest task status.
    • By default, DRS retains a task in the Configuration state for three days. After three days, DRS automatically deletes background resources, and the task status remains unchanged. When you restart the task configuration, DRS applies for resources again.