MySQL

This document outlines the integration with the MySQL connector, enabling streamlined metadata management through features such as crawling, profiling, querying, 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 RDBMS system]	JDBC driver
Verified MySQL Version	MySQL8.4

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

MySQL Object	MySQL Attribute	OvalEdge Attribute	OvalEdge Category	OvalEdge Type
Table	Table Name	Table	Tables	table
Table	Table Type	Type	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	text	View Query	Views	View
Procedures	routine_name	Name	Procedures	Procedure
Procedures	description	Source Description	Descriptions	-
Procedures	routine_definition	Procedure	Procedures	-
Functions	routine_name	Name	Functions	Functions
Functions	routine_definition	Function	Functions	-
Functions	description	Source Description	Descriptions	-
Triggers	Trigger Name	Name	Triggers	-
Triggers	Trigger Definition	Trigger Data	Triggers	-
Triggers	Trigger Type	Type	Triggers	-

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

• If Azure Entra ID Authentication is selected as the authentication type, ensure that the application is installed in the Azure environment.

Whitelisting Ports

• Make sure that inbound port “3306” is whitelisted to enable successful connectivity with the MySQL database.

The default port number for MySQL data source is 3306. 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 MySQL data source 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 MySQL 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	Table Columns	Information_Schema.Columns	SELECT
Crawling & Profiling	Views	Information_Schema.Views	SELECT
Crawling	Functions	Information_Schema.Routines	EXECUTE
Crawling & Lineage Building	Stored Procedures	Information_Schema.Routines	EXECUTE
Crawling	Triggers	Information_Schema.Triggers	TRIGGER
Crawling	ColumnRelations	Information_Schema.Key_Column_Usage	SELECT, 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 MySQL, and complete the required parameters.

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

Field Name	Description
Connector Type	By default, "MySQL" is displayed as the selected connector type.
Authentication	The following two types of authentication are supported for MySQL Server: UserId & Password Authentication Azure Entra ID Authentication

UserId & Password Authentication

Field Name	Description
SSL Enabled*	Select True or False. By default, the value is set to False.
Use SSH Tunnel*	Select True or False. By default, the value is set to False.
SSH Host/IP*	Enter the Host of SSH Tunnel Note: This field is enabled only when the Use SSH Tunnel option is selected as True.
SSH Port*	Enter the SSH Tunnel Port Note: This field is enabled only when the Use SSH Tunnel option is selected as True.
SSH User Name*	Enter the SSH Tunnel User Name Note: This field is enabled only when the Use SSH Tunnel option is selected as True.
SSH Password*	Enter the Password of SSH Tunnel Note: This field is enabled only when the Use SSH Tunnel option is selected as True.
Local Port*	Enter the Local Port for port forwarding Note: This field is enabled only when the Use SSH Tunnel option is selected as 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
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 MySQL connection (Example: "MySQLdb").
Connector Environment	Select the environment (Example: PROD, STG) configured for the connector.
Connector Description	Enter a brief description of the connector.
Server*	Enter the MySQL Server database server name or IP address. (Example: xxxx-sxxxxxx.xxxx4ijxxxl.xx-xx-1.rxs.xxxxx.com or 1xx.xxx.1.xx).
Port*	By default, the port number for MySQL, "3306" is auto-populated. If required, the port number can be modified as per the custom port number that is configured for the MySQL Database.
Database*	Enter the user-defined database name for the MySQL connection to crawl metadata.
Driver*	By default, the MySQL driver details are auto-populated.
Username*	Enter the service account username set up to access the MySQL database (Example: "oesauser").
Password*	Enter the password associated with the service account user.
Connection String	Configure the connection string for the MySQL 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.

Azure Entra ID Authentication

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*	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*	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.
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:

• Connectors 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:

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

---

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA