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

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

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="444"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>RDBMS</td></tr><tr><td>Connector Version</td><td>Release6.3.4</td></tr><tr><td>Releases Supported (Available from)</td><td>Legacy Connector</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with RDBMS system]</p></td><td>JDBC driver</td></tr><tr><td>Verified MySQL Version</td><td>MySQL8.4</td></tr></tbody></table>

{% hint style="info" %}
&#x20;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.
{% 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 MySQL and mapped to the corresponding UI assets.

<table><thead><tr><th width="179.6666259765625">MySQL Object</th><th width="166.5" valign="middle">MySQL Attribute</th><th width="195.9998779296875">OvalEdge Attribute</th><th width="184.25">OvalEdge Category</th><th width="188">OvalEdge Type</th></tr></thead><tbody><tr><td>Table</td><td valign="middle">Table Name</td><td>Table</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td valign="middle">Table Type</td><td>Type</td><td>Tables</td><td>table</td></tr><tr><td>Table</td><td valign="middle">Table Comments</td><td>Source Description</td><td>Descriptions</td><td>Source Description</td></tr><tr><td>Columns</td><td valign="middle">Column Name</td><td>Column</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td valign="middle">Data Type</td><td>Column Type</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td valign="middle">Description</td><td>Source Description</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td valign="middle">Ordinal Position</td><td>Column Position</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td valign="middle">Length</td><td>Data Type Size</td><td>Table Columns</td><td>-</td></tr><tr><td>Views</td><td valign="middle">View Name</td><td>View</td><td>Tables</td><td>view</td></tr><tr><td>Views</td><td valign="middle">text</td><td>View Query</td><td>Views</td><td>View</td></tr><tr><td>Procedures</td><td valign="middle">routine_name</td><td>Name</td><td>Procedures</td><td>Procedure</td></tr><tr><td>Procedures</td><td valign="middle">description</td><td>Source Description</td><td>Descriptions</td><td>-</td></tr><tr><td>Procedures</td><td valign="middle">routine_definition</td><td>Procedure</td><td>Procedures</td><td>-</td></tr><tr><td>Functions</td><td valign="middle">routine_name</td><td>Name</td><td>Functions</td><td>Functions</td></tr><tr><td>Functions</td><td valign="middle">routine_definition</td><td>Function</td><td>Functions</td><td>-</td></tr><tr><td>Functions</td><td valign="middle">description</td><td>Source Description</td><td>Descriptions</td><td>-</td></tr><tr><td>Triggers</td><td valign="middle">Trigger Name</td><td>Name</td><td>Triggers</td><td>-</td></tr><tr><td>Triggers</td><td valign="middle">Trigger Definition</td><td>Trigger Data</td><td>Triggers</td><td>-</td></tr><tr><td>Triggers</td><td valign="middle">Trigger Type</td><td>Type</td><td>Triggers</td><td>-</td></tr></tbody></table>

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

{% hint style="warning" %}
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.
{% 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 MySQL administrator, as users may not have the required access to assign them independently.
{% endhint %}

<table data-full-width="false"><thead><tr><th width="171.75" valign="middle">Operation</th><th width="169.5" valign="middle">Objects</th><th width="331.25" valign="middle">Sys Tables</th><th width="215.416748046875" valign="middle">Access Permissions</th></tr></thead><tbody><tr><td valign="middle">Crawling &#x26; Profiling</td><td valign="middle">Schemas</td><td valign="middle">Information_Schema.Schemata</td><td valign="middle">USAGE</td></tr><tr><td valign="middle">Crawling &#x26; Profiling</td><td valign="middle">Tables</td><td valign="middle">Information_Schema.Tables</td><td valign="middle">SELECT</td></tr><tr><td valign="middle">Crawling &#x26; Profiling</td><td valign="middle">Table Columns</td><td valign="middle">Information_Schema.Columns</td><td valign="middle">SELECT</td></tr><tr><td valign="middle">Crawling &#x26; Profiling</td><td valign="middle">Views</td><td valign="middle">Information_Schema.Views</td><td valign="middle">SELECT</td></tr><tr><td valign="middle">Crawling</td><td valign="middle">Functions</td><td valign="middle">Information_Schema.Routines</td><td valign="middle">EXECUTE</td></tr><tr><td valign="middle">Crawling &#x26; Lineage Building</td><td valign="middle">Stored Procedures</td><td valign="middle">Information_Schema.Routines</td><td valign="middle">EXECUTE</td></tr><tr><td valign="middle">Crawling</td><td valign="middle">Triggers</td><td valign="middle">Information_Schema.Triggers</td><td valign="middle">TRIGGER</td></tr><tr><td valign="middle">Crawling</td><td valign="middle">ColumnRelations</td><td valign="middle">Information_Schema.Key_Column_Usage</td><td valign="middle">SELECT, 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 **MySQL**, 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="185.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "MySQL" is displayed as the selected connector type.</td></tr><tr><td>Authentication</td><td><p>The following two types of authentication are supported for MySQL Server:</p><ul><li>UserId &#x26; Password Authentication</li><li>Azure Entra ID Authentication</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="UserId & Password Authentication" %}

<table><thead><tr><th width="217.75">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>SSL Enabled*</td><td>Select True or False. By default, the value is set to False.</td></tr><tr><td>Use SSH Tunnel*</td><td>Select True or False. By default, the value is set to False.</td></tr><tr><td>SSH Host/IP*</td><td>Enter the Host of SSH Tunnel<br><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></td></tr><tr><td>SSH Port*</td><td>Enter the SSH Tunnel Port<br><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></td></tr><tr><td>SSH User Name*</td><td>Enter the SSH Tunnel User Name<br><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></td></tr><tr><td>SSH Password*</td><td>Enter the Password of SSH Tunnel<br><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></td></tr><tr><td>Local Port*</td><td>Enter the Local Port for port forwarding<br><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><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><p>Enter a unique name for the MySQL connection              </p><p>(Example: "MySQLdb").</p></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 MySQL Server database server name or IP address. (Example: xxxx-sxxxxxx.xxxx4ijxxxl.xx-xx-1.rxs.xxxxx.com or 1xx.xxx.1.xx).</td></tr><tr><td>Port*</td><td>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.</td></tr><tr><td>Database*</td><td>Enter the user-defined database name for the MySQL connection to crawl metadata.</td></tr><tr><td>Driver*</td><td>By default, the MySQL driver details are auto-populated. </td></tr><tr><td>Username*</td><td>Enter the service account username set up to access the MySQL 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 MySQL database:</p><ul><li>Automatic Mode: The system generates a connection string based on the provided credentials.</li><li>Manual Mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{sid} refers to the Database Name</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>
{% endtab %}

{% tab title="Azure Entra ID Authentication" %}

<table><thead><tr><th width="206.5">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>SSL Enabled*</td><td>Select True or False. By default, the value is set to False.</td></tr><tr><td>Use SSH Tunnel*</td><td>Select True or False. By default, the value is set to False.</td></tr><tr><td>SSH Host/IP*</td><td>Enter the Host of the SSH Tunnel.<br><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></td></tr><tr><td>SSH Port*</td><td>Enter the SSH Tunnel Port.<br><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></td></tr><tr><td>SSH User Name*</td><td><p>Enter the SSH Tunnel User Name.</p><p><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></p></td></tr><tr><td>SSH Password*</td><td><p>Enter the Password of the SSH Tunnel.</p><p><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></p></td></tr><tr><td>Local Port*</td><td><p>Enter the Local Port for port forwarding.</p><p><em><strong>Note</strong>: This field is enabled only when the Use SSH Tunnel option is selected as True.</em></p></td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><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><p>Enter a unique name for the MySQL connection              </p><p>(Example: "MySQLdb").</p></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 MySQL Server database server name or IP address. (Example: xxxx-sxxxxxx.xxxx4ijxxxl.xx-south-1.rxs.xxxxx.com or 1xx.xxx.1.xx).</td></tr><tr><td>Port*</td><td>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.</td></tr><tr><td>Database*</td><td>Enter the user-defined database name for the MySQL connection to crawl metadata.</td></tr><tr><td>Driver*</td><td>By default, the MySQL driver details are auto-populated. </td></tr><tr><td>Username*</td><td>Enter the service account username set up to access the MySQL database (Example: "oesauser").</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the MySQL database:</p><ul><li>Automatic Mode: The system generates a connection string based on the provided credentials.</li><li>Manual Mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{sid} refers to the Database Name<br><strong>AuthenticationPlugins:</strong><br>com.azure.identity.extensions.jdbc.mysql.AzureMysqlAuthenticationPlugin<br>This is part of <strong>Azure Identity Extensions</strong> for MySQL, which allows connecting to Azure Database for MySQL using Azure AD authentication.</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>
{% endtab %}
{% endtabs %}

<table data-header-hidden><thead><tr><th width="184"></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><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><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><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.

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.

***

&#x20;Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA