For the complete documentation index, see llms.txt. This page is also available as Markdown.

Amazon Aurora

This article outlines the integration with the Amazon Aurora connector, enabling metadata extraction through features such as crawling, profiling, sample profiling, Query Sheet, data preview, data quality, and lineage building (both automatic and manual). It supports Amazon Aurora MySQL and Amazon Aurora PostgreSQL databases.

The connector establishes connectivity to Amazon Aurora using the JDBC driver. Based on the selected repository type, it connects to either Amazon Aurora MySQL or Amazon Aurora PostgreSQL to retrieve metadata and build lineage.

Overview

Connector Details

Connector Category

RDBMS

OvalEdge Release Supported

Release7.x and later

Connectivity

[How the connection is established with Amazon Aurora]

JDBC Driver

Verified AWS Aurora Versions

Aurora MySQL: 5.7.12 and later

Aurora PostgreSQL: Compatible with AWS Aurora PostgreSQL engine versions

Connector Features

Feature
Availability

Crawling

Profiling

Sample 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 tables describe the metadata objects and attributes extracted from Amazon Aurora MySQL and Amazon Aurora PostgreSQL during crawling, along with their corresponding mappings to OvalEdge assets, attributes, categories, and object types.

Amazon Aurora MySQL Metadata Mapping

Amazon Aurora Object
Amazon Aurora Attribute
OvalEdge Attribute
OvalEdge Category
OvalEdge Type

Schema

SCHEMA_NAME

Schema

Databases

Schema

Schema

Schema comment

-

-

-

Table

TABLE_NAME

Table

Tables

table

Table

TABLE_TYPE

Type

Tables

table

Table

table_comment

Source Description

Descriptions

Source Description

Columns

COLUMN_NAME

Column

Table Columns

-

Columns

data_type

Column Type

Table Columns

-

Columns

COLUMN_COMMENT

Source Description

Table Columns

-

Columns

ordinal_position

Column Position

Table Columns

-

Columns

character_maximum_length / numeric_precision

Data Type Size

Table Columns

-

Columns

COLUMN_KEY (PRI / MUL)

Keys

Table Columns

-

Views

TABLE_NAME

View

Tables

view

Views

VIEW_DEFINITION

View Query

Views

view

Procedures

ROUTINE_NAME

Name

Procedures

-

Procedures

ROUTINE_DEFINITION

Procedure

Procedures

-

Procedures

ROUTINE_TYPE = PROCEDURE

Type

Procedures

-

Procedures

Description

Source Description

Descriptions

-

Functions

ROUTINE_NAME

Name

Functions

-

Functions

ROUTINE_DEFINITION

Function

Functions

-

Functions

ROUTINE_TYPE = FUNCTION

Type

Functions

-

Functions

Description

Source Description

Descriptions

-

Triggers

trigger_name

Name

Triggers

-

Triggers

trigger_code (full CREATE TRIGGER)

Trigger Data

Triggers

-

Triggers

action_timing

Type

Triggers

-

Keys

CONSTRAINT_NAME, REFERENCED_TABLE_NAME, REFERENCED_COLUMN_NAME

Keys / Relationships

Table Columns

-

Indexes

INDEX_NAME

Index

Indexes

Index

Indexes

NON_UNIQUE

Yes / No

Indexes

Index

Amazon Aurora PostgreSQL Metadata Mapping

Amazon Aurora Object
Amazon Aurora Attribute
OvalEdge Attribute
OvalEdge Category
OvalEdge Type

Schema

SCHEMA_NAME

Schema

Databases

Schema

Schema

obj_description (pg_namespace)

Source Description

Databases

Schema

Table

TABLE_NAME

Table

Tables

table

Table

TABLE_TYPE

Type

Tables

table

Table

pg_description (pg_class)

Source Description

Descriptions

Source Description

Table

matviewname (pg_matviews)

Table

Tables

materialized view

Columns

COLUMN_NAME

Column

Table Columns

-

Columns

data_type

Column Type

Table Columns

-

Columns

pg_description (column comment)

Source Description

Table Columns

-

Columns

ordinal_position

Column Position

Table Columns

-

Columns

character_maximum_length / numeric_precision

Data Type Size

Table Columns

-

Columns

constraint_type (PRIMARY KEY / FOREIGN KEY)

Keys

Table Columns

-

Views

TABLE_NAME

View

Tables

view

Views

VIEW_DEFINITION

View Query

Views

view

Views

definition (pg_matviews)

View Query

Views

Materialized View

Procedures

proname

Name

Procedures

-

Procedures

pg_get_functiondef (prokind = 'p')

Procedure

Procedures

-

Procedures

Description

Source Description

Descriptions

-

Functions

proname

Name

Functions

-

Functions

pg_get_functiondef (prokind = 'f')

Function

Functions

-

Functions

Description

Source Description

Descriptions

-

Triggers

trigger_name

Name

Triggers

-

Triggers

action_statement

Trigger Data

Triggers

-

Triggers

-

Type

Triggers

-

Keys

constraint_name, REFERENCED_TABLE_NAME, REFERENCED_COLUMN_NAME

Keys / Relationships

Table Columns

-

Indexes

index_name (pg_index)

Index

Indexes

Index

Indexes

indisunique

Yes / No

Indexes

Index

Set up a Connection

Prerequisites

The prerequisites to establish a connection:

Whitelisting Ports

Make sure that the appropriate inbound database port is whitelisted to enable successful connectivity with Amazon Aurora.

External Supporting Files

The required external JAR files are included as part of the OvalEdge installation artifacts. For driver installation and configuration details, refer to the Connector Drivers Setup Guide. Please contact the OvalEdge Team for assistance related to the driver files and configuration setup.

Service Account User Permissions

👨‍💻 Who can provide these permissions? The Amazon Aurora administrator grants these permissions, since users may not have sufficient access to assign them.

Amazon Aurora MySQL - Access Permissions

Operations
Objects
Sys Tables
Access Permissions

Crawling & Profiling

Schemas

INFORMATION_SCHEMA.SCHEMATA

SELECT

Crawling & Profiling

Tables

INFORMATION_SCHEMA.TABLES

SELECT

Crawling & Profiling

Table Columns

INFORMATION_SCHEMA.COLUMNS

SELECT

Crawling, Profiling & Lineage

Views

INFORMATION_SCHEMA.VIEWS

SELECT, SHOW VIEW

Crawling & Lineage

Functions / Stored Procedures

INFORMATION_SCHEMA.ROUTINES

SELECT

Crawling & Lineage

Triggers

INFORMATION_SCHEMA.TRIGGERS

SELECT

Crawling

Relationships

INFORMATION_SCHEMA.KEY_COLUMN_USAGE

SELECT

Crawling

Indexes

INFORMATION_SCHEMA.STATISTICS

SELECT

Crawling (Optional – RDAM)

User / Schema Permissions

INFORMATION_SCHEMA.SCHEMA_PRIVILEGES

SELECT

Crawling (Optional – RDAM)

User / Table Permissions

INFORMATION_SCHEMA.TABLE_PRIVILEGES

SELECT

Lineage (Optional – Query Log Crawl)

Query Logs

mysql.general_log

SELECT

Profiling / Data Preview / Query Sheet

Tables / Views

Database Tables and Views

SELECT

Amazon Aurora PostgreSQL - Access Permissions

Operations
Objects
Sys Tables
Access Permissions

Crawling & Profiling

Schemas

information_schema.schemata / pg_namespace

SELECT on catalog views

Crawling & Profiling

Tables

information_schema.tables / pg_class

SELECT on catalog views

Crawling & Profiling

Table Columns

information_schema.columns

SELECT on catalog views

Crawling, Profiling & Lineage

Views

pg_views / information_schema.views

SELECT on catalog views

Crawling, Profiling & Lineage (Optional)

Materialized Views

pg_matviews

SELECT on catalog views

Crawling & Lineage

Functions / Stored Procedures

pg_proc + pg_get_functiondef()

SELECT on catalog views

Crawling & Lineage

Triggers

pg_trigger + pg_get_triggerdef()

SELECT on catalog views

Crawling

Relationships

information_schema.table_constraints, information_schema.key_column_usage, information_schema.constraint_column_usage / pg_constraint

SELECT on catalog views

Crawling (Optional)

Indexes

pg_indexes / pg_index

SELECT on catalog views

Crawling (Optional – RDAM)

User / Schema Permissions

information_schema.schema_privileges

SELECT on catalog views

Crawling (Optional – RDAM)

User / Table Permissions

information_schema.role_table_grants

SELECT on catalog views

Lineage (Optional – Query Statistics)

Query Statistics

pg_stat_statements

pg_read_all_stats (or equivalent)

Lineage (Optional – Server Logs)

Server Logs

Aurora PostgreSQL External Logs

N/A

  • The connector establishes connectivity to Amazon Aurora using the native JDBC driver. The required JDBC driver is bundled with OvalEdge by default and supports both Amazon Aurora MySQL and Amazon Aurora PostgreSQL.

  • Metadata crawling retrieves schemas, tables, columns, relationships, indexes, views, functions, stored procedures, and triggers from the corresponding system catalog objects. Optional RDAM metadata includes schema- and table-level privileges.

  • Amazon Aurora MySQL: View metadata requires the SHOW VIEW privilege in addition to SELECT. Query log-based lineage is supported through mysql.general_log and requires the general query log to be enabled.

  • Amazon Aurora PostgreSQL: View, function, and trigger definitions are retrieved from PostgreSQL system catalog views. Query-based lineage can use pg_stat_statements when the extension is enabled, while server logs are available through Aurora log export mechanisms such as CloudWatch.

  • Profiling, Data Preview, and Query Sheet operations require SELECT permission on the target tables and views.

Connection Configuration Steps

  1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Amazon Aurora, and enter the required parameters.

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

Field Name
Description

Connector Type

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

AWS Aurora Repository type*

Select the Amazon Aurora repository type for the connection.

  • MYSQL

  • POSTGRES

Field Name
Description

Authentication*

Select the authentication method used to establish the connection with the Amazon Aurora database.

  • UserId & Password Authentication

  • Azure Entra ID Authentication

SSL Enabled*

Select True to establish a secure SSL-encrypted connection to the Amazon Aurora database, or False to connect without SSL. Ensure the database is configured to support the selected option.

Use SSH Tunnel*

Select True to connect through an SSH tunnel when the Amazon Aurora database is not directly accessible over the network. Select False for a direct database connection.

SSH Host/IP*

Enter the hostname or IP address of the SSH server used to establish the secure tunnel to the Amazon Aurora database.

Note: This field is displayed only when Use SSH Tunnel is set to True.

SSH Port*

Enter the port number configured for the SSH server to establish the SSH tunnel.

Note: This field is displayed only when Use SSH Tunnel is set to True.

SSH User Name*

Enter the username (SSH Tunnel) used to authenticate with the SSH server.

Note: This field is displayed only when Use SSH Tunnel is set to True.

SSH Password*

Enter the password associated with the SSH user account. Note: This field is displayed only when Use SSH Tunnel is set to True.

Local Port*

Enter the local port number used for SSH port forwarding between the local machine and the Amazon Aurora database. Ensure the specified port is available on the local system. Note: This field is displayed only when Use SSH Tunnel is set to True.

Credential Manager*

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

Supported Credential Managers:

  • OE Credential Manager

  • AWS Secrets Manager

  • HashiCorp

  • Azure Key Vault

For more details, click here.

License Add-On

  • Select the Auto Lineage Add-On checkbox 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.

For more details, click here.

Connector Name*

Enter a unique name for the Amazon Aurora connection

(Example: "Amazon Aurora_Prod").

Connector Environment

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

For more details, click here.

Connector Description

Enter the description related to the connector.

Server*

Enter the Amazon Aurora database endpoint (host name) or IP address of the target database server (Example: aurora-xxxxxxxx.us-east-1.rds.amazonaws.com or 192.xxx.xx.20).

Port*

By default, the port number for Aurora MySQL, "3306" is auto-populated. If required, the port number can be modified as per the custom port number that is configured for Amazon Aurora.

Database*

Enter the name of the target Amazon Aurora database to which the connector will establish the connection. Ensure the specified database is accessible by the configured service account.

Driver*

By default, the driver detail is automatically populated based on the selected repository type and cannot be modified (Aurora MySQL: com.mysql.cj.jdbc.Driver).

Username*

Enter the service account username with the required permissions to access Amazon Aurora metadata and data. Ensure that the account has the required permissions to access the database metadata and data.

Password*

Enter the password associated with the configured service account user.

Note: This field appear only if the authentication field is selected as “UserId & Password Authentication”.

Connection String

Configure the connection string for the Oracle 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’s 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 and teams configured in OvalEdge Security are displayed for selection.

Admin Roles

Admin Roles*

Select one or more users from the drop-down list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security 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 configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering 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

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

  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 for a selected timeframe, from a minute to a year.

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

  2. Select a time period 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 and their health status.

Managing connectors includes:

  • Connectors Health: Displays the current status of each connector, with a green icon for active connections and a red icon for inactive connections, helping monitor connectivity to data sources.

  • Viewing: Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and views.

Nine Dots Menu Options:

To view, edit, validate, build lineage, configure, or delete connectors, click on the Nine Dots menu.

  • Edit Connector: Update and revalidate the data source.

  • Validate Connector: Check the integrity of the connection.

  • Settings: Modify connector settings.

    • Crawler: Configure data extraction.

    • Profiler: Customize data profiling rules and methods.

    • Access Instructions: Add notes on how data can be accessed.

    • Business Glossary Settings: Manage term associations at the connector level.

    • Lineage: Select server dialects for parsing and setting connector priority for table lineage.

    • Others: Configure notification recipients for metadata changes.

  • Build Lineage: Automatically build data lineage using source code parsing.

  • Delete Connector: Remove a connector with confirmation.

For more details on connector settings, click here.

Limitations

S.No.
Description

1

Data Profiling for the following data type columns is not supported:

  • My SQL: “Long blob”, “blob”

  • PostGreSQL : “bytea", "jsonb", "lseg", "polygon", "json", "box",

"macaddr", "line", "point", "array", "xid", "anyarray", "oidvector", "int2vector", "bytea", "tid", "pg_lsn","user-defined", "uuid", "hstore", "int4range", "int8range", "numrange", "tsrange", "tstzrange", "daterange”

2.

Data Profiling limit for column length - supports up to 50,000.

Connectivity Troubleshooting

S.No.
Error Message(s)
Error Description / Resolution

1

Failed to establish a connection. Please check the credentials.

Error Description

The primary reason for this error is usually incorrect or invalid credentials (username or password).

Error Resolution

Verify the username and password, check the connection string format, ensure network connectivity, review user access permissions, and validate the database endpoint.

2

Connection Timeout

Error Description

The "Connection Timeout" error occurs when the connector is unable to establish a connection to the Aurora database within a specified time period. This can be due to network issues, incorrect configuration settings, or server unavailability.

Error Resolution

Check network connectivity, verify the endpoint and port, review firewall and security group settings, increase timeout settings, ensure the database server is running, reduce network latency, and consult logs for details.

3

Warning for unsupported data types while profiling

Error Description

Warning for column SampleTable.column_binary but continuing operation. Skipping profile for unsupported data type binary.

Error Resolution

Convert unsupported data types to supported ones if profiling is important. For example, change binary data to VARBINARY or BLOB if supported. Check for updates or plugins for your profiling tool that add support for more data types.

FAQs

How much does the driver cost?

The JDBC Driver for AWS Aurora is available at no additional charge.

Can I use the driver to access AWS Aurora from a Linux system?

Yes! You can use the driver to access AWS Aurora from Linux, Unix, and other non-Windows platforms.


Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA

Last updated

Was this helpful?