PostgreSQL Setup Guide
  • 28 Jul 2022
  • 2 Minutes to read
  • Dark
  • PDF

PostgreSQL Setup Guide

  • Dark
  • PDF

Article summary

This document describes the basic setup for the PostgreSQL data source.

Before you start
  • Note the name, the host, and the port of the Postgres database.
  • Note the username and password for the user connecting to the Postgres database.

Note: A known issue exists when queries are run against the replication server and the primary server updates before the query has completed. This issue can be solved by setting some parameters in the postgresql.conf file on the replica instance. For example, set max_standby_archive_delay and max_standby_streaming_delay to a reasonable value. You can also set hot_standby_feedback to on, however this can bloat the primary. For more information, see your administrator or Hot Standby.

To configure this data source:

  1. If necessary, whitelist Panoply.
    • Postgres databases with production data are typically not publicly available. To allow Panoply to access your data, see Whitelisting.
  2. Click Data Sources in the navigation menu.
  3. Click the Add Data Source button.
  4. Search for Postgres and select it.
  5. Enter the credentials to connect to Postgres. If you're not sure what your connection details are, contact your administrator or open the postgresql.conf file, which is normally kept in the data directory. For more on this file and the relevant connection settings, see Connections and Authentication in the Postgres documentation.
    • Host Address - The URL of the Postgres database or the IP address of the host server.
      • URL example:
      • IP example:
    • Port - The port number of the Postgres server. This is 5432 for most connections.
    • To connect using SSL instead:
      • Enter your Client Certificate
      • Enter your Client Key
      • Enter your SSL Certificate
  6. Enter your Postgres username and password. This user must have permission to access the data. If the permissions are not in place, some of the data will not be available.
    • In Postgres, you can create a Panoply-specific user with read-level permissions to binary logs. Then enter the username and password for this Panoply-specific user. This user must be reserved for Panoply use and must be a unique to your connector. All information entered into Panoply is encrypted to ensure the security of your data. See Data Protection for more information on how Panoply actively provides data security.
  7. Enter the PostgreSQL database to connect to. This loads a list of tables and views.
  8. Select the PostgreSQL tables and views from which to collect data.
  9. Click Save Changes and then click Collect.
    • The data source appears grayed out while the collection runs.
    • You may add additional data sources while this collection runs.
    • You can monitor this collection from the Jobs page or the Data Sources page.
    • After a successful collection, navigate to the Tables page to review the data results.

This is all that is necessary to start collecting your data from PostgreSQL, however there are a number of Advanced Settings you can use to customize your PostgreSQL data source. We do not recommend changing Advanced Settings unless you are an experienced Panoply user.

Was this article helpful?