This topic describes how to use Data Transmission Service (DTS) to synchronize data from a self-managed PostgreSQL database to ApsaraDB RDS for PostgreSQL.
Prerequisites
-
You have created a source self-managed PostgreSQL database and a destination RDS PostgreSQL instance. For more information about how to create an RDS PostgreSQL instance, see Create an RDS PostgreSQL instance.
Note-
For the supported versions of the source and destination databases, see synchronization solution overview.
-
We recommend using a destination database version that is the same as or later than the source database's version. Synchronizing data to an earlier version may cause compatibility issues.
-
-
The storage space of the destination RDS PostgreSQL instance must be larger than the storage space used by the source self-managed PostgreSQL database.
Notes
Type | Description |
Source database limits |
|
Other limits |
|
Pricing
|
Synchronization type |
Fees |
|
Schema synchronization and full synchronization |
Free. |
|
Incremental synchronization |
Fees apply. 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 an introduction to each synchronization topology, see data synchronization topologies.
Supported objects for synchronization
-
SCHEMA,TABLE.NoteThis includes
PRIMARY KEY,UNIQUE KEY,FOREIGN KEY,DATATYPE(built-in data types), andDEFAULT CONSTRAINT. -
VIEW,PROCEDURE(requires PostgreSQL 11 or later),FUNCTION,RULE,SEQUENCE,EXTENSION,TRIGGER,AGGREGATE,INDEX,OPERATOR,DOMAIN.
Supported SQL operations for synchronization
|
Operation type |
SQL operation |
|
DML |
|
|
DDL |
|
Required permissions for database accounts
|
Database |
Required permissions |
Account creation and authorization |
|
Self-managed PostgreSQL |
superuser permission |
Use the CREATE USER and GRANT statements. |
|
RDS PostgreSQL |
A high-privilege account that must also be the owner (authorized account) of the selected database. |
Preparations
The following steps apply to Linux systems.
Perform the following preparations for self-managed PostgreSQL (all versions).
-
Log on to the server where the self-managed PostgreSQL database is deployed.
-
Run the following command to check the number of replication slots in use.
select count(1) from pg_replication_slots; -
Modify the
postgresql.conffile to setwal_leveltological. Also ensure that the values of themax_wal_sendersandmax_replication_slotsparameters are greater than the sum of the number of replication slots currently in use and the number of DTS instances you plan to create with this self-managed PostgreSQL database as the source.# - 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 modifying the configuration file, restart the self-managed PostgreSQL database for the changes to take effect.
-
Add the DTS IP address to the pg_hba.conf file of the self-managed PostgreSQL database. Add only the DTS IP address range corresponding to the region of the destination database. For more information, see Add DTS server IP addresses to the whitelist.
Note-
After modifying the configuration file, run the command
SELECT pg_reload_conf();or restart the self-managed PostgreSQL database for the changes to take effect. -
For more information about this configuration file, see pg_hba.conf file. If you have already configured the trust address as
0.0.0.0/0(as shown in the following code), skip this step.
# "local" is for Unix domain socket connections only local all all trust # IPv4 local connections: host all all 0.0.0.0/0 md5 # IPv6 local connections: host all all ::1/128 trust # Allow replication connections from localhost, by a user with the # replication privilege. local replication postgres trust host replication postgres 0.0.0.0/0 md5 -
-
Create the corresponding database and schema in the destination RDS PostgreSQL instance based on the database and schema information of the objects to be synchronized (schema names must match). For more information, see Create a database and Schema management.
If your self-managed PostgreSQL version is between 9.4.8 and 10.0, you must also perform the following preparations.
-
Download the PostgreSQL source code and compile and install it.
-
Log on to the server where the self-managed PostgreSQL database is deployed.
-
Download the source code for your self-managed PostgreSQL version from the PostgreSQL official website.
-
Run the commands
sudo ./configure,sudo make, andsudo make installto configure, compile, and install the source code.Important-
When you compile and install PostgreSQL, the operating system version must match the GCC (GNU Compiler Collection) version.
-
If you encounter an error when running
sudo ./configure, adjust the command based on the error message. For example, if the error message isreadline library not found. Use --without-readline to disable readline support., adjust the command tosudo ./configure --without-readline. -
If you choose another method to install PostgreSQL, compile ali_decoding in a test environment with the same operating system and GCC versions.
-
-
-
Download and compile the ali_decoding plug-in provided by DTS.
-
Download ali_decoding.
-
Copy the entire ali_decoding directory to the contrib directory of PostgreSQL (after compilation and installation).
total 1068 -rw-r--r-- 1 1107 1107 384 Sep 27 2016 aclocal.m4 drwxrwxrwx 2 1107 1107 4096 Sep 27 2016 config -rw-r--r-- 1 root root 374806 Sep 7 10:10 config.log -rwxr-xr-x 1 root root 39032 Sep 7 10:10 config.status -rwxr-xr-x 1 1107 1107 471157 Sep 27 2016 configure -rw-r--r-- 1 1107 1107 75195 Sep 27 2016 configure.in drwxrwxrwx 56 1107 1107 4096 Sep 7 10:28 contrib -rw-r--r-- 1 1107 1107 1192 Sep 27 2016 COPYRIGHT drwxrwxrwx 3 1107 1107 4096 Sep 27 2016 doc -rw-r--r-- 1 root root 3638 Sep 7 10:10 GNUmakefile -rw-r--r-- 1 1107 1107 3638 Sep 27 2016 GNUmakefile.in -rw-r--r-- 1 1107 1107 283 Sep 27 2016 HISTORY -rw-r--r-- 1 1107 1107 75065 Sep 27 2016 INSTALL -rw-r--r-- 1 1107 1107 1489 Sep 27 2016 Makefile -rw-r--r-- 1 1107 1107 1209 Sep 27 2016 README drwxrwxrwx 16 1107 1107 4096 Sep 7 10:10 src -
Go to the ali_decoding directory and replace the content of the Makefile with the following:
# 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) # Use the following for source installation 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 commands
sudo makeandsudo make installto compile ali_decoding and obtain the files needed for installation. -
Copy the following files to the specified locations.
/usr/bin/install -c -m 755 ali_decoding.so '/usr/local/pgsql/lib/ali_decoding.so' /usr/bin/install -c -m 644 ./ali_decoding.control '/usr/local/pgsql/share/extension/' /usr/bin/install -c -m 644 ./ali_decoding--0.0.1.sql ./ali_decoding--unpackaged--0.0.1.sql '/usr/local/pgsql/share/extension/' /usr/bin/install -c -m 755 ali_decoding.so '/usr/local/pgsql/lib/'
-
-
Create the corresponding database and schema in the destination RDS PostgreSQL instance based on the database and schema information of the objects to be synchronized (schema names must match). For more information, see Create a database and Schema management.
Procedure
Go to the data synchronization task list page in the destination region. You can do this in one of two ways.
DTS console
Log on to the DTS console.
In the navigation pane on the left, click Data Synchronization.
In the upper-left corner of the page, select the region where the synchronization instance is located.
DMS console
NoteThe actual steps may vary depending on the mode and layout of the DMS console. For more information, see Simple mode console and Customize DMS console layout and style.
Log on to the DMS console.
In the top menu bar, choose .
To the right of Data Synchronization Tasks, select the region of the synchronization instance.
Click Create Task to open the task configuration page.
-
Configure the source and destination databases.
WarningAfter you select the source and destination instances, review the Limits at the top of the page. Otherwise, the task may fail or data inconsistency may occur.
Category
Configuration
Description
None
Task Name
DTS automatically generates a task name. We recommend that you specify a descriptive name for easy identification. The name does not need to be unique.
Source Database
Database Type
Select PostgreSQL.
Access Method
Select Cloud Enterprise Network (CEN).
Instance Region
Select the region where the self-managed PostgreSQL database resides.
CEN Instance ID
Select the CEN instance ID associated with the self-managed PostgreSQL database.
Connected VPC
Select the VPC network connected to the self-managed PostgreSQL database.
Domain Name or IP
Enter the server IP address of the self-managed PostgreSQL database.
Port Number
Enter the port used by the self-managed PostgreSQL database. The default port is 3433.
Database Name
Enter the name of the database in the self-managed PostgreSQL instance that contains the objects to be synchronized.
Database Account
Enter the database account for the self-managed PostgreSQL instance. For required permissions, see Required permissions for database accounts.
Database Password
Enter the password for the specified database account.
Encryption
Select a connection method. In this example, Non-encrypted is selected.
If you need to connect to the database by using SSL encryption, select SSL-encrypted, and then upload the CA Certificate, Client Certificate, and Private Key of Client Certificate as needed. Then, enter the Private Key Password of Client Certificate.
Note-
If you select SSL-encrypted for a self-managed PostgreSQL database, you must upload the CA Certificate.
-
If you need to use a client certificate, you must upload both the Client Certificate and the Private Key of Client Certificate, and then enter the Private Key Password of Client Certificate.
-
For information about the SSL encryption feature for an RDS for PostgreSQL instance, see SSL connection encryption.
Destination Database
Database Type
Select PostgreSQL.
Access Method
Select Alibaba Cloud Instance.
Instance Region
Select the region where the destination RDS PostgreSQL instance resides.
Instance ID
Select the instance ID of the destination RDS PostgreSQL instance.
Database Name
Enter the name of the database in the destination RDS PostgreSQL instance that contains the objects to be synchronized.
Database Account
Enter the database account for the destination RDS PostgreSQL instance. For required permissions, see Required permissions for database accounts.
Database Password
Enter the password for the specified database account.
Encryption
Select a connection method. In this example, Non-encrypted is selected.
If you need to connect to the database by using SSL encryption, select SSL-encrypted, and then upload the CA Certificate, Client Certificate, and Private Key of Client Certificate as needed. Then, enter the Private Key Password of Client Certificate.
Note-
If you select SSL-encrypted for a self-managed PostgreSQL database, you must upload the CA Certificate.
-
If you need to use a client certificate, you must upload both the Client Certificate and the Private Key of Client Certificate, and then enter the Private Key Password of Client Certificate.
-
For information about the SSL encryption feature for an RDS for PostgreSQL instance, see SSL connection encryption.
-
After completing the configuration, click Test Connectivity and Proceed at the bottom of the page.
NoteEnsure that you add the CIDR blocks of the DTS servers (either automatically or manually) to the security settings of both the source and destination databases to allow access. For more information, see Add the IP address whitelist of DTS servers.
If the source or destination is a self-managed database (i.e., the Access Method is not Alibaba Cloud Instance), you must also click Test Connectivity in the CIDR Blocks of DTS Servers dialog box.
-
Configure the task objects.
-
On the Configure Objects page, specify the objects to synchronize.
Configuration
Description
Synchronization Types
DTS always selects Incremental Data Synchronization. By default, you must also select Schema Synchronization and Full Data Synchronization. After the precheck, DTS initializes the destination cluster with the full data of the selected source objects, which serves as the baseline for subsequent incremental synchronization.
NoteIf you select Schema Synchronization, DTS synchronizes the structure of the tables to be synchronized from the source database (including foreign keys) to the destination database.
Processing Mode of Conflicting Tables
Precheck and Report Errors: Checks for tables with the same names in the destination database. If any tables with the same names are found, an error is reported during the precheck and the data synchronization task does not start. Otherwise, the precheck is successful.
NoteIf you cannot delete or rename the table with the same name in the destination database, you can map it to a different name in the destination. For more information, see Object name mapping.
Ignore Errors and Proceed: Skips the check for tables with the same name in the destination database.
WarningSelecting Ignore Errors and Proceed may cause data inconsistency and put your business at risk. For example:
If the table schemas are consistent and a record in the destination database has the same primary key or unique key value as a record in the source database:
During full data synchronization, DTS retains the destination record and skips the source record.
During incremental synchronization, DTS overwrites the destination record with the source record.
If the table schemas are inconsistent, data initialization may fail. This can result in only partial data synchronization or a complete synchronization failure. Use with caution.
Synchronization Topology
This scenario involves one-way synchronization. Select One-way Synchronization.
Capitalization of Object Names in Destination Instance
Configure the case-sensitivity policy for database, table, and column names in the destination instance. By default, the DTS default policy is selected. You can also choose to use the default policy of the source or destination database. For more information, see Case policy for destination object names.
Source Objects
In the Source Objects box, click the objects, and then click
to move them to the Selected Objects box.Note-
You can select objects to synchronize at the schema or table level. If you select tables as the synchronization objects, other objects such as views, triggers, and stored procedures are not synchronized to the target database.
-
If a table to be synchronized contains a field of the SERIAL type and Synchronization Types is selected for Schema Synchronization, we recommend also selecting Sequence or the entire schema.
Selected Objects
To rename a single object in the destination instance, right-click the object in the Selected Objects box. For more information, see Map a single object name.
To rename multiple objects in bulk, click Batch Edit in the upper-right corner of the Selected Objects box. For more information, see Map multiple object names in bulk.
Note-
To select SQL operations to synchronize at the database or table level, right-click the object to be synchronized in Selected Objects and select the required SQL operations in the dialog box that appears.
-
To set a WHERE clause to filter data, right-click the table to be synchronized in Selected Objects and set the filter condition in the dialog box that appears. For more information, see Set filter conditions.
-
If you use the object name mapping feature, it may cause synchronization failures for other objects that depend on this object.
-
Click Next: Advanced Settings.
Configuration
Description
Dedicated Cluster for Task Scheduling
By default, DTS uses a shared cluster for tasks, so you do not need to make a selection. For greater task stability, you can purchase a dedicated cluster to run the DTS synchronization task. For more information, see What is a DTS dedicated cluster?.
Retry Time for Failed Connections
If the connection to the source or destination database fails after the synchronization task starts, DTS reports an error and immediately begins to retry the connection. The default retry duration is 720 minutes. You can customize the retry time to a value from 10 to 1,440 minutes. We recommend a duration of 30 minutes or more. If the connection is restored within this period, the task resumes automatically. Otherwise, the task fails.
NoteIf multiple DTS instances (e.g., Instance A and B) share a source or destination, DTS uses the shortest configured retry duration (e.g., 30 minutes for A, 60 for B, so 30 minutes is used) for all instances.
DTS charges for task runtime during connection retries. Set a custom duration based on your business needs, or release the DTS instance promptly after you release the source/destination instances.
Retry Time for Other Issues
If a non-connection issue (e.g., a DDL or DML execution error) occurs, DTS reports an error and immediately retries the operation. The default retry duration is 10 minutes. You can also customize the retry time to a value from 1 to 1,440 minutes. We recommend a duration of 10 minutes or more. If the related operations succeed within the set retry time, the synchronization task automatically resumes. Otherwise, the task fails.
ImportantThe value of Retry Time for Other Issues must be less than that of Retry Time for Failed Connections.
Enable Throttling for Full Data Synchronization
During full data synchronization, DTS consumes read and write resources from the source and destination databases, which can increase their load. To mitigate pressure on the destination database, you can limit the migration rate by setting Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s).
NoteThis parameter is available only if Synchronization Types is set to Full Data Synchronization.
You can also adjust the rate of full data synchronization when the synchronization instance is running.
Enable Throttling for Incremental Data Synchronization
You can also limit the incremental synchronization rate to reduce pressure on the destination database by setting RPS of Incremental Data Synchronization and Data synchronization speed for incremental synchronization (MB/s).
Environment Tag
Based on your needs, select an environment tag to identify the instance.
Configure ETL
Choose whether to enable the extract, transform, and load (ETL) feature. For more information, see What is ETL? Valid values:
-
Yes: Enables the ETL feature. Enter data processing statements in the code editor. For more information, see Configure ETL in a data migration or data synchronization task.
-
No: Disables the ETL feature.
Monitoring and Alerting
Choose whether to set up alerts. If the synchronization fails or the latency exceeds the specified threshold, DTS sends a notification to the alert contacts.
No: No alerts are configured.
Yes: Configures alerts. You must also set the alert threshold and alert contact. For more information, see Configure monitoring and alerting during task configuration.
Click Data Verification to configure a data verification task.
To use the data verification feature, see Configure data verification.
-
Save the task and perform a precheck.
To view the parameters for configuring this instance via an API operation, hover over the Next: Save Task Settings and Precheck button and click Preview OpenAPI parameters in the tooltip.
If you have finished viewing the API parameters, click Next: Save Task Settings and Precheck at the bottom of the page.
NoteBefore a synchronization task starts, DTS performs a precheck. You can start the task only if the precheck passes.
If the precheck fails, click View Details next to the failed item, fix the issue as prompted, and then rerun the precheck.
If the precheck generates warnings:
For non-ignorable warning, click View Details next to the item, fix the issue as prompted, and run the precheck again.
For ignorable warnings, you can bypass them by clicking Confirm Alert Details, then Ignore, and then OK. Finally, click Precheck Again to skip the warning and run the precheck again. Ignoring precheck warnings may lead to data inconsistencies and other business risks. Proceed with caution.
-
Purchase the instance.
When the Success Rate reaches 100%, click Next: Purchase Instance.
On the Purchase page, select the billing method and link specifications for the data synchronization instance. For more information, see the following table.
Category
Parameter
Description
New Instance Class
Billing Method
Subscription: You pay upfront for a specific duration. This is cost-effective for long-term, continuous tasks.
Pay-as-you-go: You are billed hourly for actual usage. This is ideal for short-term or test tasks, as you can release the instance at any time to save costs.
Resource Group Settings
The resource group to which the instance belongs. The default is default resource group. For more information, see What is Resource Management?.
Instance Class
DTS offers synchronization specifications at different performance levels that affect the synchronization rate. Select a specification based on your business requirements. For more information, see Data synchronization link specifications.
Subscription Duration
In subscription mode, select the duration and quantity of the instance. Monthly options range from 1 to 9 months. Yearly options include 1, 2, 3, or 5 years.
NoteThis option appears only when the billing method is Subscription.
Read and select the checkbox for Data Transmission Service (Pay-as-you-go) Service Terms.
Click Buy and Start, and then click OK in the OK dialog box.
You can monitor the task progress on the data synchronization page.
