> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# MySQL Hybrid Runner | Collate Database Integration Guide

> Set up MySQL database connector for Collate using the Hybrid Runner deployment. Deploy the ingestion agent in your environment for secure, private network metadata extraction.

export const MetadataIngestionUi = ({connector, selectServicePath, addNewServicePath, serviceConnectionPath}) => {
  return <>
   <p>
      To ingest metadata from your sources, you need to create a service connection.
      The service connects your source system with Collate. Once you create
      a service, you can use it to configure your ingestion workflows.<br />
      <br />
      To create a service connection and ingest your metadata, follow the steps below:
  </p>
  <Steps>
    <Step title="Select the Service">
    <ol>
          <li>
            On the left navigation bar, click <strong>Settings</strong>.
          </li>
          <li>
            On the next page, click <strong>Services</strong>, and then select the service.
            <img src="/public/images/connectors/visit-services-page.png" alt="Visit Services Page" />
          </li>
    </ol>
   </Step>


   <Step title="Create a New Service">
      
       To add a new service connection, click <strong>Add New Service</strong>.
      <img src="/public/images/connectors/create-new-service.png" alt="Create a new Service" />


   </Step>


     <Step title="Select the Connector">
       Select <strong>{connector}</strong> as the service type and click <strong>Next</strong>.


       {selectServicePath && <img src={selectServicePath} alt="Select Service" />}
   </Step>


   <Step title="Name and Describe your Service">
       Enter a unique, descriptive <strong>Service Name</strong> and <strong>Description</strong>.
       <ul>
         <li><strong>Service Name</strong>: Collate identifies services by their service name. Enter a name that distinguishes this deployment from other services, including other {connector} services you are ingesting metadata from.</li>
       </ul>


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


       {addNewServicePath && <img src={addNewServicePath} alt="Add New Service" />}
   </Step>


   <Step title="Configure the Service Connection">
       Set up the connection settings required for {connector}. <br /><br />
      
       Configure the following connection options to set up the service and start ingesting metadata from your sources. The right-hand panel displays help documentation for the selected connection type in the product UI

       {serviceConnectionPath && <img src={serviceConnectionPath} alt="Configure Service connection" />}
   </Step>
   </Steps>
   </>;
};

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", "Reverse Metadata (Collate Only)", "Auto-Classification"]} unavailableFeatures={["Owners", "Tags", "Stored Procedures"]} />

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](/how-to-guides/data-quality-observability/profiler/profiler-workflow)
* [Data Quality](/how-to-guides/data-quality-observability/quality)
* [dbt Integration](/connectors/database/dbt)
* [Enable Security](#securing-mysql-connection-with-ssl-in-openmetadata)
* [Data Lineage](/how-to-guides/data-lineage/workflow)
* [Troubleshooting](/connectors/database/mysql/troubleshooting)
* [Reverse Metadata](#reverse-metadata)

## Requirements

### Metadata

Note that We support MySQL (version 8.0.42 or greater) and the user should 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>';
```

### Aurora MySQL IAM Authentication

<Tip>
  For Aurora MySQL IAM authentication, enable **IAM DB authentication** in your RDS cluster settings and use the same **cluster endpoint** you will configure in OpenMetadata.
</Tip>

1. Connect as an admin user with password authentication and create (or validate) the IAM DB user:

```sql theme={null}
CREATE USER 'openmetadata_iam'@'%' IDENTIFIED WITH AWSAuthenticationPlugin AS 'RDS';
SHOW CREATE USER 'openmetadata_iam'@'%';
```

2. Grant minimum metadata permissions and verify:

```sql theme={null}
GRANT SELECT, PROCESS, SHOW DATABASES, SHOW VIEW ON *.* TO 'openmetadata_iam'@'%';
FLUSH PRIVILEGES;
SHOW GRANTS FOR 'openmetadata_iam'@'%';
```

3. Attach the IAM policy to the AWS principal used by ingestion:

* Policy action must include `rds-db:connect`.
* Resource must be exactly:
  `arn:aws:rds-db:<aws_region>:<aws_account_number>:dbuser:<rds_db_resource_id>/openmetadata_iam`
* If ingestion runs on EC2/ECS/EKS, attach the policy to that runtime role.
* If ingestion runs locally, attach the policy to the IAM user/profile generating auth tokens.

4. Validate IAM login from the same host that runs ingestion:

```bash theme={null}
curl -o global-bundle.pem https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem
TOKEN="$(aws rds generate-db-auth-token --hostname <cluster-endpoint> --port 3306 --region <aws_region> --username openmetadata_iam)"
mysql -h <cluster-endpoint> -P 3306 --ssl-ca=global-bundle.pem -u openmetadata_iam -p"$TOKEN"
```

### Lineage & Usage

To extract lineage & usage you need to enable the query logging in mysql and the user used in the connection needs to have select access to the `mysql.general_log`.

```sql theme={null}
-- Enable Logging
SET GLOBAL general_log='ON';
set GLOBAL log_output='table';
-- Grant SELECT on log table
GRANT SELECT ON mysql.general_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 below query

```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 automatic event like showed 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 then 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 below docs about more info on logs & its 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](/how-to-guides/data-quality-observability/profiler/profiler-workflow) and data quality tests [here](/how-to-guides/data-quality-observability/quality).

## Metadata Ingestion

<MetadataIngestionUi connector={"MySQL"} selectServicePath={"/public/images/connectors/mysql/select-service.png"} addNewServicePath={"/public/images/connectors/mysql/add-new-service.png"} serviceConnectionPath={"/public/images/connectors/mysql/service-connection.png"} />

## Connection Details

<Steps>
  <Step title="Connection Details">
    * **Username**: Specify the User to connect to MySQL. It should have enough privileges to read all the metadata.
    * **Auth Type**: Basic Auth or IAM based auth to connect to instances / cloud rds.

          <Tip>
            For Aurora MySQL IAM in OpenMetadata, use:

            * **Username**: `openmetadata_iam`
            * **Auth Type**: `IAM`
            * **AWS Region**: `<aws_region>` (for example, `us-east-2`)
            * **Host and Port**: `<cluster-endpoint>:3306` (use cluster endpoint)
          </Tip>

      * **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 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).
    * **IAM Policy Requirement**: The principal used by ingestion must have `rds-db:connect` permission with the exact DB user resource ARN:
      `arn:aws:rds-db:<aws_region>:<aws_account_number>:dbuser:<rds_db_resource_id>/openmetadata_iam`.
    * **Credentials Source**:
      * If ingestion runs on EC2/ECS/EKS, prefer runtime role credentials.
      * If ingestion runs locally, configure IAM user/profile credentials.
      * You can also provide AWS Access Key ID + AWS Secret Access Key + optional AWS Session Token.
      * If needed, use Assume Role (Assume Role Arn, Assume Role Session Name, optional Source Identity).
    * **Host and Port**: Use the Aurora **cluster endpoint** and port `3306` that ingestion will use.
    * **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 CA bundle path used by ingestion runtime (for example, `global-bundle.pem`).
    * **sslCertificate**: Provide the path to ssl client certificate file (ssl\_cert).
    * **sslKey**: Provide the path to ssl client certificate file (ssl\_key).
  </Step>

  <Step title="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.

          <img src="https://mintcdn.com/collatedocs/lyQrThlmh8cYozqe/public/images/connectors/advanced-configuration.png?fit=max&auto=format&n=lyQrThlmh8cYozqe&q=85&s=5c8159f3c92aa4501c116c5f4f2139ae" alt="Advanced Configuration" width="1398" height="534" data-path="public/images/connectors/advanced-configuration.png" />
  </Step>

  <Step title="Test the Connection">
    Once the credentials have been added, click on *Test Connection* and *Save* the changes.

    <img src="https://mintcdn.com/collatedocs/L7psA65ao88vmcRI/public/images/connectors/test-connection.png?fit=max&auto=format&n=L7psA65ao88vmcRI&q=85&s=2133f0d65f18df1e57f69d2cc3bdeff4" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />
  </Step>

  <Step title="Configure Metadata Ingestion">
    In this step we will configure the metadata ingestion pipeline,
    Please follow the instructions below

    <img src="https://mintcdn.com/collatedocs/12mtkhFtvTP7FUxZ/public/images/connectors/configure-metadata-ingestion-database-1.png?fit=max&auto=format&n=12mtkhFtvTP7FUxZ&q=85&s=43bd09ba1eeee6f5c7a8100fbcac9f65" alt="Configure Metadata Ingestion" width="1327" height="1271" data-path="public/images/connectors/configure-metadata-ingestion-database-1.png" />

    <img src="https://mintcdn.com/collatedocs/12mtkhFtvTP7FUxZ/public/images/connectors/configure-metadata-ingestion-database-2.png?fit=max&auto=format&n=12mtkhFtvTP7FUxZ&q=85&s=4a62a34c638864218a356c7371851761" alt="Configure Metadata Ingestion" width="1327" height="1271" data-path="public/images/connectors/configure-metadata-ingestion-database-2.png" />

    #### Metadata Ingestion Options

    <Tip>
      If the owner's name is openmetadata, you need to enter `openmetadata@domain.com` in the name section of add team/user form, click [here](/connectors/database/dbt/ingest-dbt-owner#following-steps-shows-adding-a-user-to-openmetadata) for more info.
    </Tip>

    * **Name**: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.

    * **Database Filter Pattern (Optional)**: Use to database filter patterns to control whether or not to include database as part of metadata ingestion.
      * **Include**: Explicitly include databases by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all databases with names matching one or more of the supplied regular expressions. All other databases will be excluded.
      * **Exclude**: Explicitly exclude databases by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all databases with names matching one or more of the supplied regular expressions. All other databases will be included.

    * **Schema Filter Pattern (Optional)**: Use to schema filter patterns to control whether to include schemas as part of metadata ingestion.
      * **Include**: Explicitly include schemas by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all schemas with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
      * **Exclude**: Explicitly exclude schemas by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all schemas with names matching one or more of the supplied regular expressions. All other schemas will be included.

    * **Table Filter Pattern (Optional)**: Use to table filter patterns to control whether to include tables as part of metadata ingestion.
      * **Include**: Explicitly include tables by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all tables with names matching one or more of the supplied regular expressions. All other tables will be excluded.
      * **Exclude**: Explicitly exclude tables by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all tables with names matching one or more of the supplied regular expressions. All other tables will be included.

    * **Enable Debug Log (toggle)**: Set the Enable Debug Log toggle to set the default log level to debug.

    * **Mark Deleted Tables (toggle)**: Set the Mark Deleted Tables toggle to flag tables as soft-deleted if they are not present anymore in the source system.

    * **Mark Deleted Tables from Filter Only (toggle)**: Set the Mark Deleted Tables from Filter Only toggle to flag tables as soft-deleted if they are not present anymore within the filtered schema or database only. This flag is useful when you have more than one ingestion pipelines. For example if you have a schema

    * **includeTables (toggle)**: Optional configuration to turn off fetching metadata for tables.

    * **includeViews (toggle)**: Set the Include views toggle to control whether to include views as part of metadata ingestion.

    * **includeTags (toggle)**: Set the 'Include Tags' toggle to control whether to include tags as part of metadata ingestion.

    * **includeOwners (toggle)**: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.

    * **includeStoredProcedures (toggle)**: Optional configuration to toggle the Stored Procedures ingestion.

    * **includeDDL (toggle)**: Optional configuration to toggle the DDL Statements ingestion.

    * **queryLogDuration (Optional)**: Configuration to tune how far we want to look back in query logs to process Stored Procedures results.

    * **queryParsingTimeoutLimit (Optional)**: Configuration to set the timeout for parsing the query in seconds.

    * **useFqnForFiltering (toggle)**: Regex will be applied on fully qualified name (e.g service\_name.db\_name.schema\_name.table\_name) instead of raw name (e.g. table\_name).

    * **Incremental (Beta)**: Use Incremental Metadata Extraction after the first execution. This is done by getting the changed tables instead of all of them. **Only Available for BigQuery, Redshift and Snowflake**
      * **Enabled**: If `True`, enables Metadata Extraction to be Incremental.
      * **lookback Days**: Number of days to search back for a successful pipeline run. The timestamp of the last found successful pipeline run will be used as a base to search for updated entities.
      * **Safety Margin Days**: Number of days to add to the last successful pipeline run timestamp to search for updated entities.

    * **Threads (Beta)**: Use a Multithread approach for Metadata Extraction. You can define here the number of threads you would like to run concurrently.

    Note that the right-hand side panel in the Collate UI will also share useful documentation when configuring the ingestion.
  </Step>

  <Step title="Schedule the Ingestion and Deploy">
    Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The
    timezone is in UTC. Select a Start Date to schedule for ingestion. It is
    optional to add an End Date.

    Review your configuration settings. If they match what you intended,
    click Deploy to create the service and schedule metadata ingestion.

    If something doesn't look right, click the Back button to return to the
    appropriate step and change the settings as needed.

    After configuring the workflow, you can click on Deploy to create the
    pipeline.

    <img src="https://mintcdn.com/collatedocs/piJyXg9wW6Ik1lg-/public/images/connectors/schedule.png?fit=max&auto=format&n=piJyXg9wW6Ik1lg-&q=85&s=f1add591824b44456f0e2ff259a21c6f" alt="Schedule the Workflow" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />
  </Step>

  <Step title="View the Ingestion Pipeline">
    Once the workflow has been successfully deployed, you can view the
    Ingestion Pipeline running from the Service Page.

    <img src="https://mintcdn.com/collatedocs/cOe_QuHYxAbkMtTI/public/images/connectors/view-ingestion-pipeline.png?fit=max&auto=format&n=cOe_QuHYxAbkMtTI&q=85&s=8c754af74f99ee70e714f6f707b827e4" alt="View Ingestion Pipeline" width="2733" height="1271" data-path="public/images/connectors/view-ingestion-pipeline.png" />

    <Tip>
      If [AutoPilot](/how-to-guides/admin-guide/applications/autopilot) is enabled, workflows like usage tracking, data lineage, and similar tasks will be handled automatically. Users don’t need to set up or manage them - AutoPilot takes care of everything in the system.
    </Tip>
  </Step>
</Steps>

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

When using IAM auth with Aurora MySQL, ensure TLS is enabled and the CA file path is valid in the same runtime where ingestion executes. If you run ingestion in Docker or Kubernetes, mount the CA bundle into the container and configure the container path (not a laptop path).

```yaml theme={null}
connectionArguments:
  ssl:
    ca: /path/in/runtime/global-bundle.pem
```

<img src="https://mintcdn.com/collatedocs/qybQN_VCNOUNg9nn/public/images/connectors/ssl_connection.png?fit=max&auto=format&n=qybQN_VCNOUNg9nn&q=85&s=e90fd6e04057c3481ac6ca1987423a30" alt="SSL Configuration" height="450px" data-path="public/images/connectors/ssl_connection.png" />

## Reverse Metadata

<Step title="Reverse Metadata">
  ### Description Management

  MySQL supports description updates at the following level:

  * Table level

  ### Owner Management

  Owner management is not supported for MySQL.

  ### Tag Management

  ❌ Tag management is not supported for MySQL.

  ### Custom SQL Template

  MySQL supports custom SQL templates for metadata changes. The template is interpreted using python f-strings.

  Here are examples of custom SQL queries for metadata changes:

  ```sql theme={null}
  -- Update table description
  ALTER TABLE {schema}.{table} COMMENT = {description};
  ```

  The list of variables for custom SQL can be found [here](/how-to-guides/admin-guide/applications/reverse-metadata#custom-sql-template).

  For more details about reverse metadata ingestion, visit our [Reverse Metadata Documentation](/how-to-guides/admin-guide/applications/reverse-metadata).

  ### Requirements for Reverse Metadata

  In addition to the basic ingestion requirements, for reverse metadata ingestion the user needs:

  * \`
</Step>

<Tip>
  When using a **Hybrid Ingestion Runner**, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format:

  ```
  password: secret:/my/database/password
  ```

  This applies **only to fields marked as secrets** in the connection form (these typically mask input and show a visibility toggle icon).
  For a complete guide on managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
</Tip>

## Troubleshooting

<Columns cols={2}>
  <Card title="MySQL Troubleshooting" href="/connectors/database/mysql/troubleshooting">
    Learn more about how to troubleshoot common MySQL connector issues and resolve configuration or ingestion errors.
  </Card>
</Columns>

## Related

<Columns cols={2}>
  <Card title="Usage Workflow" href="/how-to-guides/guide-for-data-users/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="/how-to-guides/guide-for-data-users/ingestion/workflows/lineage">
    Learn more about how to configure the Lineage from the UI.
  </Card>

  <Card title="Profiler Workflow" href="/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="/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="/connectors/database/dbt">
    Learn more about how to ingest dbt models' definitions and their lineage.
  </Card>
</Columns>