> ## Documentation Index
> Fetch the complete documentation index at: https://openmetadata-format-2-0-connector-overview-pages.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MySQL Connector | OpenMetadata Database Integration Guide

> Set up MySQL database connector for OpenMetadata to automatically discover, catalog, and manage your MySQL metadata. Step-by-step configuration guide.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/sql.webp" name="MySQL" stage="PROD" availableFeatures={["Metadata", "Data Profiler", "Data Quality", "dbt", "View Lineage", "View Column-level Lineage", "Query Usage", "Sample Data", "Auto-Classification", "Stored Procedures"]} unavailableFeatures={["Owners", "Tags"]} />

In this section, we provide guides and references to use the MySQL connector.
Configure and schedule MySQL metadata and profiler workflows from the OpenMetadata UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Data Profiler](/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow)
* [Data Quality](/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/quality)
* [dbt Integration](/v2.0.x-SNAPSHOT/connectors/database/dbt)
* [Enable Security](#securing-mysql-connection-with-ssl-in-openmetadata)
* [Data Lineage](/v2.0.x-SNAPSHOT/how-to-guides/data-lineage/workflow)
* [Troubleshooting](/v2.0.x-SNAPSHOT/connectors/database/mysql/troubleshooting)

## Requirements

Before configuring the MySQL connector, make sure the following requirements are in place.

### Metadata

OpenMetadata supports MySQL (version 8.0.42 or greater). The user must have access to the `INFORMATION_SCHEMA` table. By default, a user can see only the rows in the `INFORMATION_SCHEMA` that correspond to objects for which the user has the proper access privileges.

```SQL theme={null}
-- Create user. If <hostName> is omitted, defaults to '%'
-- More details https://dev.mysql.com/doc/refman/8.0/en/create-user.html
CREATE USER '<username>'[@'<hostName>'] IDENTIFIED BY '<password>';
-- Grant select on a database
GRANT SELECT ON world.* TO '<username>';
-- Grant select on a database
GRANT SELECT ON world.* TO '<username>';
-- Grant select on a specific object
GRANT SELECT ON world.hello TO '<username>';
-- Grant show view to extract ddl
GRANT SHOW VIEW ON world.* to '<username>';
```

### Lineage & Usage

To extract lineage & usage, enable query logging in MySQL. By default, OpenMetadata reads from `mysql.general_log`, so the connection user needs `SELECT` access on `mysql.general_log`. If you enable `useSlowLogs`, OpenMetadata reads from `mysql.slow_log` instead, so the same user needs `SELECT` access on `mysql.slow_log`.

```sql theme={null}
-- Enable general logs (default log source)
SET GLOBAL general_log='ON';
SET GLOBAL log_output='table';
GRANT SELECT ON mysql.general_log TO '<username>'@'<host>';

-- Optional: if using `useSlowLogs: true`
SET GLOBAL slow_query_log='ON';
SET GLOBAL log_output='table';
GRANT SELECT ON mysql.slow_log TO '<username>'@'<host>';
```

#### Log Table Management

The `mysql.general_log` table grows continuously as it stores query logs. This can consume significant storage space over time and affect the execution time of lineage and usage procedures.

* Note: We recommend cleaning up log tables only after successful execution of Usage & Lineage workflows to ensure no loss of query data during extraction. Once cleanup occurs, the query history is lost.
  Here are some important considerations and best practices:

### Create Manual Schedule to Rotate Logs

When you rotate log tables manually, the current log table is copied to a backup log table and the entries in the current log table are removed. If the backup log table already exists, then it is deleted before the current log table is copied to the backup. You can query the backup log table if needed. The backup log table for the `mysql.general_log` table is named `mysql.general_log_backup`.
The backup log table for the `mysql.slow_log` table is named `mysql.slow_log_backup`.

```sql theme={null}
-- rotate general logs
CREATE PROCEDURE rotate_general_log()
BEGIN
  -- Step 1: Drop the backup table if it exists
  DROP TABLE IF EXISTS mysql.general_log_backup;
  -- Step 2: Copy current general_log table to backup
  CREATE TABLE mysql.general_log_backup AS SELECT * FROM mysql.general_log;
  -- Step 3: Truncate the general_log table (clears all records)
  TRUNCATE TABLE mysql.general_log;
END;
-- call this procedure
CALL rotate_general_log();
-- rotate slow logs
CREATE PROCEDURE rotate_slow_log()
BEGIN
  DROP TABLE IF EXISTS mysql.slow_log_backup;
  CREATE TABLE mysql.slow_log_backup AS SELECT * FROM mysql.slow_log;
  TRUNCATE TABLE mysql.slow_log;
END
-- call this procedure
CALL rotate_slow_log();
```

You can also check table size by running the query below:

```sql theme={null}
SELECT table_name, round(data_length/1024/1024, 2) AS size_in_mb
FROM information_schema.tables
WHERE table_schema = 'mysql' AND table_name IN ('general_log', 'slow_log', 'general_log_backup', 'slow_log_backup');
```

### Create Automatic Event to Clear Older Logs

You can also create an automatic event like the one shown below, which runs every week to clear older logs.

```sql theme={null}
CREATE EVENT mysql.cleanup_general_log ON SCHEDULE EVERY 7 DAY DO DELETE FROM mysql.general_log WHERE event_time < NOW() - INTERVAL 7 DAY;
```

Note: If you are using RDS, you can rotate the `mysql.general_log` table manually by calling the `mysql.rds_rotate_general_log` procedure. You can rotate the `mysql.slow_log` table by calling the `mysql.rds_rotate_slow_log` procedure.
You can also check the docs below for more info on logs and their rotation methods:

* [Rotating mysql query logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/mysql-stored-proc-logging.html)
* [RDS for MySQL database logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.MySQL.LogFileSize.html#USER_LogAccess.MySQL.Generallog)
* [Aurora for MySQL database logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.MySQL.LogFileSize.html#USER_LogAccess.MySQL.Generallog)
  **Best Practices**:
* Monitor log table size regularly
* Implement a log rotation schedule
* Consider automating log cleanup after DAG execution
* Keep logging enabled only when needed for lineage extraction

### Profiler & Data Quality

Executing the profiler workflow or data quality tests will require the user to have `SELECT` permission on the tables/schemas where the profiler/tests will be executed. More information on the profiler workflow setup can be found [here](/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow) and data quality tests [here](/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/quality).

## Metadata Ingestion

To ingest metadata from MySQL, you need to create a service connection. The service connects MySQL with OpenMetadata. Once you create a service, OpenMetadata automatically starts ingesting metadata.

### Step 1: Add New Service

1. Navigate to **Settings** > **Services**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/access-services.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=1d8b1bddab7b8b43c20d4384be39e12a" alt="Navigate to Settings and Services" width="3004" height="1578" data-path="public/images/connector2.0/metadata-ingestion/access-services.png" />

2. Click **Add New Service**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=792f4403f83940c398633345505482a0" alt="Add New Service" width="3002" height="1514" data-path="public/images/connector2.0/metadata-ingestion/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **Database Services**, then click the **MySQL** connector tile.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/rMh-qzx9_4Qo0Q4e/public/images/connector2.0/metadata-ingestion/Database/select-service/mysql.png?fit=max&auto=format&n=rMh-qzx9_4Qo0Q4e&q=85&s=b6231595e5cb6a88a02b686aa8c90cf0" alt="Select Service" width="1900" height="900" data-path="public/images/connector2.0/metadata-ingestion/Database/select-service/mysql.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other MySQL services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/rMh-qzx9_4Qo0Q4e/public/images/connector2.0/metadata-ingestion/Database/service-name/mysql.png?fit=max&auto=format&n=rMh-qzx9_4Qo0Q4e&q=85&s=a2b28b9b5005207a2b00e45a383e1029" alt="Configure Service" width="1504" height="856" data-path="public/images/connector2.0/metadata-ingestion/Database/service-name/mysql.png" />

<Note>
  **Note**: The service name cannot be changed after it is set.
</Note>

### Step 4: Configure Connection Options

Specify your source credentials and verify the connection.

#### Enter Connection Details

Enter the connection details for MySQL. The right-hand panel in the UI displays inline help for each field.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/connection-details/mysql.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=a25c71fd7bebb232fe99ed02a84fad44" alt="Configure Service Connection" width="1450" height="1300" data-path="public/images/connector2.0/metadata-ingestion/Database/connection-details/mysql.png" />

* **Username**: Specify the User to connect to MySQL. It should have enough privileges to read all the metadata.
* **Auth Type**: Basic Auth, IAM based auth, or Azure auth.
  * **Basic Auth**:
    * **Password**: Password to connect to MySQL.
  * **IAM Based Auth**:

    * **AWS Access Key ID** & **AWS Secret Access Key**: When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have
      permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and
      authorize your requests ([docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)).
      Access keys consist of two parts: An **access key ID** (for example, `AKIAIOSFODNN7EXAMPLE`), and a **secret access key** (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
      You must use both the access key ID and secret access key together to authenticate your requests.
      You can find further information on how to manage your access keys [here](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
    * **AWS Region**: Each AWS Region is a separate geographic area in which AWS clusters data centers ([docs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)).
      As AWS can have instances in multiple regions, we need to know the region the service you want to reach belongs to.
      Note that the AWS Region is the only required parameter when configuring a connection. When connecting to the
      services programmatically, there are different ways in which we can extract and use the rest of AWS configurations.
      You can find further information about configuring your credentials [here](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials).
    * **AWS Session Token (optional)**: If you are using temporary credentials to access your services, you will need to inform the AWS Access Key ID
      and AWS Secrets Access Key. Also, these will include an AWS Session Token.
      You can find more information on [Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html).
    * **Endpoint URL (optional)**: To connect programmatically to an AWS service, you use an endpoint. An *endpoint* is the URL of the
      entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the
      default endpoint for each service in an AWS Region. But you can specify an alternate endpoint for your API requests.
      Find more information on [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html).
    * **Profile Name**: A named profile is a collection of settings and credentials that you can apply to a AWS CLI command.
      When you specify a profile to run a command, the settings and credentials are used to run that command.
      Multiple named profiles can be stored in the config and credentials files.
      You can inform this field if you'd like to use a profile other than `default`.
      Find here more information about [Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
    * **Assume Role Arn**: Typically, you use `AssumeRole` within your account or for cross-account access. In this field you'll set the
      `ARN` (Amazon Resource Name) of the policy of the other account.
      A user who wants to access a role in a different account must also have permissions that are delegated from the account
      administrator. The administrator must attach a policy that allows the user to call `AssumeRole` for the `ARN` of the role in the other account.
      This is a required field if you'd like to `AssumeRole`.
      Find more information on [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).

    <Tip>
      When using Assume Role authentication, ensure you provide the following details:

      * **AWS Region**: Specify the AWS region for your deployment.
    </Tip>

    * **Assume Role Session Name**: An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role
      is assumed by different principals or for different reasons.
      By default, we'll use the name `OpenMetadataSession`.
      Find more information about the [Role Session Name](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=An%20identifier%20for%20the%20assumed%20role%20session.).
    * **Assume Role Source Identity**: The source identity specified by the principal that is calling the `AssumeRole` operation. You can use source identity
      information in AWS CloudTrail logs to determine who took actions with a role.
      Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity).
  * **Azure Auth**:
    * **Scopes**: Required. Provide the scope or comma-separated scopes used to fetch the Azure access token, for example `https://ossrdbms-aad.database.windows.net/.default`.
    * **Client ID**, **Client Secret**, and **Tenant ID**: Optional when using a service principal. If you do not provide them, OpenMetadata falls back to `DefaultAzureCredential` from the runtime environment.
    * **Account Name** and **Vault Name**: Part of the shared Azure credentials schema, but not required for MySQL token-based authentication.
* **Host and Port**: Enter the fully qualified hostname and port number for your MySQL deployment in the Host and Port field.
* **databaseName**: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
* **databaseSchema**: databaseSchema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single databaseSchema. When left blank, OpenMetadata Ingestion attempts to scan all the databaseSchema.
* **caCertificate**: Provide the path to ssl ca file.
* **sslCertificate**: Provide the path to ssl client certificate file (ssl\_cert).
* **sslKey**: Provide the path to ssl client certificate file (ssl\_key).

#### Advanced Configuration

Database Services have an Advanced Configuration section, where you can pass extra arguments to the connector and, if needed, change the connection scheme. This would only be required to handle advanced connectivity scenarios or customizations.

* **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs.
* **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs.

#### Test Connection

Once the credentials have been added, click on **Test Connection** and **Save** the changes.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/2XRXwl2QkxBakIS8/public/images/connectors/test-connection.png?fit=max&auto=format&n=2XRXwl2QkxBakIS8&q=85&s=abe3b568c662295afc530c6c6819f9a5" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, use filter patterns to control which assets OpenMetadata ingests from your database service. Filter patterns use regular expressions applied to asset names.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated regular expressions. OpenMetadata ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated regular expressions. OpenMetadata skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When both Include and Exclude are set, Exclude takes priority.

<Tip>
  Leave all filter patterns empty to ingest all databases, schemas, and tables available in the source.
</Tip>

**Filter Options**

The Database, Schema, Table, and Stored Procedure sections each include the following filter options:

* **Database**: Controls which databases OpenMetadata ingests from the source.
* **Schema**: Controls which schemas within the ingested databases are included.
* **Table**: Controls which tables and views within the ingested schemas are included.
* **Stored Procedure**: Controls which stored procedures are included in metadata ingestion.

Each section provides the following controls:

* **Scan Mode**: You can choose between the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Exclude system toggle**: Use this toggle to automatically filter out system-reserved names defined by the connector, for example, **Exclude system databases** for the Databases section.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips. An asset is included if it matches any rule.

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. OpenMetadata saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts schemas, tables, columns, and other structural metadata from your source and keeps your OpenMetadata catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, OpenMetadata automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. Navigate to **Settings** > **Services** and select the service type.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/access-service-type.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=3c2d6613c061c17412ec5c800c0f3833" alt="Navigate to Settings and Services" width="2992" height="1612" data-path="public/images/connector2.0/metadata-ingestion/access-service-type.png" />

2. Click the service you have added.

3. Select the **Agents** tab and click **Add Agent** > **Metadata**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=9a59a29bca844f3035d14a7211574c57" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/connector2.0/metadata-ingestion/add-metadata-agent.png" />

   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=fa31ef8cb17d501983dd958c19e0c414" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/connector2.0/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure core parameters for metadata extraction. The following fields are available:

     | Field                                 | Default | Description                                                                                                              |
     | ------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
     | Default Owner                         | —       | Owner applied to all entities when no specific level owner is configured. Accepts a user or team name/email.             |
     | Service Owner                         | —       | Owner assigned to the service entity.                                                                                    |
     | Database Owner                        | —       | Owner assigned to all ingested databases. Accepts a single owner or a per-database name mapping.                         |
     | Database Schema Owner                 | —       | Owner assigned to all ingested schemas. Accepts a single owner or a per-schema name mapping.                             |
     | Table Owner                           | —       | Owner assigned to all ingested tables. Accepts a single owner or a per-table name mapping.                               |
     | Enable Inheritance                    | On      | When on, child entities inherit the owner from their parent when they have no owner configured.                          |
     | Query Log Duration                    | 1       | Number of days to look back in query logs when processing stored procedure results.                                      |
     | Query Parsing Timeout Limit           | 300     | Timeout in seconds for parsing a single query.                                                                           |
     | Number of Threads                     | 1       | Number of threads to use for parallel table ingestion.                                                                   |
     | Incremental Extraction                | Off     | When enabled, subsequent runs only extract entities changed since the last successful run.                               |
     | Successful Pipeline Run Lookback Days | 7       | Number of days to search back for a prior successful run to use as a baseline for incremental extraction.                |
     | Safety Margin Days                    | 1       | Additional days added to the baseline timestamp as a buffer for incremental extraction.                                  |
     | JSON Schema Sample Size               | 10      | Number of rows sampled to infer JSON column schema. Only applies when Extract JSON Schema is enabled in Advanced Config. |

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/database-agent-setup.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=393df3bce94f71184988e6c553aee4e0" alt="Agent Setup" width="1570" height="1396" data-path="public/images/connector2.0/metadata-ingestion/Database/database-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. For more information about various filter options, see **Step 6: Configure Ingestion Options**.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/database-filter-pattern.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=fe20668a777aaad09c9ffac681ee78bf" alt="Filter Patterns" width="1560" height="1030" data-path="public/images/connector2.0/metadata-ingestion/Database/database-filter-pattern.png" />

   * **Scope & Behaviour**: Control how the agent handles metadata during ingestion. Toggle each option on or off based on your needs:

     | Toggle                         | Default | Description                                                                                                                                                                      |
     | ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Include Tables                 | On      | Ingest table metadata from the source. Turn off to skip tables entirely.                                                                                                         |
     | Include Tags                   | On      | Ingest tags from the source.                                                                                                                                                     |
     | Include Stored Procedures      | On      | Ingest stored procedure metadata.                                                                                                                                                |
     | Include DDL Statements         | Off     | Ingest DDL statements alongside table metadata.                                                                                                                                  |
     | Include Owners                 | Off     | Assign owners to ingested entities when the source owner's email matches a user in OpenMetadata. Does not overwrite an existing owner.                                           |
     | Include Custom Properties      | Off     | Ingest connector-specific custom properties onto entities.                                                                                                                       |
     | Mark Deleted Tables            | On      | Soft-delete tables in OpenMetadata when they are removed from the source. Applies only within the currently ingested schema.                                                     |
     | Mark Deleted Stored Procedures | On      | Soft-delete stored procedures in OpenMetadata when they are removed from the source.                                                                                             |
     | Mark Deleted Schemas           | Off     | Soft-delete schemas and all their child assets when removed from the source.                                                                                                     |
     | Mark Deleted Databases         | Off     | Soft-delete databases and all their child assets when removed from the source.                                                                                                   |
     | Override Metadata              | Off     | When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value. |
     | Enable Debug Log               | Off     | Sets the ingestion log level to DEBUG. Useful for troubleshooting.                                                                                                               |

     <Note>
       Available toggles vary by connector. Stored procedure options only appear for connectors that support stored procedures.
     </Note>

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/database-scope-behaviour.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=afc838a9f9c231e745c75fa1a23e2d50" alt="Scope & Behaviour" width="1566" height="1436" data-path="public/images/connector2.0/metadata-ingestion/Database/database-scope-behaviour.png" />

   * **Advanced Config**: Optional connector-specific settings such as Include Views and Extract JSON Schema.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Database/database-advance.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=a6026536873e21919d5be32198a74188" alt="Advanced Config" width="1564" height="352" data-path="public/images/connector2.0/metadata-ingestion/Database/database-advance.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule; trigger the agent manually when needed.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/wI1VkO40X1vdRc0T/public/images/connectors/schedule.png?fit=max&auto=format&n=wI1VkO40X1vdRc0T&q=85&s=14df1dfeef735efd1ad9fb45da8a7352" alt="Schedule Interval" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />

6. Click **Add** to deploy the agent.

## Securing MySQL Connection with SSL in OpenMetadata

To establish secure connections between OpenMetadata and MySQL, navigate to the `Advanced Config` section. Here, you can provide the CA certificate used for SSL validation by specifying the `caCertificate`. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: `ssl_key`, `ssl_cert`, and `ssl_ca`. In this case, `ssl_cert` is used for the client's SSL certificate, `ssl_key` for the private key associated with the SSL certificate, and `ssl_ca` for the CA certificate to validate the server's certificate.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/wI1VkO40X1vdRc0T/public/images/connectors/ssl_connection.png?fit=max&auto=format&n=wI1VkO40X1vdRc0T&q=85&s=643eab9e61af5daf325256508ee2d9d1" alt="SSL Configuration" height="450px" data-path="public/images/connectors/ssl_connection.png" />

## Related

<Columns cols={2}>
  <Card title="Usage Workflow" href="/v2.0.x-SNAPSHOT/connectors/ingestion/workflows/usage">
    Learn more about how to configure the Usage Workflow to ingest Query information from the UI.
  </Card>

  <Card title="Lineage Workflow" href="/v2.0.x-SNAPSHOT/connectors/ingestion/workflows/lineage">
    Learn more about how to configure the Lineage from the UI.
  </Card>

  <Card title="Profiler Workflow" href="/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow">
    Learn more about how to configure the Data Profiler from the UI.
  </Card>

  <Card title="Data Quality Workflow" href="/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/configure">
    Learn more about how to configure the Data Quality tests from the UI.
  </Card>

  <Card title="dbt Integration" href="/v2.0.x-SNAPSHOT/connectors/database/dbt">
    Learn more about how to ingest dbt models' definitions and their lineage.
  </Card>
</Columns>