Skip to main content

Add the PostgreSQL Connector

Authenticate to PostgreSQL

After you add the connector, you need to set the required properties. Server: Enter the host name or IP of the server that hosts the database. The default server value is localhost. supports authenticating to in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

Password

To connect with user credentials, specify the following properties:
  • Auth Scheme: Select Password.
  • User: Enter the username that you use to authenticate to your account.
  • Password: Enter the password that you use to authenticate to your account.

Azure Active Directory

To connect with Azure Active Directory, specify the following properties:
  • Auth Scheme: Select AzureAD.
  • User: Enter the username that you use to authenticate to your account.
  • Azure Tenant: Enter the Microsoft Online tenant to which you want to connect. If you do not specify a tenant, uses the default tenant.
  • OAuth Client Id: Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
  • OAuth Client Secret: Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

Azure Service Principal

To connect with an Azure service principal and client secret, set the following properties:
  • Auth Scheme: Select AzureServicePrincipal.
  • Azure Tenant: Enter the Microsoft Online tenant to which you want to connect.
  • User: Enter the username that you use to authenticate to your account.
  • OAuth Client Id: Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
  • OAuth Client Secret: Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.
  • (Optional) Scope: Specify the scope of your access to the application.
To obtain the OAuth client Id and client secret for your application:
  1. Log in to the Azure portal.
  2. In the left navigation pane, select All services. Then, search for and select App registrations.
  3. Click New registrations.
  4. Enter an application name and select Any Azure AD Directory - Multi Tenant.
  5. After you create the application, copy the application (client) Id value that is displayed in the Overview section. Use this value as the OAuth client Id.
  6. Navigate to the Certificates & Secrets section and select New Client Secret for the application.
  7. Specify the duration and save the client secret. After you save it, the key value is displayed.
  8. Copy this value because it is displayed only once. You will use this value as the OAuth client secret.
  9. On the Authentication tab, make sure to select Access tokens (used for implicit flows).

Azure Service Principal Certificate

To connect with an Azure service principal and client certificate, set the following properties:
  • Auth Scheme: Select AzureServicePrincipalCert.
  • User: Enter the username that you use to authenticate to your account.
  • Azure Tenant: Enter the Microsoft Online tenant to which you want to connect.
  • OAuth JWT Cert: Enter your Java web tokens (JWT) certificate store.
  • OAuth JWT Cert Type: Enter the type of key store that contains your JWT Certificate. The default type is PEMKEY_BLOB.
  • (Optional) Scope: Specify the scope of your access to the application.
  • (Optional) OAuth JWT Cert Password: Enter the password for your OAuth JWT certificate.
  • (Optional) OAuth JWT Cert Subject: Enter the subject of your OAuth JWT certificate.
To obtain the OAuth certificate for your application:
  1. Log in to the Azure portal.
  2. In the left navigation pane, select All services. Then, search for and select App registrations.
  3. Click New registrations.
  4. Enter an application name and select Any Azure AD Directory - Multi Tenant.
  5. After you create the application, copy the application (client) Id value that is displayed in the Overview section. Use this value as the OAuth client Id.
  6. Navigate to the Certificates & Secrets section and select Upload certificate. Then, select the certificate to upload from your local machine.
  7. Specify the duration and save the client secret. After you save it, the key value is displayed.
  8. Copy this value because it is displayed only once. You will use this value as the OAuth client secret.
  9. On the Authentication tab, make sure to select Access tokens (used for implicit flows).

Azure Password

To connect with Azure user credentials, specify the following properties:
  • Auth Scheme: Select AzurePassword.
  • User: Enter the username that you use to authenticate to your account.
  • Password: Enter the password that you use to connect to your account.
  • Azure Tenant: Enter the Microsoft Online tenant to which you want to connect. If you do not specify a tenant, uses the default tenant.

Azure Managed Service Identity

To connect with Azure Managed Service Identity (MSI), specify the following properties:
  • Auth Scheme: Select AzureMSI.
  • User: Enter the username that you use to authenticate to your account.

AWS IAM Roles

AWS EC2 Roles

GCP Service Account

To connect with a GCP service account, specify the following properties:
  • Auth Scheme: Select GCPServiceAccount.
  • OAuth JWT Cert: Enter your Java web tokens (JWT) certificate store.
  • OAuth JWT Cert Type: Enter the type of key store that contains your JWT Certificate. The default type is PEMKEY_BLOB.
  • OAuth JWT Cert Password (optional) - Enter the password for your OAuth JWT certificate.
  • OAuth JWT Cert Subject (optional) - Enter the user subject for which the application is requesting delegated access.

Complete Your Connection

To complete your connection:
  1. Specify these settings:
    • Database: Enter the name of the database that to which you want to connect when you connect to the server.
    • Port: Enter the port number of the server that hosts the database. The default port value is 5432.
  2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)
  3. Connect to to connect to your account.
  4. Click Create & Test to create your connection.

Configure Logical Replication

can use logical replication that is configured in to update your destination table incrementally. uses logical decoding to surface the contents of the write-ahead logs, which track data changes in the database, into a readable format. Those changes are read by and pushed into the destination.

Enable Logical Replication for

To enable logical replications for :
  1. Ensure that the wal_level=logical parameter is set in your database. You can set this parameter in the postgresql.conf file.
  2. Create a logical replication slot for by submitting the following SELECT statement:
    SELECT pg_create_logical_replication_slot('cdatasync_replication_slot', 'test_decoding');
    
    The slot name cdatasync_replication_slot is an example slot name. You can substitute any name in its place. You need this slot name when you create your job in . It is important that this slot is used by only because changes are consumed when it reads from the slot.
  3. Ensure that the user that connects from has permission to read the replication slot by submitting the following statement.
    ALTER ROLE <em>PostreSQL-User</em> WITH REPLICATION;
    
  4. Create a job in with a source. After you select the Change Data Capture option, enter the replication slot name.

Deletion Behavior

Logical replication enables to track deleted records when the source table contains a primary key. If the source table does not contain a primary key, cannot retrieve deleted records.

Support for Incremental Replication

The source supports incremental replication. Incremental replication reduces the workload tremendously and minimizes bandwidth use and latency of synchronization. Moving data in increments offers great flexibility when you are dealing with slow APIs or daily quotas. You must configure the incremental check column based on the source columns. An incremental check column is either a datetime or integer-based column that uses to identify new or modified records when it replicates data. Therefore, you must configure incremental check on a datetime or integer-based column in your table for incremental replication to occur. For details about how to set up incremental replication, see Incremental Replication.

More Information