PostgreSQL

Adding and configuring a PostgreSQL connection within Qualytics empowers the platform to build a symbolic link with your schema to perform operations like data discovery, visualization, reporting, syncing, profiling, scanning, anomaly surveillance, and more.

This documentation provides a step-by-step guide on how to add PostgreSQL as both a source and enrichment datastore in Qualytics. It covers the entire process, from initial connection setup to testing and finalizing the configuration.

By following these instructions, enterprises can ensure their PostgreSQL environment is properly connected with Qualytics, unlocking the platform's potential to help you proactively manage your full data quality lifecycle.

Let’s get started 🚀

PostgreSQL Setup Guide

Qualytics connects to PostgreSQL through the PostgreSQL JDBC driver. It uses standard JDBC metadata APIs and queries pg_catalog system tables to discover schemas, tables, columns, primary keys, and incremental fields.

Minimum PostgreSQL Permissions (Source Datastore)

Permission	Purpose
`CONNECT ON DATABASE`	Allow the role to connect to the target database
`USAGE ON SCHEMA`	Access objects within the schema
`SELECT ON ALL TABLES IN SCHEMA`	Read data from all existing tables for profiling and scanning
`SELECT ON ALL SEQUENCES IN SCHEMA`	Read sequence metadata for incremental field detection

Additional Permissions for Enrichment Datastore

When using PostgreSQL as an enrichment datastore, the following additional permissions are required for Qualytics to write metadata tables (e.g., _qualytics_*):

Permission	Purpose
`CREATE ON SCHEMA`	Create enrichment tables (`_qualytics_*`)
`INSERT ON ALL TABLES IN SCHEMA`	Write anomaly records, scan results, and check metrics
`UPDATE ON ALL TABLES IN SCHEMA`	Update enrichment records during rescans
`DELETE ON ALL TABLES IN SCHEMA`	Remove stale enrichment records
`ALTER TABLE`	Modify enrichment table schemas during version migrations
`DROP` (on enrichment tables)	Remove enrichment tables if the datastore is unlinked or during cleanup

Example: Source Datastore Role (Read-Only)

Replace <database_name>, <schema_name>, and <password> with your actual values.

-- Create a dedicated read-only role
CREATE ROLE qualytics_read_role LOGIN PASSWORD ‘<password>’;

-- Grant connection and schema access
GRANT CONNECT ON DATABASE <database_name> TO qualytics_read_role;
GRANT USAGE ON SCHEMA <schema_name> TO qualytics_read_role;

-- Grant read access to all existing and future tables
GRANT SELECT ON ALL TABLES IN SCHEMA <schema_name> TO qualytics_read_role;
GRANT SELECT ON ALL SEQUENCES IN SCHEMA <schema_name> TO qualytics_read_role;
ALTER DEFAULT PRIVILEGES IN SCHEMA <schema_name> GRANT SELECT ON TABLES TO qualytics_read_role;

Example: Enrichment Datastore Role (Read-Write)

-- Create a dedicated read-write role
CREATE ROLE qualytics_readwrite_role LOGIN PASSWORD ‘<password>’;

-- Grant connection, schema access, and table creation
GRANT CONNECT ON DATABASE <database_name> TO qualytics_readwrite_role;
GRANT USAGE, CREATE ON SCHEMA <schema_name> TO qualytics_readwrite_role;

-- Grant full data manipulation on all existing and future tables
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA <schema_name> TO qualytics_readwrite_role;
ALTER DEFAULT PRIVILEGES IN SCHEMA <schema_name> GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO qualytics_readwrite_role;

Note

Qualytics automatically filters out system schemas (pg_catalog, pg_toast, pg_internal, information_schema) during catalog discovery. You do not need to restrict access to these schemas manually.

Info

For optimal incremental profiling performance, it is recommended to enable track_commit_timestamp = on in your PostgreSQL configuration (postgresql.conf). This allows Qualytics to detect recently modified rows using transaction commit timestamps (pg_xact_commit_timestamp), reducing the amount of data scanned during profiling operations.

Troubleshooting Common Errors

Error	Likely Cause	Fix
`FATAL: password authentication failed`	Incorrect username or password	Verify the credentials and ensure the role exists with `\du` in psql
`FATAL: no pg_hba.conf entry for host`	The PostgreSQL server does not allow connections from the Qualytics host IP	Add the Qualytics IP to `pg_hba.conf` and reload the configuration
`permission denied for schema`	The role lacks `USAGE` on the target schema	Run `GRANT USAGE ON SCHEMA <schema_name> TO <role>`
`permission denied for table`	The role lacks `SELECT` on one or more tables	Run `GRANT SELECT ON ALL TABLES IN SCHEMA <schema_name> TO <role>`
`permission denied to create table`	The enrichment role lacks `CREATE` on the schema	Run `GRANT CREATE ON SCHEMA <schema_name> TO <role>`

Detailed Troubleshooting Notes

Authentication Errors

The error FATAL: password authentication failed indicates that the credentials provided are incorrect or the role does not exist.

Common causes:

Incorrect password — the password does not match the one set for the role.
Role does not exist — the role name was misspelled or was never created.
Authentication method mismatch — the pg_hba.conf file requires a different authentication method (e.g., md5 vs scram-sha-256).

Note

PostgreSQL logs detailed authentication errors in the server log. Check pg_log or log_directory for the exact reason.

Permission Errors

The error permission denied for schema or permission denied for table means the role authenticated successfully but lacks the necessary grants.

Common causes:

Missing USAGE on schema — the role cannot access the schema even if table-level grants exist.
Missing SELECT on tables — the role has schema access but cannot read specific tables.
Default privileges not set — new tables created after the initial grant are not automatically accessible. Use ALTER DEFAULT PRIVILEGES to fix this.

Connection Errors

The error FATAL: no pg_hba.conf entry for host means the PostgreSQL server does not recognize the Qualytics host IP.

Common causes:

IP not whitelisted — the Qualytics server IP is not listed in pg_hba.conf.
Wrong database name — the pg_hba.conf entry restricts access to specific databases.
SSL required — the server requires SSL connections but the client is connecting without SSL.

Tip

Start by confirming credentials are valid (authentication errors), then verify schema/table permissions (permission errors), and finally check network connectivity (connection errors).

Add a Source Datastore

A source datastore is a storage location used to connect to and access data from external sources. PostgreSQL is an example of a source datastore, specifically a type of JDBC datastore that supports connectivity through the JDBC API. Configuring the JDBC datastore enables the Qualytics platform to access and perform operations on the data, thereby generating valuable insights.

Step 1: Log in to your Qualytics account and click on the Add Source Datastore button located at the top-right corner of the interface.

add-datastore

Step 2: A modal window- Add Datastore will appear, providing you with the options to connect a datastore.

select-a-connector

REF.	FIELDS	ACTIONS
1.	Name (Required)	Specify the name of the datastore. (e.g., The specified name will appear on the datastore cards.)
2.	Toggle Button	Toggle ON to create a new source datastore from scratch, or toggle OFF to reuse credentials from an existing connection.
3.	Connector (Required)	Select PostgreSQL from the dropdown list.

Option I: Create a Source Datastore with a new Connection

If the toggle for Add new existing connection is turned on, then this will prompt you to add and configure the source datastore from scratch without using existing connection details.

Step 1: Select the PostgreSQL connector from the dropdown list and add connection details such as Secrets Management, host, port, username, database, and schema.

add-datastore-credentials

Secrets Management: This is an optional connection property that allows you to securely store and manage credentials by integrating with HashiCorp Vault and other secret management systems. Toggle it ON to enable Vault integration for managing secrets.

Note

After configuring HashiCorp Vault integration, you can use ${key} in any Connection property to reference a key from the configured Vault secret. Each time the Connection is initiated, the corresponding secret value will be retrieved dynamically.

REF	FIELDS	ACTIONS
1.	Login URL	Enter the URL used to authenticate with HashiCorp Vault.
2.	Credentials Payload	Input a valid JSON containing credentials for Vault authentication.
3.	Token JSONPath	Specify the JSONPath to retrieve the client authentication token from the response (e.g., $.auth.client_token).
4.	Secret URL	Enter the URL where the secret is stored in Vault.
5.	Token Header Name	Set the header name used for the authentication token (e.g., X-Vault-Token).
6.	Data JSONPath	Specify the JSONPath to retrieve the secret data (e.g., $.data).

hashcorp-explain

Step 2: The configuration form will expand, requesting credential details before establishing the connection.

add-datastore-credentials-explain

REF.	FIELDS	ACTIONS
1.	Host (Required)	Get Hostname from your PostgreSQL account and add it to this field.
2.	Port (Required)	Specify the Port number.
3.	User (Required)	Enter the User to connect.
4.	Password (Required)	Enter the password to connect to the database.
5.	Database (Required)	Specify the database name.
6.	Schema (Required)	Define the schema within the database that should be used.
7.	Teams (Required)	Select one or more teams from the dropdown to associate with this source datastore.
8.	Initiate Sync (Optional)	Tick the checkbox to automatically perform sync operation on the configured source datastore.

Step 3: After adding the source datastore details, click on the Test Connection button to check and verify its connection.

test-datastore-connection

If the credentials and provided details are verified, a success message will be displayed indicating that the connection has been verified.

Option II: Use an Existing Connection

If the toggle for Add new connection is turned off, then this will prompt you to configure the source datastore using the existing connection details.

Step 1: Select a connection to reuse existing credentials.

use-existing-datastore

Note

If you are using existing credentials, you can only edit the details such as Database, Schema, Teams, and Initiate Sync.

Step 2: Click on the Test Connection button to verify the existing connection details. If connection details are verified, a success message will be displayed.

test-connection-for-existing-datastore

Note

Clicking on the Finish button will create the source datastore and bypass the enrichment datastore configuration step.

Info

It is recommended to click on the Next button, which will take you to the enrichment datastore configuration page.

Add Enrichment Datastore

Once you have successfully tested and verified your source datastore connection, you have the option to add the enrichment datastore (recommended). The enrichment datastore is used to store the analyzed results, including any anomalies and additional metadata in tables. This setup provides full visibility into your data quality, helping you manage and improve it effectively.

Step 1: Whether you have added a source datastore by creating a new datastore connection or using an existing connection, click on the Next button to start adding the Enrichment Datastore.

Step 2: A modal window Link Enrichment Datastore will appear, providing you with the options to configure an enrichment datastore.

select-enrichment-connector

REF.	FIELDS	ACTIONS
1	Prefix (Required)	Add a prefix name to uniquely identify tables/files when Qualytics writes metadata from the source datastore to your enrichment datastore.
2	Caret Down Button	Click the caret down to select either Use Enrichment Datastore or Add Enrichment Datastore.
3	Enrichment Datastore	Select an enrichment datastore from the dropdown list.

Option I: Create an Enrichment Datastore with a new Connection

If the toggle Add new connection is turned on, then this will prompt you to add and configure the enrichment datastore from scratch without using an existing enrichment datastore and its connection details.

Step 1: Click on the caret button and select Add Enrichment Datastore.

caret-button

A modal window Link Enrichment Datastore will appear. Enter the following details to create an enrichment datastore with a new connection.

modal-window

REF.	FIELDS	ACTIONS
1.	Prefix	Add a prefix name to uniquely identify tables/files when Qualytics writes metadata from the source datastore to your enrichment datastore.
2.	Name	Give a name for the enrichment datastore.
3.	Toggle Button for add new connection	Toggle ON to create a new enrichment from scratch or toggle OFF to reuse credentials from an existing connection.
4.	Connector	Select a datastore connector from the dropdown list.

Step 2: Add connection details for your selected enrichment datastore connector.

modal-window

Secrets Management: This is an optional connection property that allows you to securely store and manage credentials by integrating with HashiCorp Vault and other secret management systems. Toggle it ON to enable Vault integration for managing secrets.

Note

Once the HashiCorp Vault is set up, use the ${key} format in Connection form to reference a Vault secret.

REF	FIELDS	ACTIONS
1.	Login URL	Enter the URL used to authenticate with HashiCorp Vault.
2.	Credentials Payload	Input a valid JSON containing credentials for Vault authentication.
3.	Token JSONPath	Specify the JSONPath to retrieve the client authentication token from the response (e.g., $.auth.client_token).
4.	Secret URL	Enter the URL where the secret is stored in Vault.
5.	Token Header Name	Set the header name used for the authentication token (e.g., X-Vault-Token).
6.	Data JSONPath	Specify the JSONPath to retrieve the secret data (e.g., $.data).

secret-management

Step 3: The configuration form will expand, requesting credential details after the selected enrichment datastore connector is chosen.

enrichment-datastore-explain

REF.	FIELDS	ACTIONS
1.	Host (Required)	Get Hostname from your PostgreSQL account and add it to this field.
2.	Port (Required)	Specify the Port number.
3.	User (Required)	Enter the User to connect.
4.	Password (Required)	Enter the password associated with the PostgreSQL user account.
5.	Database (Required)	Specify the database name to be accessed.
6.	Schema (Required)	Define the schema within the database that should be used.
7.	Teams (Required)	Select one or more teams from the dropdown to associate with this datastore.

Step 4: Click on the Test Connection button to verify the selected enrichment datastore connection. If the connection is verified, a flash message will indicate that the connection with the datastore has been successfully verified.

test-connection-for-enrichment-datastore

Step 5: Click on the Finish button to complete the configuration process.

finish-configuration

When the configuration process is finished, a modal will display a success message indicating that your datastore has been successfully added.

Close the Success dialog and the page will automatically redirect you to the Source Datastore Details page where you can perform data operations on your configured source datastore.

data-operation-page

Option II: Use an Existing Connection

If the Use enrichment datastore option is selected from the caret button, you will be prompted to configure the datastore using existing connection details.

Step 1: Click on the caret button and select Use Enrichment Datastore.

use-enrichment-datastore

Step 2: A modal window Link Enrichment Datastore will appear. Add a prefix name and select an existing enrichment datastore from the dropdown list.

select-existing-enrichment-datastore

REF.	FIELDS	ACTIONS
1.	Prefix	Add a prefix name to uniquely identify tables/files when Qualytics writes metadata from the source datastore to your enrichment datastore.
2.	Enrichment Datastore	Select an enrichment datastore from the dropdown list.

Step 3: After selecting an existing enrichment datastore connection, you will view the following details related to the selected enrichment datastore:

Team: The team associated with managing the enrichment datastore is based on the role of public or private. Example- Marked as Public means that this datastore is accessible to all the users.
Host: This is the server address where the PostgreSQL instance is hosted. It is the endpoint used to connect to the PostgreSQL environment.
Database: Refers to the specific database within the PostgreSQL environment where the data is stored.
Schema: The schema used in the enrichment datastore. The schema is a logical grouping of database objects (tables, views, etc.). Each schema belongs to a single database.

use-existing-enrichment-datastore

Step 4: Click on the Finish button to complete the configuration process for the existing enrichment datastore.

finish-configuration-for-existing-enrichment-datastore

When the configuration process is finished, a modal will display a success message indicating that your data has been successfully added.

Close the success message and you will be automatically redirected to the Source Datastore Details page where you can perform data operations on your configured source datastore.

data-operation-page

API Payload Examples

This section provides detailed examples of API payloads to guide you through the process of creating and managing datastores using Qualytics API. Each example includes endpoint details, sample payloads, and instructions on how to replace placeholder values with actual data relevant to your setup.

Creating a Source Datastore

This section provides sample payloads for creating a PostgreSQL datastore. Replace the placeholder values with actual data relevant to your setup.

Endpoint: /api/datastores (post)

Create a Source Datastore with a new ConnectionCreate a Source Datastore with an existing ConnectionCreate a Source Datastore using the CLI

{
    "name": "your_datastore_name",
    "teams": ["Public"],
    "database": "postgresql_database",
    "schema": "postgresql_schema",
    "enrich_only": false,
    "trigger_catalog": true,
    "connection": {
        "name": "your_connection_name",
        "type": "postgresql",
        "host": "postgresql_host",
        "port": "postgresql_port",
        "username": "postgresql_username",
        "password": "postgresql_password"
    }
}

{
    "name": "your_datastore_name",
    "teams": ["Public"],
    "database": "postgresql_database",
    "schema": "postgresql_schema",
    "enrich_only": false,
    "trigger_catalog": true,
    "connection_id": connection-id
}

# Step 1: Create a Connection
qualytics connections create \
    --type postgresql \
    --name "your_connection_name" \
    --host ${DB_HOST} \
    --port 5432 \
    --username ${DB_USER} \
    --password ${DB_PASSWORD}

# Step 2: Create a Source Datastore
qualytics datastores create \
    --name "your_datastore_name" \
    --connection-name "your_connection_name" \
    --database your_database \
    --schema public

Creating an Enrichment Datastore

This section provides sample payloads for creating an enrichment datastore. Replace the placeholder values with actual data relevant to your setup.

Endpoint: /api/datastores (post)

Create an Enrichment Datastore with a new ConnectionCreate an Enrichment Datastore with an existing ConnectionCreate an Enrichment Datastore using the CLI

{
    "name": "your_datastore_name",
    "teams": ["Public"],
    "database": "postgresql_database",
    "schema": "postgresql_schema",
    "enrich_only": true,
    "connection": {
        "name": "your_connection_name",
        "type": "postgresql",
        "host": "postgresql_host",
        "port": "postgresql_port",
        "username": "postgresql_username",
        "password": "postgresql_password"
    }
}

{
    "name": "your_datastore_name",
    "teams": ["Public"],
    "database": "postgresql_database",
    "schema": "postgresql_schema",
    "enrich_only": true,
    "connection_id": connection-id
}

# Step 1: Create a Connection
qualytics connections create \
    --type postgresql \
    --name "your_connection_name" \
    --host ${DB_HOST} \
    --port 5432 \
    --username ${DB_USER} \
    --password ${DB_PASSWORD}

# Step 2: Create an Enrichment Datastore
qualytics datastores create \
    --name "your_datastore_name" \
    --connection-name "your_connection_name" \
    --database your_database \
    --schema your_enrichment_schema \
    --enrichment-only

Link an Enrichment Datastore to a Source Datastore

Use the provided endpoint to link an enrichment datastore to a source datastore:

Endpoint Details: /api/datastores/{datastore-id}/enrichment/{enrichment-id} (patch)