MySQL to openGauss Data Replication

NineData Data Replication supports schema, full, and incremental replication from MySQL to openGauss. This page describes the schema-plus-full configuration flow shown in the current console.

Before you begin

• Add the MySQL source data source and the openGauss target data source to NineData, and make sure that the target data source is available. For instructions, see Add Data Source.

• When you create the task, select MySQL as the source data source type and openGauss as the target data source type.

• The replication task must be able to access both data sources. The required account privileges, version compatibility, and target-side status are determined by the precheck results when you create the task.

Restrictions

• For this link, the Full Replication option displays the periodic full replication switch. Whether to enable it and which parameters are available depend on the current page.

• Confirm the target database, target schema, and target table on the mapping page. The available databases, tablespaces, and owners depend on the metadata returned by the target data source.

Procedure

1. Sign in to the NineData Console.

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

3. On the Replication page, click Create Replication.

4. On the Source & Target tab, configure the fields in the 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 DB	Select the target database to which data is synchronized.
   Type	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 completes, perform incremental synchronization based on the logs of the source data source.
   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. 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.
   Spec	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. If you configure the data replication task before purchasing resources, you can select the required specification here. If you purchase resources before configuring the task, NineData selects the specification specified during purchase, and you cannot change it in the task configuration.
   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 message 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 message 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 completes.
   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 parameters in the table, and click Next.

   Parameter	Description

   To create multiple replication tasks with the same replication objects, import a configuration file. Click Import Config, click Download Template to download the template, edit the file, and then click Upload to upload it and import the objects in bulk. For field descriptions and examples, see Import Replication Object Templates. The configuration file uses these fields:

   Parameter	Description	Example
   source_table_name	The exact source table name of the object to synchronize.	example_tbl_name
   target_table_name	The target table name that receives the synchronized object.	example_tbl_name
   source_database_name	The source database name of the object to synchronize.	test_db
   target_database_name	The target database name that receives the synchronized object.	test_db_bak
   column_list	The list of columns to synchronize.	["col1", "clo2", "col3"]
   extra_configuration	A JSON string containing additional configuration. Use column_rules for column mappings and value rules: column_name is the source column, target_column_name is the target column, target_column_type is the target column type, and column_value is the column value. Use filter_condition for row-level filtering.	{"extra_config": {"column_rules": [...]}}

   tip

   The following JSON represents the two example rows in the downloaded Excel template. When uploading the file, keep the Excel column names and enter the extra_configuration value as a JSON string. This code block is not a JSON file that you can upload directly.

   [
     {
       "source_table_name": "example_tbl_name",
       "target_table_name": "example_tbl_name",
       "source_database_name": "test_db",
       "target_database_name": "test_db_bak",
       "column_list": ["col1", "clo2", "col3"],
       "extra_configuration": {
         "extra_config": {
           "column_rules": [
             {
               "column_name": "example_column_name",
               "target_column_name": "example_target_column_name",
               "target_column_type": "int",
               "column_value": "current_timestamp()"
             },
             {
               "column_name": "example_column_name",
               "target_column_name": "example_target_column_name",
               "target_column_type": "int"
             }
           ],
           "filter_condition": "example_condition_expression"
         }
       }
     },
     {
       "source_table_name": "example_order_tbl",
       "target_table_name": "example_order_tbl",
       "source_database_name": "test_db",
       "target_database_name": "test_db_bak",
       "column_list": ["col1", "clo2", "col3"],
       "extra_configuration": {
         "extra_config": {
           "column_rules": [
             {
               "column_name": "example_column_name",
               "target_column_name": "example_target_column_name",
               "target_column_type": "int",
               "column_value": "current_timestamp()"
             },
             {
               "column_name": "example_column_name",
               "target_column_name": "example_target_column_name",
               "target_column_type": "int"
             }
           ],
           "filter_condition": "example_condition_expression"
         }
       }
     }
   ]

6. On the Mapping tab, configure the mapping that matches the selected replication type, then click Save and Pre-Check. If source or target metadata changes while you configure mappings, click Refresh Metadata to refresh the metadata.

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

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

   Other available actions:

   • Click Mapping & Filtering to customize the column names after synchronization to the target data source.
   • On the Mapping & Filtering page, enter a comparison expression in the text box below Data Filter as the filtering condition. 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 to quickly locate the target table.
   • Click Batch Configuration to define common rules in batches, such as table name and column name case conversion, prefix or suffix addition, and replacement. Use this option to apply mapping configuration to many tables and columns at the same time.

• Click Set Tablespace on the page to specify the Tablespace for tables and indexes in the target data source. This controls the physical storage location of objects in the target database. If you do not configure it, the default Tablespace of the target database user is used.

7. On the Pre-check tab, wait for NineData to complete the precheck. After the precheck passes, click Launch.

   • Select Enable data consistency comparison to start a data consistency comparison task based on the source data source after synchronization completes. Based on the selected Type, Enable data consistency comparison starts at these times:

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

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

   • Items with Warning in Result can be fixed or ignored if required.

8. On the Launch page, the Launch Successfully message appears, indicating that the synchronization task has started. Then perform these actions:

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

Modify incremental synchronization positions

For a task whose replication type includes Incremental and whose task details provide position management, you can view and modify synchronization positions. The available position types and input format depend on the data source and replication link. Follow the options displayed for the current task. If a position is shown as - or no position type is available for selection, the current task has no position available for modification.

This feature is intended for specific operations and maintenance scenarios where you need to specify a new log-read position or synchronization-write position for an incremental task. The read position controls where the task continues reading from the source, while the write position controls where it continues processing synchronized writes. After you submit the change, the task pauses and restarts so that the new position can take effect.

1. In the replication task list, click the Task ID of the target task to open its details.

2. On the Incremental tab, click Synchronous site management to view the current read site and write site.

3. Click modify site. Under site type, select the read site or write site to adjust, and then enter the value for Adjustment point according to the position type displayed for the task.

4. Confirm the value and scope of impact, and click Verify and submit. The task enters a pause and relaunch process. After the task resumes running, open Synchronous site management again to confirm that the position has been updated.

danger

Modifying the synchronization point will adjust the point of log reading or synchronization writing, which may cause data loss, so operate with caution! Modifying either position may cause data loss or inconsistency between the source and target. Perform this operation only in an authorized test environment or during a maintenance window with a backup and rollback plan. A task whose incremental replication has finished cannot have its position reset.

On the Mapping tab, you can configure the following items:

• Confirm the target database, target schema, and target table in the object mapping list.

• Object Owner defaults to the account used to connect to the data source. Open the drop-down menu to select another owner when needed. The available options depend on the metadata returned by the target data source.

• Click Mapping & Filtering to view the source-to-target column mappings. Enter a comparison expression directly in the text box below Data Filter; you do not need to click the condition name first.

• Click Batch Configuration to define batch rules by source database name, source table name, and operation, and add business field settings when needed. The current page warns that without schema replication, a replace operation does not replace the target table when the target table does not exist.

• Click Advanced Settings to open Set Tablespace, where you can configure Table Tablespace, Index Tablespace, and Table Owner separately. The available options depend on the metadata returned by the target data source.

Precheck items

The precheck page for this link contains the following items:

Check item	What NineData checks
Source data source connection check	Checks the source gateway status, instance reachability, and username and password.
Target data source connection check	Checks the target gateway status, instance reachability, and username and password.
Source database permission check	Checks whether the source database account has the required permissions.
Target database permission check	Checks whether the target database account has the required permissions.
Source and target data source version check	Checks whether the source and target database versions are compatible.
Target database data existence check	Checks whether the replication objects already contain data in the target database.
Target same-name object existence check	Checks whether the replication objects already exist in the target database.
Circular replication check	Checks whether a replication loop exists.
Check whether the target database instance is read-only	Checks whether the target database instance is read-only.
Source federated table availability check	Checks the availability of federated tables on the source.

The bottom of the precheck page provides the Enable data consistency comparison checkbox. When selected, the system starts a consistency comparison after full replication is complete. Whether this option is displayed and its execution timing depend on the current page.

Related topics

Data Replication overview