Skip to content
Integrations
Database Integrations
PostgreSQL

PostgreSQL

This Integration requires Fides Cloud or Fides Enterprise. For more information, talk to our solutions team. (opens in a new tab)

PostgreSQL (opens in a new tab) is a powerful open-source object-relational database management system (ORDBMS) known for its robustness, extensibility, and adherence to SQL standards.

Prerequisites

In order to integrate with PostgreSQL, you'll need to collect the following information from the database adminstrator:

  • Host: The hostname or IP address of the server where the database is running.
  • Port: The network port number on which the server is listening for incoming connections (default: 5432).
  • Username: The user account used to authenticate and access the database.
  • Password: The password used to authenticate and access the database.

You may optionally configure the following information:

  • Database: The name of the specific database within the database server that you want to connect to.
  • Schema: The default schema to be used for the database connection (defaults to public).

Integrating with PostgreSQL

To integrate an existing system with PostgreSQL:

  1. Navigate to Data map → View Systems and choose the system that you want to connect to
  2. Click on the Integrations tab.
  3. Pick the vendor or system type that you want to integrate with from the Connection type drop-down menu.
  4. Complete the required fields for the integration and click Save.

You may confirm your connection is working using the Test connection button, if desired.

To learn more, please see our guide for Managing Integrations.

Configuring a dataset

A dataset is required to configure an integration to this database. A dataset is a configuration file that tell Fides how to query and update data in the database. To learn more about how to create and manage datasets, please see our Managing datasets guide.

An example PostgreSQL dataset can be viewed in Github (opens in a new tab).

Dataset Namespace

PostgreSQL datasets support namespaces. This means that the dataset can contain the database name and schema that will be used when accessing or masking data from a given PostgreSQL table. If namespace information is not included, the dataset will use the default database and the public schema from the associated integration.

dataset:
  - fides_key: postgres_example_test_dataset
    name: Postgres Example Test Dataset
    description: Example of a Postgres dataset containing a variety of related tables like customers, products, addresses, etc.
    fides_meta:
      namespace:
        database_name: my_database
        schema: public
    ...
MySQLSnowflake