PostgreSQL

This document outlines the integration with the PostgreSQL connector, enabling efficient data management through features such as crawling, profiling, query sheet, data preview, and lineage building (both automatic and manual). It also ensures secure authentication via Credential Manager.

Overview

Connector Details

Connector Category

RDBMS

Connector Version

Release6.3.4

Releases Supported (Available from)

Legacy Connector

Connectivity

[How the connection is established with PostgreSQL]

JDBC

Verified PostgreSQL Version

Above 6.0

The PostgreSQL connector has been validated with the mentioned "Verified PostgreSQL Versions" and is expected to be compatible with other supported PostgreSQL Versions. If there are any validation or metadata crawling issues, please submit a support ticket for investigation and feedback.

Connector Features

Feature

Availability

Crawling

✅

Delta Crawling

❌

Profiling

✅

Query Sheet

✅

Data Preview

✅

Auto Lineage

✅

Manual Lineage

✅

Secure Authentication via Credential Manager

✅

Data Quality

✅

DAM (Data Access Management)

❌

Bridge

✅

Metadata Mapping

The following objects are crawled from PostgreSQL and mapped to the corresponding UI assets.

PostgreSQL Object

PostgreSQL Attribute

OvalEdge Attribute

OvalEdge Category

OvalEdge Type

Table

Table Name

Table

Tables

table

Table

Table Type

Table

Tables

table

Table

Table Comments

Source Description

Descriptions

Source Description

Columns

Column Name

Column

Table Columns

Columns

Data Type

Column Type

Table Columns

Columns

Description

Source Description

Table Columns

Columns

Ordinal Position

Column Position

Table Columns

Columns

Length

Data Type Size

Table Columns

Views

View Name

View

Tables

view

Views

View_Definition/Definition

View Query

Views

View

Procedures

nspname

Name

Procedures

nspname

Source Description

Descriptions

Procedures

Prosrc

Procedure

Procedures

Functions

nspname

Name

Functions

Function_Definition

Function

Functions

Description

Source Description

Descriptions

Triggers

Trigger Name

Name

Triggers

action_statement

Trigger Data

Triggers

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Whitelisting Ports

Make sure that the inbound port “5432” is whitelisted to enable successful connectivity with the PostgreSQL database.

The default port number for PostgreSQL is 5432. If a different port is used, ensure that the updated port number is specified during connection setup, the port is whitelisted, and communication between the system and PostgreSQL is properly established.

Service Account User Permissions

It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.

👨‍💻Who can provide these permissions? These permissions are typically granted by the PostgreSQL administrator, as users may not have the required access to assign them independently.

Operations

Objects

System Tables

Access Permission

Crawling & Profiling

Schemas

information_schema.schemata

USAGE

Crawling & Profiling

Tables

information_schema.tables

SELECT

Crawling & Profiling

Tables

pg_matviews

SELECT

Crawling & Profiling

Table Columns

pg_attribute, pg_class, pg_namespace

SELECT

Crawling & Profiling

Table Columns

information_schema.columns

SELECT

Crawling, Profiling , & Lineage Building

Views

information_schema.views

SELECT

Crawling, Profiling , & Lineage Building

Views

pg_matviews

SELECT

Crawling, & Lineage Building

Functions

pg_proc

EXECUTE

Crawling, & Lineage Building

Functions

pg_namespace

EXECUTE

Crawling, & Lineage Building

Functions

pg_language

EXECUTE

Crawling, & Lineage Building

Functions

pg_type

EXECUTE

Crawling, & Lineage Building

Stored Procedures

pg_proc

EXECUTE

Crawling, & Lineage Building

Stored Procedures

pg_namespace

EXECUTE

Crawling, & Lineage Building

Stored Procedures

pg_language

EXECUTE

Crawling, & Lineage Building

Stored Procedures

pg_type

EXECUTE

Crawling

Triggers

information_schema.triggers

EXECUTE

Crawling

Relationships

information_schema.referential_constraints

REFERENCES

Crawling

Relationships

information_schema.key_column_usage

REFERENCES

Connection Configuration Steps

Important: You must have the Connector Creator role to set up a connection in OvalEdge.

Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for PostgreSQL, and complete the required parameters.

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name

Description

Connector Type

By default, "PostgreSQL" is displayed as the selected connector type.

Credential Manager*

Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.

Supported Credential Managers:

OE Credential Manager
AWS Secrets Manager
HashiCorp Vault
Azure Key Vault

License Add Ons

Auto Lineage

Supported

Data Quality

Supported

Data Access

Not Supported

Select the checkbox for Auto Lineage Add-On to build data lineage automatically.
Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.

Connector Name*

Enter a unique name for the PostgreSQL connection.

Connector Environment

Select the environment (Example: PROD, STG) configured for the connector.

Connector Description

Enter a brief description of the connector.

Server*

Enter the PostgreSQL database server name or IP address. (Example: xxxx-xxxxxxx.xxxx4ijtzasl.xx-south-1.rds.amazonaws.com or 1xx.xxx.1.xx).

Port*

By default, the port number for PostgreSQL, 5432, is auto-populated. If required, you can change it to a custom port number configured for your PostgreSQL.

Database*

Enter the database name to which the service account user has access within the PostgreSQL.

Driver*

By default, the PostgreSQL driver details are auto-populated.

Username*

Enter the service account username configured to access the PostgreSQL database (example: "oesauser").

Password*

Enter the password associated with the service account user.

Connection String

Configure the connection string for the PostgreSQL database:

Automatic mode: The system generates a connection string based on the provided credentials.
Manual mode: Enter a valid connection string manually.

Replace placeholders with actual database details.

{sid} refers to the database name.

Plugin Server

Enter the server name when running as a plugin server.

Plugin Port

Enter the port number on which the plugin is running.

After entering all connection details, the following actions can be performed:
1. Click Validate to verify the connection.
2. Click Save to store the connection for future use.
3. Click Save & Configure to apply additional settings before saving.
The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

To perform crawl and profile operations, users must be assigned the Integration Admin role.

The Crawl/Profile button allows users to select one or more schemas for crawling and profiling.

Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to be crawled.
The Crawl option is selected by default. To perform both operations, select the Crawl & Profile radio button.
Click Run to collect metadata from the connected source and load it into the Data Catalog.
After a successful crawl, the information appears in the Data Catalog > Databases tab.

The Schedule checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

Click the Schedule checkbox to enable the Select Period drop-down.
Select a time interval for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
The system will automatically execute the selected operation (Crawl or Crawl & Profile) at the scheduled time.

Other Operations

The Connectors page provides a centralized view of all configured connectors, along with their health status.

Managing connectors includes:

Connector Health: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
Viewing: Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

Nine Dots Menu Options:

You can view, edit, validate, build lineage, modify connector settings, and delete connectors using the Nine Dots menu.

Edit Connector: Update and revalidate the data source.
Validate Connector: Check the connection's integrity.
Settings: Modify connector settings.
- Crawler: Configure data extraction.
- Profiler: Customize data profiling rules and methods.
- Query Policies: Define query execution rules based on roles.
- Access Instructions: Add notes on how data can be accessed.
- Business Glossary Settings: Manage term associations at the connector level.
- Anomaly Detection Settings: Configure anomaly detection preferences at the connector level.
- Others: Configure notification recipients for metadata changes.
Build Lineage: Automatically build data lineage using source code parsing.
Delete Connector: Remove a connector with confirmation.

Connectivity Troubleshooting

If incorrect parameters are provided, you may encounter error messages. To resolve these issues, ensure all input is correct. If problems persist, contact your assigned OvalEdge support team.

S. No.

Error Description

Resolution

Error while validating connection: Exception occured while validating the PostgreSql Connection : Failed to obtain JDBC Connection; nested exception is xxx.postgresql.xxx.PSQLExxxxxx: FATAL: password authentication failed for user "xxxxx"

Error Description:

Either username and password might be wrong.

Resolution:

You provided an incorrect username or password in the setup form's User or Password fields or formatted the User field value incorrectly.
The authorizing user has the permission required to connect the database to OvalEdge.
The authorizing user is not locked out of their account or required to reset the password.

Error Description:

The database name provided is invalid.

Resolution:

You provided an incorrect database name in the setup form's Database Name field.
Ensure that the database name is correctly spelled and exists in the target system.

PreviousSybase ASE (Adaptive Server Enterprise)NextSybase IQ

Last updated 2 months ago

Was this helpful?