This topic describes how to synchronize data from a self-managed PostgreSQL database to an ApsaraDB RDS for PostgreSQL instance by using Data Transmission Service (DTS).
Prerequisites
The source self-managed PostgreSQL database and the destination ApsaraDB RDS for PostgreSQL instance are created. For more information about how to create an ApsaraDB RDS for PostgreSQL instance, see Create an instance.
NoteThe version of the destination database is the same as or later than the version of the source database. This ensures database compatibility.
If the version of the destination database is earlier than that of the source database, database compatibility issues may occur.
The available storage space of the destination ApsaraDB RDS for PostgreSQL instance is larger than the total size of the data in the self-managed PostgreSQL database.
Usage notes
Limit type | Description |
Limits on the source database |
|
Other limits |
|
Billing
Synchronization type | Task configuration fee |
Schema synchronization and full data synchronization | Free of charge. |
Incremental data synchronization | Charged. For more information, see Billing overview. |
Supported synchronization topologies
One-way one-to-one synchronization
One-way one-to-many synchronization
One-way cascade synchronization
One-way many-to-one synchronization
For more information about the synchronization topologies supported by DTS, see Synchronization topologies.
SQL operations that can be synchronized
Operation type | SQL statement |
DML | INSERT, UPDATE, and DELETE |
DDL |
|
Permissions required for database accounts
Database type | Required permissions | References |
Self-managed PostgreSQL database | superuser | CREATE USER and GRANT |
ApsaraDB RDS for PostgreSQL instance | Permissions of the schema owner | ApsaraDB RDS for PostgreSQL instance: Create an account |
Preparations
In this example, a self-managed PostgreSQL database that runs on a server of the Linux operating system is used.
Perform the following operations before you configure a data synchronization task:
Log on to the server on which the self-managed PostgreSQL database resides.
Run the following command to query the number of used replication slots in the self-managed PostgreSQL database:
select count(1) from pg_replication_slots;
Modify the
postgresql.conf
configuration file. Set thewal_level
parameter tological
, and make sure that the values of themax_wal_senders
andmax_replication_slots
parameters are greater than the sum of the number of used replication slots in the self-managed PostgreSQL database and the number of DTS instances whose source database is the self-managed PostgreSQL database.# - Settings - wal_level = logical # minimal, replica, or logical # (change requires restart) ...... # - Sending Server(s) - # Set these on the master and on any standby that will send replication data. max_wal_senders = 10 # max number of walsender processes # (change requires restart) #wal_keep_segments = 0 # in logfile segments, 16MB each; 0 disables #wal_sender_timeout = 60s # in milliseconds; 0 disables max_replication_slots = 10 # max number of replication slots # (change requires restart)
NoteAfter you modify the configuration file, restart the self-managed PostgreSQL database to make the parameter settings 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.
NoteAfter you modify the configuration file, execute the
SELECTpg_reload_conf();
statement or restart the self-managed PostgreSQL database for the parameter to take effect.For more information about the pg_hba.conf configuration file, 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 a database and schema in the destination ApsaraDB RDS for PostgreSQL instance based on the database and schema information of the objects to be synchronized. The schema names in the source and destination databases must be the same. For more information, see Create a database and Manage accounts by using schemas.
If the version of the self-managed PostgreSQL database is in the range of 9.4.8 to 10.0, you must perform the following operations before you configure a data synchronization task:
Download the PostgreSQL source code from the official website, compile the source code, and install PostgreSQL.
Log on to the server on which the self-managed PostgreSQL database resides.
Download the source code from the PostgreSQL official website based on the version of the self-managed PostgreSQL database.
Run the
sudo ./configure
,sudo make
, andsudo make install
commands in sequence to configure and compile the source code, and install PostgreSQL.ImportantWhen you compile and install PostgreSQL, the OS version of PostgreSQL must be consistent with the version of the GNU compiler collection (GCC).
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 isreadline library not found. Use --without-readline to disable readline support.
, you can modify the command tosudo ./configure --without-readline
.If you use another method 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 that is 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
andsudo make install
commands in sequence to compile the ali_decoding plug-in and obtain the files that are required to install the ali_decoding plug-in.Copy the files to the specified directories.
Create a database and schema in the destination ApsaraDB RDS for PostgreSQL instance based on the database and schema information of the objects to be synchronized. The schema names in the source and destination databases must be the same. For more information, see Create a database and Manage accounts by using schemas.
Procedure
Go to the Data Synchronization Tasks page.
Log on to the Data Management (DMS) console.
In the top navigation bar, click DTS.
In the left-side navigation pane, choose .
NoteOperations may vary based on the mode and layout of the DMS console. For more information, see Simple mode and Customize the layout and style of the DMS console.
You can also go to the Data Synchronization Tasks page of the new DTS console.
On the right side of Data Synchronization Tasks, select the region in which the data synchronization instance resides.
NoteIf you use the new DTS console, you must select the region in which the data synchronization instance resides in the top navigation bar.
Click Create Task. On the Create Task page, configure the source and destination databases. The following table describes the parameters.
WarningAfter you configure the source and destination databases, we recommend that you read the Limits that are displayed on the page. Otherwise, the task may fail or data inconsistency may occur.
Section
Parameter
Description
N/A
Task Name
The name of the DTS task. DTS automatically generates a task name. 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
Database Type
The type of the source database. Select PostgreSQL.
Access Method
The access method of the source database. Select Cloud Enterprise Network (CEN).
Instance Region
The region in which the self-managed PostgreSQL database resides.
CEN Instance ID
Select the ID of the CEN instance that hosts the self-managed PostgreSQL database.
Connected VPC
The virtual private cloud (VPC) that is connected to the self-managed PostgreSQL database.
Domain Name or IP
The IP address of the server on which the self-managed PostgreSQL database resides.
Port Number
The service port number of the self-managed PostgreSQL database. Default value: 3433.
Database Name
The name of the self-managed PostgreSQL database.
Database Account
The database account of the self-managed PostgreSQL database. For more information about the permissions required for the database account, see the Permissions required for database accounts section of this topic.
Database Password
The password that is used to access the database instance.
Encryption
Specifies whether to encrypt the connection to the source database. You can configure this parameter based on your business requirements. In this example, Non-encrypted is selected.
If you want to establish an SSL-encrypted connection to the source database, perform the following steps: Select SSL-encrypted, upload CA Certificate, Client Certificate, and Private Key of Client Certificate as needed, and then specify Private Key Password of Client Certificate.
NoteIf you set Encryption to SSL-encrypted for a self-managed PostgreSQL database, you must upload CA Certificate.
If you want to use the client certificate, you must upload Client Certificate and Private Key of Client Certificate and specify Private Key Password of Client Certificate.
For information about how to configure SSL encryption for an ApsaraDB RDS for PostgreSQL instance, see SSL encryption.
Destination Database
Database Type
The type of the destination database. Select PostgreSQL.
Access Method
The access method of the destination database. Select Alibaba Cloud Instance.
Instance Region
The region in which the destination ApsaraDB RDS for PostgreSQL instance resides.
Instance ID
The ID of the destination ApsaraDB RDS for PostgreSQL instance.
Database Name
The name of the database to which objects are synchronized in the destination ApsaraDB RDS for PostgreSQL instance.
Database Account
The database account of the destination ApsaraDB RDS for PostgreSQL instance. For more information about the permissions required for the database account, see the Permissions required for database accounts section of this topic.
Database Password
The password that is used to access the database instance.
Encryption
Specifies whether to encrypt the connection to the source database. You can configure this parameter based on your business requirements. In this example, Non-encrypted is selected.
If you want to establish an SSL-encrypted connection to the source database, perform the following steps: Select SSL-encrypted, upload CA Certificate, Client Certificate, and Private Key of Client Certificate as needed, and then specify Private Key Password of Client Certificate.
NoteIf you set Encryption to SSL-encrypted for a self-managed PostgreSQL database, you must upload CA Certificate.
If you want to use the client certificate, you must upload Client Certificate and Private Key of Client Certificate and specify Private Key Password of Client Certificate.
For information about how to configure SSL encryption for an ApsaraDB RDS for PostgreSQL instance, see SSL encryption.
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 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 database is deployed on multiple ECS instances, you must manually add the CIDR blocks of DTS servers to the security group rules of each ECS instance. 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 whitelist of the database to allow DTS to access the database. For more information, see Add the CIDR blocks of DTS servers.
WarningIf the CIDR blocks of DTS servers are automatically or manually added to the whitelist of the database or instance, or to the ECS security group rules, security risks may arise. Therefore, before you use DTS to synchronize data, you must understand and acknowledge the potential risks and take preventive measures, including but not limited to the following measures: enhancing the security of your username and password, limiting the ports that are exposed, authenticating API calls, regularly checking the whitelist or ECS security group rules and forbidding unauthorized CIDR blocks, or connecting the database to DTS by using Express Connect, VPN Gateway, or Smart Access Gateway.
Configure the objects to be synchronized and advanced settings. The following table describes the parameters.
Parameter
Description
Synchronization Types
The synchronization types. By default, Incremental Data Synchronization is selected. You must also select Schema Synchronization and Full Data Synchronization. After the precheck is complete, DTS synchronizes the historical data of the selected objects from the source database to the destination cluster. The historical data is the basis for subsequent incremental synchronization.
NoteIf you select Schema Synchronization, DTS synchronizes the schemas of the tables to be synchronized from the source database to the destination database. The schemas include foreign keys.
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 identical table names, the precheck is passed. Otherwise, an error is returned during the precheck, and the data synchronization task cannot be started.
NoteIf the source and destination databases contain tables with identical names and the tables in the destination database cannot be deleted or renamed, you can use the object name mapping feature to rename the tables that are synchronized to the destination database. For more information, see Map object names.
Ignore Errors and Proceed: skips the precheck for identical table names in the source and destination databases.
WarningIf 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 and a data record in the destination database has the same primary key value or unique key value as a data record in the source database:
During full data migration, DTS does not migrate the data record to the destination database. The existing data record in the destination database is retained.
During incremental data synchronization, DTS synchronizes the data record to the destination database. The existing data record in the destination database is overwritten.
If the source and destination databases have different schemas, data may fail to be initialized. In this case, only some columns are synchronized, or the data synchronization task fails. Proceed with caution.
Synchronization Topology
In this example, select One-way Synchronization.
Capitalization of Object Names in Destination Instance
The capitalization of database names, table names, and column names in the destination instance. By default, DTS default policy is selected. You can select other options to ensure that the capitalization of object names is consistent with that in the source or destination database. For more information, see Specify the capitalization of object names in the destination instance.
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.
NoteYou can select columns, tables, or schemas as the objects to be synchronized.
Selected Objects
To rename an object that you want to synchronize to the destination instance, right-click the object in the Selected Objects section. For more information, see the Map the name of a single object section of the Map object names topic.
To rename multiple objects at a time, click Batch Edit in the upper-right corner of the Selected Objects section. For more information, see the Map multiple object names at a time section of the Map object names topic.
NoteTo select SQL operations performed on a specific database or table, right-click an object in the Selected Objects section. In the dialog box that appears, select the SQL operations that you want to synchronize. For more information, see the SQL operations that can be synchronized section of this topic.
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 Specify filter conditions.
If you use the object name mapping feature to rename an object, other objects that are dependent on the object may fail to be synchronized.
Click Next: Advanced Settings to configure advanced settings. The following table describes the parameters.
Parameter
Description
Dedicated Cluster for Task Scheduling
By default, DTS schedules tasks to shared clusters. You do not need to configure this parameter. If you want to improve the stability of data migration tasks, purchase a dedicated cluster. For more information, see What is a DTS dedicated cluster.
Set Alerts
Specifies whether to configure alerting for the data synchronization task. If the task fails or the synchronization latency exceeds the specified threshold, alert contacts will receive notifications. Valid values:
No: does not enable alerting.
Yes: configures alerting. In this case, you must also configure 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 synchronization 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 this 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 synchronization task. Otherwise, the data synchronization task fails.
NoteIf you specify different retry time ranges for multiple data synchronization tasks that have the same source or destination database, the shortest retry time range 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.
Retry Time for Other Issues
The retry time range for other issues. For example, if the DDL or DML operations fail to be performed after the data synchronization 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 this parameter to a value greater than 10. If the failed operations are successfully performed within the specified time range, DTS resumes the data synchronization task. Otherwise, the data synchronization task fails.
ImportantThe value of the Retry Time for Other Issues parameter must be smaller than the value of the Retry Time for Failed Connections parameter.
Enable Throttling for Full Data Migration
During full data synchronization, DTS uses the read and write resources of the source and destination databases. This may increase the load on the database servers. You can configure the Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s) parameters for full data synchronization tasks to reduce the load on the destination database server.
NoteThis parameter is displayed only if Full Data Synchronization is selected for the Synchronization Types parameter.
Enable Throttling for Incremental Data Synchronization
Specifies whether to enable throttling for incremental data synchronization. You can enable throttling for incremental data synchronization based on your business requirements. To configure throttling, you must configure the RPS of Incremental Data Synchronization and Data synchronization speed for incremental synchronization (MB/s) parameters. This reduces the load on the destination database server.
Environment Tag
The environment tag that is used to identify the DTS instance. You can select an environment tag based on your business requirements.
Configure ETL
Specifies whether to enable 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.
Save the task settings and run a precheck.
To view the parameters to be specified when you call the relevant API operation to configure the DTS task, move the pointer over Next: Save Task Settings and Precheck and click Preview OpenAPI parameters.
If you do not need to view or have viewed the parameters, click Next: Save Task Settings and Precheck in the lower part of the page.
NoteBefore you can start the data synchronization task, DTS performs a precheck. You can start the data synchronization task only after the task passes the precheck.
If the data synchronization task fails the precheck, click View Details next to each failed item. After you analyze the causes based on the check results, troubleshoot the issues. Then, rerun the precheck.
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 issue. 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 becomes 100%. Then, click Next: Purchase Instance.
On the buy page, configure the Billing Method and Instance Class parameters for the data synchronization instance. The following table describes the parameters.
Section
Parameter
Description
New Instance Class
Billing Method
Subscription: You pay for a subscription when you create a data synchronization instance. The subscription billing method is more cost-effective than the pay-as-you-go billing method for long-term use.
Pay-as-you-go: A pay-as-you-go instance is billed on an hourly basis. The pay-as-you-go billing method is suitable for short-term use. If you no longer require a pay-as-you-go data synchronization instance, you can release the instance to reduce costs.
Resource Group Settings
The resource group to which the data synchronization instance belongs. Default value: default resource group. For more information, see What is Resource Management?
Instance Class
DTS provides instance classes that vary in synchronization speed. You can select an instance class based on your business requirements. For more information, see Instance classes of data synchronization instances.
Subscription Duration
If you select the subscription billing method, specify the subscription duration and the number of data synchronization instances that you want to create. The subscription duration can be one to nine months, one year, two years, three years, or five years.
NoteThis parameter is available only if you select the Subscription billing method.
Read and select the Data Transmission Service (Pay-as-you-go) Service Terms.
Click Buy and Start. In the dialog box that appears, click OK.
You can view the progress of the task in the task list.