PostgreSQL Setup

  • Updated

The PostgreSQL Synapse enables data synchronization between PostgreSQL schema and Syncari entities using the PostgreSQL API. After the Synapse is Authenticated, a user can Activate the PostgreSQL Synapse, which enables Syncari to replicate the schema of PostgreSQL and make it available within the Unified Data Model. Using Sync Studio, a user can map PostgreSQL tables to Syncari entities, and PostgreSQL table columns to Syncari fields.


PostgreSQL Information

You will need the following information from your PostgreSQL administrator:

  • Cluster
  • Database Name
  • Schema Name
  • User
  • Password
  • Certificate (if required to connect to the database)

Recommended process for creating a new Database for use with Syncari

If you plan on connecting the synapse to a newly created database, our recommended process is to do the following:

Create a new dedicated Syncari sync user

CREATE USER 'newuser'@'host' IDENTIFIED BY 'password';

Create a new database

CREATE DATABASE databasename;

Grant permissions to the newly created user on the new database

GRANT ALL PRIVILEGES ON databasename.* TO 'username'@'host';


IP Whitelisting

Syncari uses this IP address when connecting to your PostgreSQL host:

Synapse Setup

Step 1: Start by logging in to your Syncari subscription

  1. Navigate to Synapses
  2. Find PostgreSQL in the Synapse Library
  3. Drag the PostgreSQL Synapse to the canvas



Step 2: Configure your Synapse parameters

  1. Enter the Synapse Name
  2. Enter the Cluster Name
  3. Enter the Database Name
  4. Enter the Schema Name
  5. [OPTIONAL] Select Instantiate with Syncari Entities to automatically create entities in PostgreSQL. Most customers use PostgreSQL as a source Synapse and therefore would NOT set this option. This option enables all the existing entities in Syncari to be created as tables in PostgreSQL. This feature is useful if you want the schema from the Syncari Unified Data Model to be replicated in PostgreSQL. Contact Support if you would like any clarification or a recommendation.
  6. Enter Postgres Timezone ID. Example: America/Los_Angeles. This value should match database timezone configuration. Reference this article for valid values.
  7. Authentication Method will always be set to User Password
  8. [OPTIONAL] Enter the Logical Replication Slot name if you have configured that in your PostgreSQL database.
  9. [OPTIONAL] Select Use Cursor Pagination to use cursor based pagination to fetch records from Postgresql. This requires an ID attribute that is sortable, unique and continuous
  10. Click "Next"



Step 3: Define your authentication parameters and authenticate:

  1. Enter the User Name
  2. Enter the Password
  3. [OPTIONAL] Enter the SSL Certificate details if needed to connect with the database. Paste the contents of the certificate in this field.
  4. [OPTIONAL] Select Verify Certificate & Domain if both the certificate and domain name of the database server need to be verified against the certificate. Otherwise, only the certificate authority is verified. This option is valid only when you enter a certificate.
  5. Click Save and Authenticate
  6. Click Next



Step 4: Activate your Synapse

  1. Click Make Synapse Active
  2. Click Close


Congratulations! You have completed the setup of PostgreSQL.

If you receive any errors message after clicking Authenticate, confirm each of the parameters in the previous steps are configured properly. If the error persists, contact one of our Onboarding and Support team members.


What's Next?

Share this

Was this article helpful?

1 out of 1 found this helpful