Cloud SQL for MySQL Instance Migration Synchronization

NineData data replication supports structure, full data, and incremental data synchronization between Cloud SQL for MySQL instances.

Prerequisites

• The source and target data sources have been added to NineData. For details on how to add them, see Add Data Source.

  tip

  You can add a Cloud SQL for MySQL instance by going to Self-built Database > MySQL option.

• The source and target data source types are Cloud SQL for MySQL, with versions 8.0, 5.7, 5.6.

• The source data source must have Binlog enabled, and the Binlog-related parameters are set as follows:

  • binlog_format=ROW
  • binlog_row_image=FULL
  tip

  If the source data source is a replica, to ensure complete Binlog logs are obtained, the log_slave_updates parameter also needs to be enabled.

Usage Limitations

• The data replication function is only for the user databases in the data source, and the system databases will not be replicated. For example: information_schema, mysql, performance_schema, sys databases in MySQL type data sources will not be replicated.
• The account for source data must have SELECT (for replicate database structure and full data), SHOW VIEW (for replicate views), and REPLICATION CLIENT, REPLICATION SLAVE (for replicate incremental data) privileges on the objects to be replicated. The account for target must have DML and DDL privileges.
• Before performing data synchronization, user need to evaluate the performance of the source data source and the target data source, and it is recommended to perform data synchronization during off-peak time. Otherwise, the full data initialization will occupy a certain amount of read and write resources of the source data source and the target data source, increasing database load.
• During the synchronization process, if the source data contains views, functions, stored procedures, triggers, and events, after synchronizing to the target data source, the definer of the above objects information will be modified in the target data source to the account that accesses the target data source in the current synchronization task.
• It is necessary to ensure that each table in the synchronization object has a primary key or unique constraint, and the column name is unique, otherwise the same data may be synchronized repeatedly.
• During the synchronization process, if there are triggers in the source, the system will not synchronize the triggers until the incremental synchronization ends.

Operation Steps

Before performing this step, please execute the following authorization commands on the source and target ends according to your replication type to ensure the replication task proceeds normally.

Replication Type	Source	Target
Structure replication Full replication	GRANT SELECT ON *.* TO '<username>'@'%';	GRANT SELECT,INSERT,UPDATE,DELETE,CREATE ON . TO '<username>'@'%';
Incremental replication	GRANT SELECT, REPLICATION CLIENT, REPLICATION SLAVE ON *.* to '<username>'@'%';	GRANT SELECT,INSERT,UPDATE,DELETE,CREATE ON . TO '<username>'@'%';

Commercialization Notice

NineData’s data replication product has been commercialized. You can still use 10 replication tasks for free, with the following considerations:

• Among the 10 replication tasks, you can include 1 Incremental task, with a specification of Micro.

• Tasks with a status of Terminated do not count towards the 10-task limit. If you have already created 10 replication tasks and want to create more, you can terminate previous replication tasks and then create new ones.

• When creating replication tasks, you can only select the Spec you have purchased. Specifications that have not been purchased will be grayed out and cannot be selected. If you need to purchase additional specifications, please contact us through the customer service icon at the bottom right of the page.

1. Log in to the NineData Console.

2. In the left navigation pane, click Replication > Data Replication.

3. On the Replication page, click Create Replication in the upper-right corner.

4. On the Source & Target tab, configure the parameters in the following table, and click Next.

   Parameter	Description
   Name	Enter a name for the data synchronization task. To make the task easier to find and manage later, use a meaningful name. Up to 64 characters are supported.
   Source	The data source that contains the objects to synchronize.
   Target	The data source that receives the synchronized objects.
   Target Object Name	Select the case conversion rule for object names after they are migrated from the source to the target. Convert all to Lowercase: Regardless of the naming rule on the source, all target names are lowercase. Consistent with Source: Keep the naming rule of the source. Convert all to Uppercase: Regardless of the naming rule on the source, all target names are uppercase.
   Replication Mode	Select the replication mode. Uni-directional: A unidirectional data replication task from the source data source to the target data source. Bi-directional: A bidirectional incremental data replication task between the source and target data sources.
   Type	Required when Replication Mode is Bi-directional.Select the replication type. Schema: Synchronize only the database and table schemas of the source data source, without synchronizing data. Full: Synchronize all objects and data from the source data source, namely full data replication. The switch on the right enables periodic full replication. For more information, see Periodic Full Replication. Incremental: After full synchronization is complete, perform incremental synchronization based on the logs of the source data source.The icon is used to configure incremental operation types. You can clear specific operation types as needed. Cleared operation types will be ignored during incremental synchronization.
   Forward Type	Required when Replication Mode is Bi-directional. Select the forward replication type. Schema: Synchronize only the database and table schemas of the source data source, without synchronizing data. Full: Synchronize all objects and data from the source data source, namely full data replication. Incremental: After full synchronization is complete, perform incremental synchronization based on the logs of the source data source.The icon is used to configure incremental operation types. You can clear specific operation types as needed. Cleared operation types will be ignored during incremental synchronization.
   Incremental Started	Required only when Type is Incremental. From Started: Use the current replication task start time as the baseline for incremental replication. Customized Time: Select the point in time from which incremental replication starts. You can select a time zone based on the region of your business. If the configured time point is earlier than the current replication task start time and DDL operations occurred during that period, the replication task will fail.
   Forward Incremental Started	Required only when Forward Type is Incremental. From Started: Use the current replication task start time as the baseline for incremental replication. Customized Time: Select the point in time from which incremental replication starts. You can select a time zone based on the region of your business. If the configured time point is earlier than the current replication task start time and DDL operations occurred during that period, the replication task will fail.
   Reverse Type	The replication type from the target data source to the source data source. This parameter is displayed only when Replication Mode is Bi-directional. Only Incremental is supported, and it is selected by default and cannot be disabled.
   Spec (Unavailable only when Schema is selected)	The specification of the replication task. A larger specification provides a higher replication rate. Hover over the icon to view the rate and configuration information of each specification. Each specification shows the available quantity and total quantity. When the available quantity is 0, the specification is grayed out and cannot be selected.
   If target table already exists (Required when Schema is selected)	Pre-Check Error and Stop Task: Stop the task when a table with the same name is detected during the precheck stage. Skip and Continue Task: When a table with the same name is detected during the precheck stage, display a prompt and continue the task. During schema replication, ignore the table with the same name. If you also perform data replication, data is appended to the table with the same name and existing data is not overwritten. Delete Objects and Rewrite: When a table with the same name is detected during the precheck stage, display a prompt and continue the task. During schema replication, delete the table with the same name in the target database and replicate the table schema again based on the source database. If you also perform data replication, data is written after schema replication is complete.
   Target Table Exists Data (Required when Full is selected)	Pre-Check Error and Stop Task: Stop the task when data is detected in the target table during the precheck stage. Ignore existing target data and append to it.: When data is detected in the target table during the precheck stage, ignore that data and append other data. Clear target existing data before write: When data is detected in the target table during the precheck stage, delete that data and write it again.
   Incremental data conflict handling strategy for target table (Required when Incremental is selected)	Runtime error: During incremental replication, report an error when target data already exists and wait for manual intervention. Do not update target data: During incremental replication, do not write data when target data already exists, and continue subsequent tasks. Update target data: During incremental replication, overwrite the target data when target data already exists.

5. On the Objects tab, configure the following parameters, and click Next.

   Parameter	Description
   Replication Objects	Select the content to replicate. You can select All Objects to replicate all content in the source database, or select Customized Object, select the content to replicate in the Source Object list, and click > to add it to the Target Object list on the right.
   Blacklist	Click Add to add a blacklist record, and select the database or object to add to the blacklist. The selected content will not be replicated. This is used to exclude specific databases or objects when performing full-database replication for Customized Object or Full Instance. Left drop-down list: Select the database name to add to the blacklist. Right drop-down list: Select objects in the corresponding database. You can click multiple objects to select them. Leave it empty to add the entire database to the blacklist. To add multiple databases to the blacklist, click the Add button below to add another row.

   If you need to create multiple replication links with the same replication objects, you can create a configuration file and import it when creating a task. Click Import Config in the upper-right corner, click Download Template to download the configuration file template, edit the file, and then click Upload to upload it for batch import. Configuration file description:

   Parameter	Description
   source_table_name	The source table name of the object to synchronize.
   destination_table_name	The target table name that receives the synchronized object.
   source_schema_name	The source schema name of the object to synchronize.
   destination_schema_name	The target schema name that receives the synchronized object.
   source_database_name	The source database name of the object to synchronize.
   target_database_name	The target database name that receives the synchronized object.
   column_list	The list of columns to synchronize.
   extra_configuration	Additional configuration information. You can configure the following information here: column_rules: Defines column mappings and value rules. Field descriptions: column_name: Original column name. destination_column_name: Specifies the target column name. column_value: Specifies the column value, which can be an SQL function or a constant value. filter_condition: Specifies row-level data filtering conditions. Only rows that meet the conditions are replicated.

   tip

   • The following is an example of extra_configuration:

     {
       "extra_config":{
         "column_rules":[
           {
             "column_name": "created_time", // Specifies the original column name to be mapped.
             "destination_column_name": "migrated_time", // Maps the target column name to "migrated_time".
             "column_value": "current_timestamp()" // Changes the column value to the current timestamp.
           }
         ],
         "filter_condition": "id != 0" // Only rows whose ID is not 0 are synchronized.
       }
     }

   • For a complete example of the configuration file, see the downloaded template.

6. On the "Mapping" tab, choose different operations based on the selected replication type, and click Save and Pre-Check. If the source and target data sources are updated during mapping configuration, click Refresh Metadata in the upper-right corner of the page to refresh the source and target data source information.

   • Includes Schema: Configure the table name after synchronization to the target data source.

   • Does not include Schema: The system selects the database with the same name in the target data source by default. If no such database exists, you need to manually select the target database. The table names and column names in the target database must match the synchronization objects. If they do not match, you can manually map the table names and column names.

   You can also perform the following operations:

   • Click Mapping & Filtering on the right side of the page to customize the column names after synchronization to the target data source.
   • On the Mapping & Filtering page, click Data Filter to configure filtering conditions by using comparison expressions. Only data that meets the filtering conditions is synchronized to the target data source. For example, if the filtering condition is set to emp_no>=10005, data whose emp_no column value is less than 10005 is not synchronized to the target data source.
   • Click the icon to the right of "Target Table" to search for a table name and replace it with the target name.
   • Enter a table name in the Search Table text box in the upper-right corner to quickly locate the target table.
   • Click Batch Configuration in the upper-right corner to define common rules in batches, such as table name and column name case conversion, prefix or suffix addition, and replacement, so that mapping configuration can be applied uniformly to a large number of tables and columns.

7. On the Pre-check tab, wait for the system to complete the precheck. After the precheck is passed, click Launch.

   • You can select Enable data consistency comparison. After the synchronization task is complete, a data consistency comparison task based on the source data source automatically starts to ensure data consistency between both ends. Based on the selected Type, Enable data consistency comparison starts at the following times:

     • Schema: Starts after schema replication is complete.
     • Schema+Full: Starts after full replication is complete.
     • Full: Starts after full replication is complete.
     • Schema+Full+Incremental, Incremental: Starts when incremental data is consistent with the source data source for the first time and Delay is 0 seconds. You can click View Details and view the synchronization delay on the Details page.

   • If the precheck fails, click Details in the Actions column on the right of the failed check item, troubleshoot the cause, manually fix the issue, and then click Check Again to run the precheck again until it passes.

   • Check items whose Result is Warning can be fixed or ignored depending on the situation.

8. On the Launch page, the Launch Successfully prompt appears, indicating that the synchronization task has started. You can then perform the following operations:

   • Click View Details to view the execution status of each stage of the synchronization task.

   • Click Back to list to return to the Replication task list page.

View Synchronization Results

1. Log in to the NineData Console.

2. Click on Replication > Data Replication in the left navigation bar.

3. On the Replication page, click on the Task ID of the target synchronization task, the page details are as follows.

   

   Number	Function	Description
   1	Sync Delay	The data synchronization delay between the source data source and the target data source. 0 seconds means there is no delay between the two ends, at which point you can choose to switch the business to the target data source for smooth migration.
   2	Configure Alerts	After configuring alerts, the system will notify you in the way you choose when the task fails.
   3	More	Pause: Pause the task, only tasks with Running status are selectable. Duplicate: Create a new replication task with the same configuration as the current task. Terminate: End tasks that are unfinished or listening (i.e., in incremental synchronization). Once the task is terminated, it cannot be restarted, so please proceed with caution. If the synchronization objects contain triggers, a trigger replication option will pop up, please select as needed. Delete: Delete the task. Once the task is deleted, it cannot be recovered, so please proceed with caution.
   4	Structure Replication (displayed in scenarios involving structure replication)	Displays the progress and detailed information of structure replication. Click on Log on the right side of the page: View the execution logs of structure replication. Click on on the right side of the page: View the latest information. Click on View DDL in the Actions column on the right side of the target object in the list: View SQL playback.
   5	Full Replication (displayed in scenarios involving full replication)	Displays the progress and detailed information of full replication. Click on Monitor on the right side of the page: View various monitoring indicators during full replication. During full replication, you can also click on Flow Control Settings on the right side of the monitoring indicator page to limit the rate of writing to the target data source per second. The unit is rows/second. Click on Log on the right side of the page: View the execution logs of full replication. Click on on the right side of the page: View the latest information.
   6	Incremental Replication (displayed in scenarios involving incremental replication)	Displays various monitoring indicators of incremental replication. Click on View Threads on the right side of the page: View the operations currently being executed by the current replication task, including: Thread ID: Replication tasks are executed in multiple threads, displaying the current thread number in progress. Execute SQL: Details of the SQL statement currently being executed by the current thread. Response Time: The response time of the current thread. If this value increases, it indicates that the current thread may be stuck for some reason. Event Time: The timestamp when the current thread was started. Status: The status of the current thread. Click on Flow Control Settings on the right side of the page: Limit the rate of writing to the target data source per second. The unit is rows/second. Click on Log on the right side of the page: View the execution logs of incremental replication. Click on on the right side of the page: View the latest information.
   7	Modify Object	Displays the modification records of synchronization objects. Click on Modify Objects on the right side of the page to configure the synchronization objects. Click on on the right side of the page: View the latest information.
   8	Data Comparison	Displays the comparison results between the source data source and the target data source. If you have not enabled data comparison, please click on Enable Comparison on the page. Click on Re-compare on the right side of the page: Re-initiate the comparison between the current source and target data sources. Click on Stop on the right side of the page: After the comparison task starts, you can click this button to stop the comparison task immediately. Click on Log on the right side of the page: View the execution logs of consistency comparison. Click on Monitor (displayed only in data comparison): View the trend chart of RPS (records per second) comparison. Click on Details to view earlier records. Click on in the Actions column on the right side of the comparison list (displayed under the Data tab only in the case of inconsistency): View details of the comparison between the source and target sides. Click on in the Actions column on the right side of the comparison list (displayed only in the case of inconsistency): Generate change SQL. You can directly copy this SQL to the target data source to execute and modify the inconsistent content.
   9	Expand	Display detailed information of the current replication task. Common Options: Export table configuration: Export the current task's database and table configuration, allowing for quick import when creating a new replication task. This helps rapidly establish multiple replication links with the same replication objects. Alert Rules: Configure the alarm strategy for the current task.

Appendix: Pre-Check Items

Check Item	Check Content
Target database data existence check	Check if the data to be replicated already exists in the target database
Target database same-name object existence check	Check if the object to be replicated already exists in the target database
Non-table object Definer existence check	Check if the Definer for View, Trigger, Procedure, Function, Event exists in the target database
Source data source connection check	Check the gateway status of the source data source, whether the instance is reachable, and the accuracy of the username and password
Target data source connection check	Check the gateway status of the target data source, whether the instance is reachable, and the accuracy of the username and password
Target database permission check	Check if the account permissions of the target database meet the requirements
Source database permission check	Check if the account permissions of the source database meet the requirements
Source and target data source collation rule check	Check if the collation rules of the source and target databases are compatible
Target data source trigger check	Check if there are triggers in the target database
Source database log_slave_updates support check	When the source database is a replica, check if log_slave_updates is ON
Source and target data source version check	Check if the versions of the source and target databases are compatible
Source database Binlog enabled check	Check if the Binlog is enabled in the source database
Source database Binlog Format support check	Check if the Binlog format of the source database is 'ROW'
Source database binlog_row_image support check	Check if the binlog_row_image of the source database is 'FULL'
Source and target data source time zone check	Check if the time zones of the source and target databases are consistent
Source and target data source character set check	Check if the character sets of the source and target databases are compatible
Source and target data source SQL_MODE check	Check if the SQL_MODE of the source and target databases are compatible
Source and target data source case sensitive parameter configuration check	Check if the case sensitive parameter configuration of the source and target databases are compatible
Source and target data source explicit_defaults_for_timestamp check	Check if the explicit_defaults_for_timestamp of the source and target databases are compatible
Source database stored procedure and function check	Check if the permissions for obtaining the definition of stored procedures and functions in the source database have been granted

Related Documentation

Data Replication Introduction