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

<figure><img src="https://content.gitbook.com/content/ztcvwwOJCeaE1n6oHp4C/blobs/Wul1F9lNrP9LrPHXBiBS/image.png" alt=""><figcaption></figcaption></figure>

## 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 |

{% hint style="info" %}
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.
{% endhint %}

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

<table><thead><tr><th width="171.5">AlloyDB Object</th><th width="209.083251953125">AlloyDB Attribute</th><th width="197.083251953125">OvalEdge Attribute</th><th width="188">OvalEdge Category</th><th width="177.166748046875">OvalEdge Type</th></tr></thead><tbody><tr><td>Table</td><td>Table Name</td><td>Table</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>Table Type</td><td>Table</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td>Table Comments</td><td>Source Description</td><td>Descriptions</td><td>Source Description</td></tr><tr><td>Columns</td><td>Column Name</td><td>Column</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Data Type</td><td>Column Type</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Description</td><td>Source Description</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Ordinal Position</td><td>Column Position</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Length</td><td>Data Type Size</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Views</td><td>View Name</td><td>View</td><td>Tables</td><td>View</td></tr><tr><td>Views</td><td>View Definition/Definition</td><td>View Query</td><td>Views</td><td>View</td></tr><tr><td>Procedures</td><td>nspname</td><td>Name</td><td>Procedures</td><td>Procedures</td></tr><tr><td>Procedures</td><td>nspname</td><td>Source Description</td><td>Descriptions</td><td>Procedures</td></tr><tr><td>Procedures</td><td>Prosrc</td><td>Procedure</td><td>Procedures</td><td>Procedures</td></tr><tr><td>Functions</td><td>nspname</td><td>Name</td><td>Functions</td><td>Functions</td></tr><tr><td>Functions</td><td>Function Definition</td><td>Function</td><td>Functions</td><td>Functions</td></tr><tr><td>Functions</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>Functions</td></tr><tr><td>Triggers</td><td>Trigger Name</td><td>Name</td><td>Triggers</td><td>Triggers</td></tr><tr><td>Triggers</td><td>Action Statement</td><td>Trigger Data</td><td>Triggers</td><td>Triggers</td></tr><tr><td>Indexes</td><td>Index Name</td><td>Index</td><td>Indexes</td><td>Indexes</td></tr><tr><td>Indexes</td><td>If Unique</td><td>Yes/No</td><td>Indexes</td><td>Indexes</td></tr></tbody></table>

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

{% hint style="warning" %}
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.
{% endhint %}

#### Service Account User Permissions

{% hint style="warning" %}
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.
{% endhint %}

{% hint style="info" %}
👨‍💻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.
{% endhint %}

<table data-full-width="false"><thead><tr><th width="154.66668701171875">Operation</th><th width="167">Objects</th><th width="358.75">Sys Tables</th><th width="193.8333740234375">Access Permissions</th></tr></thead><tbody><tr><td>Crawling &#x26; Profiling</td><td>Schemas</td><td>Information_Schema.Schemata</td><td>USAGE</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Tables</td><td>Information_Schema.Tables</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Tables</td><td>Pg_Matviews</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Table Columns</td><td>Pg_Attribute, Pg_Class, Pg_Namespace</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Table Columns</td><td>Information_Schema.Columns</td><td>SELECT</td></tr><tr><td>Crawling, Profiling, &#x26; Lineage Building</td><td>Views</td><td>Information_Schema.Views</td><td>SELECT</td></tr><tr><td>Crawling, Profiling, &#x26; Lineage Building</td><td>Views</td><td>Pg_Matviews</td><td>SELECT</td></tr><tr><td>Crawling, &#x26; Lineage Building</td><td>Functions</td><td>Pg_Proc</td><td>SELECT</td></tr><tr><td>Crawling, &#x26; Lineage Building</td><td>Functions</td><td>Pg_Namespace</td><td>SELECT</td></tr><tr><td>Crawling, &#x26; Lineage Building</td><td>Functions</td><td>Pg_Language</td><td>SELECT</td></tr><tr><td>Crawling, &#x26; Lineage Building</td><td>Functions</td><td>Pg_Type</td><td>SELECT</td></tr><tr><td>Crawling, &#x26; Lineage Building</td><td>Stored Procedures</td><td>Pg_Proc</td><td>SELECT</td></tr><tr><td>Crawling, &#x26; Lineage Building</td><td>Stored Procedures</td><td>Pg_Namespace</td><td>SELECT</td></tr><tr><td>Crawling, &#x26; Lineage Building</td><td>Stored Procedures</td><td>Pg_Language</td><td>SELECT</td></tr><tr><td>Crawling, &#x26; Lineage Building</td><td>Stored Procedures</td><td>Pg_Type</td><td>SELECT</td></tr><tr><td>Crawling</td><td>Triggers</td><td>Information_Schema.Triggers</td><td>SELECT</td></tr><tr><td>Crawling</td><td>Relationships</td><td>Information_Schema.Referential_Constraints</td><td>REFERENCES</td></tr><tr><td>Crawling</td><td>Relationships</td><td>Information_Schema.Key_Column_Usage</td><td>REFERENCES</td></tr></tbody></table>

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

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

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="219">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "PostgreSQL" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td>Select the desired credentials manager. Supported options: OE Credential Manager, AWS Secrets Manager, HashiCorp Vault, Azure Key Vault.</td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</li><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li></ul></td></tr><tr><td>Connector Name*</td><td>Enter a unique name for the AlloyDB connection.</td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Server*</td><td>Enter the AlloyDB database server name or IP address. (Example: xxxx-xxxxxxx.xxxx4ijtzasl.xx-south-1.xxx.xxxxx.com or 1xx.xxx.1.xx).</td></tr><tr><td>Port*</td><td>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.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the AlloyDB.</td></tr><tr><td>Driver*</td><td>By default, the AlloyDB driver details are auto-populated.</td></tr><tr><td>Username*</td><td>Enter the service account username configured to access the AlloyDB database (example: "oesauser").</td></tr><tr><td>Password*</td><td>Enter the password associated with the service account user.</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the AlloyDB database:</p><ul><li><strong>Automatic mode</strong>: The system generates a connection string based on the provided credentials.</li><li><strong>Manual mode</strong>: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{<strong>sid</strong>} refers to the <strong>database name</strong>.</p></td></tr><tr><td>Plugin Server</td><td>Enter the server name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="219"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>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.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="219"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="219"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>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.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="219"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>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.</p></td></tr></tbody></table>

2. 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.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="warning" %}
To perform crawl and profile operations, users must be assigned the Integration Admin role.
{% endhint %}

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

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.

<table><thead><tr><th width="82.75">S.No.</th><th width="254.5">Error Message(s)</th><th>Error Description/Resolution</th></tr></thead><tbody><tr><td>1</td><td>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"</td><td><p><strong>Error Description:</strong></p><p>Either username and password might be wrong.</p><p><strong>Resolution</strong>:</p><ul><li>You provided an incorrect username or password in the setup form's User or Password fields or formatted the User field value incorrectly.</li><li>The authorizing user has the permission required to connect the database to OvalEdge.</li><li>The authorizing user is not locked out of their account or required to reset their password.</li></ul></td></tr><tr><td>2</td><td>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</td><td><p><strong>Error Description:</strong></p><p>The database name provided is invalid.</p><p><strong>Resolution</strong>:</p><ul><li>You provided an incorrect database name in the setup form's Database Name field.</li><li>Ensure that the database name is correctly spelled and exists in the target system.</li></ul></td></tr></tbody></table>

***

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