Migrate data from a self-managed PostgreSQL database to a PolarDB for PostgreSQL cluster - Data Transmission Service

This topic describes how to migrate data from a self-managed PostgreSQL database to a PolarDB for PostgreSQL cluster by using Data Transmission Service (DTS).

Prerequisites

The destination PolarDB for PostgreSQL cluster is created. For more information, see Create a PolarDB for PostgreSQL cluster.
The available storage space of the destination PolarDB for PostgreSQL cluster is larger than the total size of the data in the source self-managed PostgreSQL database.

Usage notes

Note

During schema migration, DTS migrates foreign keys from the source database to the destination database.
During full data migration and incremental data migration, DTS temporarily disables the constraint check and cascade operations on foreign keys at the session level. If you perform the cascade and delete operations on the source database during data migration, data inconsistency may occur.

Category	Description
Limits on the source database	The server to which the source database belongs must have sufficient outbound bandwidth. Otherwise, the data migration speed decreases. The tables to be migrated must have PRIMARY KEY or UNIQUE constraints and all fields must be unique. Otherwise, the destination database may contain duplicate data records. The name of the source database cannot contain hyphens (-). Example: dts-testdata. If you select tables as the objects to be migrated and you need to edit the tables, such as renaming tables or columns, in the destination database, you can migrate up to 1,000 tables in a single data migration task. If you run a task to migrate more than 1,000 tables, a request error occurs. In this case, we recommend that you configure multiple tasks to migrate the tables, or configure a task to migrate the entire database. If you need to migrate incremental data, you must make sure that the following requirements are met: The value of the wal_level parameter must be set to logical. For incremental data migration, the write-ahead logging (WAL) logs of the source database must be stored for more than 24 hours. For full data and incremental data migration, the WAL logs of the source database must be stored for at least seven days. Otherwise, DTS may fail to obtain the WAL logs and the task may fail. In exceptional circumstances, data inconsistency or loss may occur. After full data migration is complete, you can set the retention period to more than 24 hours. Make sure that you set the retention period of WAL logs based on the preceding requirements. Otherwise, the service reliability and performance stated in the Service Level Agreement (SLA) of DTS may not be guaranteed. Limits on operations to be performed on the source database: If you perform a primary/secondary switchover on a self-managed PostgreSQL database, the data migration task fails. During full data migration, do not perform DDL operations to change the schemas of databases or tables. Otherwise, the data migration task fails. If you perform only full data migration, do not write data to the source database during data migration. Otherwise, data inconsistency may occur between the source and destination databases. To ensure data consistency, we recommend that you select full data migration and incremental data migration as the migration types. If one or more long-running transactions exist in the source database and incremental data is migrated in the data migration task, the WAL logs generated before the long-running transactions in the source database are committed may be accumulated. As a result, the disk space of the source database may be insufficient.
Other limits	If you select a schema as the object to be migrated and create a table in the schema or execute the RENAME statement to rename a table in the schema during incremental data migration, you must execute the `ALTER TABLE schema.table REPLICA IDENTITY FULL;` statement before you write data to the table. Note Replace the `schema` and `table` in the preceding sample statement with the actual schema name and table name. DTS creates the following temporary tables in the source database to obtain the DDL statements of incremental data, the schemas of incremental tables, and the heartbeat information. During data migration, do not delete temporary tables in the source database. Otherwise, the data migration task may fail. After the DTS instance is released, temporary tables are automatically deleted. `public.dts_pg_class`, `public.dts_pg_attribute`, `public.dts_pg_type`, `public.dts_pg_enum`, `public.dts_postgres_heartbeat`, `public.dts_ddl_command`, and `public.dts_args_session`. To ensure that the latency of incremental data migration is accurate, DTS creates a heartbeat table named `dts_postgres_heartbeat` in the source database. During incremental data migration, DTS creates a replication slot for the source database. The replication slot is prefixed with `dts_sync_`. DTS automatically clears historical data in the replication slot every 90 minutes to reduce storage usage. Note If the data migration task is released or fails, DTS automatically clears the replication slot. If a primary/secondary switchover is performed on the ApsaraDB RDS for PostgreSQL instance, you must log on to the secondary database to manually clear the replication slot. A data migration task can migrate data from only one database. To migrate data from multiple databases, you must create a data migration task for each database. Before you migrate data, evaluate the impact of data migration on the performance of the source instance and destination cluster. We recommend that you migrate data during off-peak hours. During full data migration, DTS uses the read and write resources of the source and destination databases. This may increase the loads of the database servers. During full data migration, concurrent INSERT operations cause fragmentation in the tables of the destination database. After full data migration is complete, the tablespace of the destination database is larger than that of the source database. Make sure that the precision settings for columns of the FLOAT or DOUBLE data type meet your business requirements. DTS uses the `ROUND(COLUMN,PRECISION)` function to retrieve values from columns of the FLOAT or DOUBLE data type. If you do not specify a precision, DTS sets the precision for the FLOAT data type to 38 digits and the precision for the DOUBLE data type to 308 digits. DTS attempts to resume data migration tasks that failed within the last seven days. Before you switch workloads to the destination database, you must stop or release the failed tasks. You can also execute the `REVOKE` statement to revoke the write permissions from the accounts that are used by DTS to access the destination database. Otherwise, the data in the source database overwrites the data in the destination database after the failed task is resumed. DTS does not check the validity of metadata such as sequences. You must manually check the validity of metadata. After your workloads are switched to the destination database, newly written sequences do not increment from the maximum value of the sequences in the source database. Therefore, you must query the maximum value of the sequences in the source database before you switch your workloads to the destination database. Then, you must specify the queried maximum value as the starting value of the sequences in the destination database. You can execute the following statements to query the maximum value of the sequences in the source database: `do language plpgsql $$ declare nsp name; rel name; val int8; begin for nsp,rel in select nspname,relname from pg_class t2 , pg_namespace t3 where t2.relnamespace=t3.oid and t2.relkind='S' loop execute format($_$select last_value from %I.%I$_$, nsp, rel) into val; raise notice '%', format($_$select setval('%I.%I'::regclass, %s);$_$, nsp, rel, val+1); end loop; end; $$;`

Billing

Migration type	Instance configuration fee	Internet traffic fee
Schema migration and full data migration	Free of charge.	Charged only when data is migrated from Alibaba Cloud over the Internet. For more information, see Billing overview.
Incremental data migration	Charged. For more information, see Billing overview.

Migration types

Schema migration
DTS migrates the schemas of objects from the source database to the destination database.
Full data migration
DTS migrates the existing data of objects from the source database to the destination database.
Incremental data migration
After full data migration is complete, DTS migrates incremental data from the source database to the destination database. Incremental data migration allows data to be migrated smoothly without interrupting services of self-managed applications during data migration.

SQL operations that support incremental data migration

Operation type	SQL statement
DML	INSERT, UPDATE, and DELETE
DDL	DDL operations can be migrated only in the data migration tasks that are created after October 1, 2020. Important For a data migration task created before May 12, 2023, you must create a trigger and a function in the source database to capture DDL information before you configure the data migration task. For more information, see Use triggers and functions to implement incremental DDL migration for PostgreSQL databases. Incremental data migration does not support data of the BIT type. If the database account of the source database is a privileged account, the following DDL statements can be migrated in data migration tasks. CREATE TABLE and DROP TABLE ALTER TABLE, including RENAME TABLE, ADD COLUMN, ADD COLUMN DEFAULT, ALTER COLUMN TYPE, DROP COLUMN, ADD CONSTRAINT, ADD CONSTRAINT CHECK, and ALTER COLUMN DROP DEFAULT TRUNCATE TABLE (The database engine version of the source PostgreSQL database must be PostgreSQL 11 or later.) CREATE INDEX ON TABLE Important You cannot migrate additional information of DDL statements, such as CASCADE or RESTRICT. You cannot migrate the DDL statements from a session where the `SET session_replication_role = replica` statement is executed. If the SQL statements submitted by the source database at a time contain both DML and DDL statements, DTS does not migrate the DDL statements. If the SQL statements submitted by the source database at a time contain DDL statements on objects not to be migrated, DTS does not migrate the DDL statements. The CREATE SEQUENCE statement is not supported.

Permissions required for database accounts

Database	Schema migration	Full data migration	Incremental data migration
Self-managed PostgreSQL database	USAGE permission on pg_catalog	SELECT permission on the objects to migrate	Permissions of the superuser role
PolarDB for PostgreSQL	The permissions of the schema owner. Note You can use the database owner that is specified during database creation.

For more information about how to create a database account and grant permissions to the account, see the following topics.

Self-managed PostgreSQL database: CREATE USER and GRANT
PolarDB for PostgreSQL cluster: Create a database account and Database management.

Preparations

Note

In the following example, the Linux operating system is used.

If the version of the self-managed PostgreSQL database is 10.1 or later, you must perform the following operations before you configure a data migration task.

Log on to the server where the self-managed PostgreSQL database resides.
Set the wal_level parameter in the postgresql.conf configuration file to logical.
Note
After you modify the configuration file, execute the SELECT pg_reload_conf(); statement or restart the self-managed PostgreSQL database for the parameter to take effect.
Add the CIDR blocks of DTS servers to the pg_hba.conf configuration file of the self-managed PostgreSQL database. Add only the CIDR blocks of the DTS servers that reside in the same region as the destination database. For more information, see Add the CIDR blocks of DTS servers to the security settings of on-premises databases.
Note
For more information, see The pg_hba.conf File. Skip this step if you have set the IP address in the pg_hba.conf file to 0.0.0.0/0. The following figure shows the configurations.
Create the corresponding database and schema in the destination cluster based on the information of the database and schema of the object to be migrated.

If the version of the self-managed PostgreSQL database is 9.4.8 to 10.0, you must perform the following operations before you configure a data migration task:

Download the PostgreSQL source code from the official website, and compile and install the source code.
1. Download the source code from the PostgreSQL official website based on the version of the self-managed PostgreSQL database.
2. Run the sudo ./configure, sudo make, and sudo make install commands in sequence to configure, compile, and install the source code.
  Important
  When you compile the source code and install PostgreSQL, the operating system version of PostgreSQL must be consistent with the GNU Compiler Collection (GCC) version.
  If an error occurs when you run the sudo ./configure command, you can modify the command based on the error message. For example, if the error message is readline library not found. Use --without-readline to disable readline support., you can modify the command to sudo ./configure --without-readline.
  If you use other methods to install PostgreSQL, you must compile the ali_decoding plug-in in a test environment that has the same operating system version and GCC version.

Download the ali_decoding plug-in provided by DTS, and compile and install the plug-in.

Download ali_decoding.
Copy the ali_decoding directory to the contrib directory of PostgreSQL (compiled and installed).

Go to the ali_decoding directory and replace the content of the Makefile file with the following script:

# contrib/ali_decoding/Makefile
MODULE_big = ali_decoding
MODULES = ali_decoding
OBJS    = ali_decoding.o

DATA = ali_decoding--0.0.1.sql ali_decoding--unpackaged--0.0.1.sql

EXTENSION = ali_decoding

NAME = ali_decoding

#subdir = contrib/ali_decoding
#top_builddir = ../..
#include $(top_builddir)/src/Makefile.global
#include $(top_srcdir)/contrib/contrib-global.mk

#PG_CONFIG = /usr/pgsql-9.6/bin/pg_config
#pgsql_lib_dir := $(shell $(PG_CONFIG) --libdir)
#PGXS := $(shell $(PG_CONFIG) --pgxs)
#include $(PGXS)

# Run the following commands to install the source code:
ifdef USE_PGXS
PG_CONFIG = pg_config
PGXS := $(shell $(PG_CONFIG) --pgxs)
include $(PGXS)
else
subdir = contrib/ali_decoding
top_builddir = ../..
include $(top_builddir)/src/Makefile.global
include $(top_srcdir)/contrib/contrib-global.mk
endif

Go to the ali_decoding directory, and run the sudo make and sudo make install commands in sequence to compile the ali_decoding plug-in and obtain the files required to install the ali_decoding plug-in.
Copy the files to the specified locations.

Create the corresponding database and schema in the destination cluster based on the information of the database and schema of the object to be migrated.

Procedure

Go to the Data Migration Tasks page.
1. Log on to the Data Management (DMS) console.
2. In the top navigation bar, click DTS.
3. In the left-side navigation pane, choose DTS (DTS) > Data Migration.
Note
- Operations may vary based on the mode and layout of the DMS console. For more information, see Simple mode and Configure the DMS console based on your business requirements.
- You can also go to the Data Migration Tasks page of the new DTS console.
From the drop-down list next to Data Migration Tasks, select the region in which the data migration instance resides.
Note If you use the new DTS console, you must select the region in which the data migration instance resides in the upper-left corner.

Click Create Task. On the page that appears, configure the source and destination databases.

Warning

After you select the source and destination instances, we recommend that you read the instructions in the Limits section that is displayed in the upper part of the page. This helps you create and run the data migration task.

Category	Parameter	Description
N/A	Task Name	The task name that DTS automatically generates. We recommend that you specify a descriptive name that makes it easy to identify the task. You do not need to specify a unique task name.
Source Database	Select an existing DMS database instance. (Optional. If you have not registered a DMS database instance, ignore this option and configure database settings in the section below.)	The database instance that you want to use. You can choose whether to select an existing instance based on your business requirements. If you select an existing instance, DTS automatically populates the parameters for the database. If you do not select an existing instance, you must manually configure parameters for the database.
	Database Type	The type of the source database. Select PostgreSQL.
	Access Method	The location in which the self-managed PostgreSQL database is deployed. In this example, a Self-managed Database on ECS is selected. Note If you choose other methods to access the source self-managed PostgreSQL database, you must deploy the network environment for the database. For more information, see Preparation overview.
	Instance Region	The region in which the self-managed PostgreSQL database resides.
	ECS Instance ID	The ID of the ECS instance to which the self-managed PostgreSQL database belongs.
	Port Number	The service port number of the self-managed PostgreSQL database. Default value 5432.
	Database Name	The name of the self-managed PostgreSQL database.
	Database Account	The account that is used to log on to the self-managed PostgreSQL database. For information about the permissions that are required for the account, see the Permissions required for database accounts section of this topic.
	Database Password	The password of the database account.
Destination Database	Select an existing DMS database instance. (Optional. If you have not registered a DMS database instance, ignore this option and configure database settings in the section below.)	The database instance that you want to use. You can choose whether to select an existing instance based on your business requirements. If you select an existing instance, DTS automatically populates the parameters for the database. If you do not select an existing instance, you must manually configure parameters for the database.
	Database Type	The type of the destination database. Select PolarDB for PostgreSQL.
	Access Method	The access method of the destination database. Select Alibaba Cloud Instance.
	Instance Region	The region where the destination PolarDB for PostgreSQL cluster resides.
	Instance ID	Select the ID of the destination PolarDB for PostgreSQL cluster.
	Database Name	The name of the database to which the objects are to be migrated in the destination PolarDB for PostgreSQL instance.
	Database Account	The database account of the destination PolarDB for PostgreSQL cluster. For information about the permissions that are required for the account, see the Permissions required for database accounts section of this topic.
	Database Password	The password of the database account.

In the lower part of the page, click Test Connectivity and Proceed.
If the source or destination database is an Alibaba Cloud database instance, such as an ApsaraDB RDS for MySQL or ApsaraDB for MongoDB instance, DTS automatically adds the CIDR blocks of DTS servers to the IP address whitelist of the instance. If the source or destination database is a self-managed database hosted on an Elastic Compute Service (ECS) instance, DTS automatically adds the CIDR blocks of DTS servers to the security group rules of the ECS instance, and you must make sure that the ECS instance can access the database. If the source or destination database is a self-managed database that is deployed in a data center or provided by a third-party cloud service provider, you must manually add the CIDR blocks of DTS servers to the IP address whitelist of the database to allow DTS to access the database. For more information, see the "CIDR blocks of DTS servers" section of the Add the CIDR blocks of DTS servers to the security settings of on-premises databases topic.
Warning If the CIDR blocks of DTS servers are automatically or manually added to the IP address whitelist of the database instance or ECS security group rules, security risks may arise. Therefore, before you use DTS to migrate data, you must understand and acknowledge the potential risks and take preventive measures, including but not limited to the following measures: enhance the security of your account and password, limit the ports that are exposed, authenticate API calls, regularly check the IP address whitelist or ECS security group rules and forbid unauthorized CIDR blocks, and connect the database to DTS by using Express Connect, VPN Gateway, or Smart Access Gateway.

Configure the objects to be migrated and advanced settings.

Parameter	Description
Migration Types	To perform only full data migration, select Schema Migration and Full Data Migration. To ensure service continuity during data migration, select Schema Migration, Full Data Migration, and Incremental Data Migration. Note If you do not select Incremental Data Migration, we recommend that you do not write data to the source database during data migration. This ensures data consistency between the source and destination databases.
Processing Mode of Conflicting Tables	Precheck and Report Errors: checks whether the destination database contains tables that have the same names as tables in the source database. If the source and destination databases do not contain tables that have the same names, the precheck is passed. Otherwise, an error is returned during the precheck and the data migration task cannot be started. Note You can use the object name mapping feature to rename the tables that are migrated to the destination database. You can use this feature if the source and destination databases contain tables that have identical names and the tables in the destination database cannot be deleted or renamed. For more information, see Map object names. Ignore Errors and Proceed: skips the precheck for identical table names in the source and destination databases. Warning If you select Ignore Errors and Proceed, data inconsistency may occur, and your business may be exposed to potential risks. If the source and destination databases have the same schema, DTS does not migrate data records that have the same primary keys as data records in the destination database. If the source and destination databases have different schemas, only specific columns are migrated or the data migration task fails. Proceed with caution.
Source Objects	Select one or more objects from the Source Objects section and click the icon to add the objects to the Selected Objects section. Note You can select columns, tables, or schemas as the objects to be migrated. If you select tables or columns as the objects to be migrated, DTS does not migrate other objects, such as views, triggers, or stored procedures, to the destination database.
Selected Objects	To rename an object that you want to migrate to the destination instance, right-click the object in the Selected Objects section. For more information, see Map the name of a single object. To rename multiple objects at a time, click Batch Edit in the upper-right corner of the Selected Objects section. For more information, see Map multiple object names at a time. Note If you use the object name mapping feature to rename an object, other objects that depend on the object may fail to be migrated. To specify WHERE conditions to filter data, right-click a table in the Selected Objects section. In the dialog box that appears, specify the conditions. For more information, see Use SQL conditions to filter data. To migrate the SQL operations performed on a specific database or table, right-click the object in the Selected Objects section. In the dialog box that appears, select the SQL operations that you want to migrate. For more information about the SQL statements that can be incrementally migrated, see the SQL operations that can be incrementally migrated section of this topic.

Click Next: Advanced Settings to configure advanced settings.

Data Verification Settings
For more information about how to use the data verification feature, see Enable data verification.

Advanced Settings

Parameter	Description
Select the dedicated cluster used to schedule the task	By default, DTS schedules the task to a shared cluster. You do not need to configure this parameter. You can purchase a dedicated cluster of the specified specifications to run data migration tasks. For more information, see What is a DTS dedicated cluster?
Set Alerts	Specifies whether to set alerts for the data migration task. If the task fails or the migration latency exceeds the threshold, the alert contacts will receive notifications. Valid values: No: does not set alerts. Yes: sets alerts. If you select Yes, you must also set the alert threshold and alert contacts. For more information,see Configure monitoring and alerting when you create a DTS task.
Retry Time for Failed Connections	The retry time range for failed connections. If the source or destination database fails to be connected after the data migration task is started, DTS immediately retries a connection within the time range. Valid values: 10 to 1440. Unit: minutes. Default value: 720. We recommend that you set the parameter to a value greater than 30. If DTS reconnects to the source and destination databases within the specified time range, DTS resumes the data migration task. Otherwise, the data migration task fails. Note If you set different retry time ranges for multiple data migration tasks that have the same source or destination database, the shortest retry time range that is set takes precedence. When DTS retries a connection, you are charged for the DTS instance. We recommend that you specify the retry time range based on your business requirements. You can also release the DTS instance at your earliest opportunity after the source and destination instances are released.
The wait time before a retry when other issues occur in the source and destination databases.	The retry time range for other issues. For example, if the DDL or DML operations fail to be performed after the data migration task is started, DTS immediately retries the operations within the time range. Valid values: 1 to 1440. Unit: minutes. Default value: 10. We recommend that you set the parameter to a value greater than 10. If the failed operations are successfully performed within the specified time range, DTS resumes the data migration task. Otherwise, the data migration task fails. Important The value of the The wait time before a retry when other issues occur in the source and destination databases parameter must be smaller than the value of the Retry Time for Failed Connections parameter.
Enable Throttling for Full Data Migration	During full data migration, DTS uses the read and write resources of the source and destination databases. This may increase the loads on the database servers. You can specify whether to enable throttling for the full data migration task. If you select Yes, you can configure the The rate of source database queries per second (QPS)., RPS of Full Data Migration, and BPS of Full Data Migration parameters based on your business requirements to relieve the load on the destination cluster. Note You can configure this parameter only when you select Full Data Migration as a migration type.Migration Types
Enable Throttling for Incremental Data Migration	You can specify whether to enable throttling for the incremental data migration task. If you select Yes, you can configure the RPS of Incremental Data Migration and BPS of Incremental Data Migration parameters based on your business requirements to relieve the load on the destination cluster. Note You can configure this parameter only when you select Incremental Data Migration as a migration type.Migration Types
Environment Tag	Select an environment tag for the instance based on your business requirements.
Configure ETL	Specifies whether to configure the extract, transform, and load (ETL) feature. For more information, see What is ETL?. Valid values: Yes: configures the ETL feature. You can enter data processing statements in the code editor. For more information, see Configure ETL in a data migration or data synchronization task. No: does not configure the ETL feature.

In the lower part of the page, click Next: Save Task Settings and Precheck.
You can move the pointer over Next: Save Task Settings and Precheck and click Preview OpenAPI parameters to view the parameters to be specified when you call the relevant API operation to configure the DTS task.
Note
- Before you can start the data migration task, DTS performs a precheck. You can start the data migration task only after the task passes the precheck.
- If the task fails to pass the precheck, click View Details next to each failed item. After you troubleshoot the issues based on the causes, run a precheck again.
- If an alert is triggered for an item during the precheck:
  If an alert item cannot be ignored, click View Details next to the failed item and troubleshoot the issues. Then, run a precheck again.
  If an alert item can be ignored, click Confirm Alert Details. In the View Details dialog box, click Ignore. In the message that appears, click OK. Then, click Precheck Again to run a precheck again. If you ignore the alert item, data inconsistency may occur, and your business may be exposed to potential risks.
Wait until the Success Rate value becomes 100%. Then, click Next: Purchase Instance.

On the Purchase Instance page, specify the Instance Class parameter for the data migration instance. The following table describes the parameter.

Section	Parameter	Description
New Instance Class	Resource Group	The resource group to which the data migration instance belongs. Default value: default resource group. For more information, see What is Resource Management?.
New Instance Class	Instance Class	DTS provides various instance classes that vary in the migration speed. You can select an instance class based on your business scenario. For more information, see Specifications of data migration instances.

Read and select the check box to agree to Data Transmission Service (Pay-as-you-go) Service Terms.
Click Buy and Start to start the data migration task. You can view the progress of the task in the task list.