Skip to main content

PolarDB-X

Target DataSource:

Connection

Basic Functions

FunctionDescription
Schema Migration

If the target schema does not exist, BladePipe will automatically generate and execute CREATE statements based on the source metadata and the mapping rule.

Full Data Migration

Migrate data by sequentially scanning data in tables and writing it in batches to the target database.

Incremental Data Sync

Sync of common DML like INSERT, UPDATE, DELETE is supported.

Data Verification and Correction

Verify all existing data. Optionally, you can correct the inconsistent data based on verification results. Scheduled DataTasks are supported.
For more information, see Create Verification and Correction DataJob.

Subscription Modification

Add, delete, or modify the subscribed tables with support for historical data migration. For more information, see Modify Subscription.

Position Resetting

Reset positions by file position or timestamp. Allow re-consumption of incremental data logs in a past period or since a specific Binlog file and position.

Table Name Mapping

Support the mapping rules, namely, keeping the name the same as that in Source, converting the text to lowercase, converting the text to uppercase, truncating the name by "_digit" suffix.

Metadata Retrieval

Retrieve the target metadata with filtering conditions from the source table.

Advanced Functions

FunctionDescription
Removal of Target Data before Full Data Migration

Remove the existing data in the Target before running the Full Data Migration, applicable for DataJobs reruning and scheduled Full Data migrations.

Recreating Target Table

Recreate target tables before running the Full Data Migration, applicable for DataJobs reruning and scheduled Full Data migrations.

Incremental Data Write Conflict Resolution Rule

IGNORE: Ignore primary key conflicts (skip writing), REPLACE: Replace the entire row in case of primary key conflicts.

Handling of Zero Value for Time

Allow setting zero value for time to different data types to prevent errors when writing to the Target.

Custom Code

For more information, see Custom Code Processing, Debug Custom Code and Logging in Custom Code.

Data Filtering Conditions

Support data filtering using WHERE conditions, with SQL-92 as the SQL language. For more information, see Data Filtering.

Limits

LimitDescription
Supported Version

Only support PolarDB-X 2.0.

PolarDB-X 2.0 Character Set

Support utf8, utf8mb4, latin1. Other encodings are not yet tested.

Source Database Restrictions

Incremental data sync is not supported if table names to be synced in the source PolarDB-X 2.0 contain uppercase letters.


Source

Prerequisites

PrerequisiteDescription
Permissions for Account

Require read and write permissions for cloud database account.
For self-managed database, the following permissions are required:

  • GRANT SELECT ON . TO 'user'@'host'
  • GRANT REPLICATION CLIENT ON . TO 'user'@'host'
  • GRANT REPLICATION SLAVE ON . TO 'user'@'host'

Parameters

ParameterDescription
parseBinlogParallel

Number of threads for parallel parsing of Binlog in Incremental DataJobs.

parseBinlogBufferSize

Size of the circular buffer for parsing Binlog in Incremental DataJobs.

maxTransactionSize

Maximum number of data rows per transaction. If exceeded, the transaction will be split and flushed in parts.

limitThroughputMb

Limit the throughput of incremental Binlogs.

needJsonEscape

Escape special characters in JSON to be written to the target database.

Tips: To modify the general parameters, see General Parameters and Functions.


Target

Prerequisites

PrerequisiteDescription
Permissions for Account

See Permissions Required for MySQL/MariaDB.

Port Preparation

Allow the migration and sync node (Worker) to connect to the MySQL/MariaDB port (e.g., 3306).

Parameters

ParameterDescription
keyConflictStrategy

Strategy for handling primary key conflicts during write in Incremental DataTask:

  • IGNORE: Ignore conflicts (default)
  • REPLACE: Replace conflicts (optional)

dstWholeReplace

Convert INSERT and UPDATE operations into full row replacement in the Target.

deCycle

Enable filtering in bidirectional sync to filter DML/DDL with specific markers.

specialSqlMode

Set a specific SQL mode when initializing the connection between databases.

defaultGisSRID

Set the SRID for GIS data types.

dstTimeZone

Target time zone, e.g., +08:00, Asia/Shanghai, America/New_York, etc.

increParallelApplyStrategy

Parallel write strategy for relational databases in the Target:

  • KEY: Parallel writing to partitions separated based on primary keys.
  • TABLE: Parallel writing to partitions separated based on tables.
  • KEY_UPGRADE_TABLE: Parallel writing to partitions separated based on primary keys. Upgrade the partition to a table if there is an update to the unique key.

Tips: To modify the general parameters, see General Parameters and Functions.

Connection

Basic Functions

Advanced Functions

Limits

Example

FAQ

Source

Prerequisites

Parameters

Target

Prerequisites

Parameters