AlloyDB

This article outlines the integration process for AlloyDB using PostgreSQL as the connectivity protocol. The integration enables efficient data management through key 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	Release 6.3.4
Releases Supported (Available From)	Legacy Connector
Connectivity	JDBC Driver
Verified AlloyDB Version	Supported with PostgreSQL 15.0

The AlloyDB connector has been validated with the mentioned "Verified AlloyDB Versions" and is expected to be compatible with other supported PostgreSQL versions. If there are any validation or metadata crawling issues, 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 AlloyDB and mapped to the corresponding UI assets.

AlloyDB Object	AlloyDB 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
Columns	Data Type	Column Type	Table Columns	Columns
Columns	Description	Source Description	Table Columns	Columns
Columns	Ordinal Position	Column Position	Table Columns	Columns
Columns	Length	Data Type Size	Table Columns	Columns
Views	View Name	View	Tables	View
Views	View Definition/Definition	View Query	Views	View
Procedures	nspname	Name	Procedures	Procedures
Procedures	nspname	Source Description	Descriptions	Procedures
Procedures	Prosrc	Procedure	Procedures	Procedures
Functions	nspname	Name	Functions	Functions
Functions	Function Definition	Function	Functions	Functions
Functions	Description	Source Description	Descriptions	Functions
Triggers	Trigger Name	Name	Triggers	Triggers
Triggers	Action Statement	Trigger Data	Triggers	Triggers
Indexes	Index Name	Index	Indexes	Indexes
Indexes	If Unique	Yes/No	Indexes	Indexes

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 AlloyDB database.

The default port number for AlloyDB 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 AlloyDB 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 AlloyDB administrator, as users may not have the required access to assign them independently.

Operation	Objects	Sys Tables	Access Permissions
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	SELECT
Crawling, & Lineage Building	Functions	Pg_Namespace	SELECT
Crawling, & Lineage Building	Functions	Pg_Language	SELECT
Crawling, & Lineage Building	Functions	Pg_Type	SELECT
Crawling, & Lineage Building	Stored Procedures	Pg_Proc	SELECT
Crawling, & Lineage Building	Stored Procedures	Pg_Namespace	SELECT
Crawling, & Lineage Building	Stored Procedures	Pg_Language	SELECT
Crawling, & Lineage Building	Stored Procedures	Pg_Type	SELECT
Crawling	Triggers	Information_Schema.Triggers	SELECT
Crawling	Relationships	Information_Schema.Referential_Constraints	REFERENCES
Crawling	Relationships	Information_Schema.Key_Column_Usage	REFERENCES

Connection Configuration Steps

Users are required to have the Connector Creator role in order to configure a new connection.

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for AlloyDB, 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. Supported options: 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 AlloyDB 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 AlloyDB database server name or IP address. (Example: xxxx-xxxxxxx.xxxx4ijtzasl.xx-south-1.xxx.xxxxx.com or 1xx.xxx.1.xx).
Port*	By default, the port number for AlloyDB, 5432, is auto-populated. If required, you can change it to a custom port number configured for the AlloyDB.
Database*	Enter the database name to which the service account user has access within the AlloyDB.
Driver*	By default, the AlloyDB driver details are auto-populated.
Username*	Enter the service account username configured to access the AlloyDB database (example: "oesauser").
Password*	Enter the password associated with the service account user.
Connection String	Configure the connection string for the AlloyDB 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.

Default Governance Roles

Default Governance Roles*	Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.

Admin Roles

Admin Roles*	Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in the security settings are available for selection.

No of Archive Objects

No Of Archive Objects*	This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive. Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.

Bridge

Select Bridge*	If applicable, select the bridge from the drop-down list. The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.

1. 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.

2. 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.

1. Navigate to the Connectors page and click Crawl/Profile.

2. Select the schemas to be crawled.

3. The Crawl option is selected by default. To perform both operations, select the Crawl & Profile radio button.

4. Click Run to collect metadata from the connected source and load it into the Data Catalog.

5. 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.

1. Click the Schedule checkbox to enable the Select Period drop-down.

2. Select a time interval for the operation from the drop-down menu.

3. Click Schedule to initiate metadata collection from the connected source.

4. 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 entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

S.No.	Error Message(s)	Error Description/Resolution
1	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 their password.
2	Error while validating connection: Exception occured while validating the PostgreSql Connection : Failed to obtain JDBC Connection; nested exception is xxx.postgresql.xxx.PSQLException: FATAL: database "xxxxx" does not exist	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.

---

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.