Connect to and manage MySQL in Microsoft Purview (Preview)

This article outlines how to register MySQL, and how to authenticate and interact with MySQL in Microsoft Purview. For more information about Microsoft Purview, read the introductory article.

Important

This feature is currently in PREVIEW. The Supplemental Terms of Use for Microsoft Azure Previews include additional legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.

Supported capabilities

Metadata Extraction Full Scan Incremental Scan Scoped Scan Classification Access Policy Lineage
Yes Yes No Yes No No Yes

The supported MySQL server versions are 5.7 to 8.x.

When scanning MySQL source, Microsoft Purview supports:

  • Extracting technical metadata including:

    • Server
    • Databases
    • Tables including the columns
    • Views including the columns
  • Fetching static lineage on assets relationships among tables and views.

When setting up scan, you can choose to scan an entire MySQL server, or scope the scan to a subset of databases matching the given name(s) or name pattern(s).

Prerequisites

If your data store is not publicly accessible (if your data store limits access from on-premises network, private network or specific IPs, etc.) you need to configure a self-hosted integration runtime to connect to it:

Required permissions for scan

The MySQL user must have the SELECT, SHOW VIEW and EXECUTE permissions for each target MySQL schema that contains metadata.

Register

This section describes how to register MySQL in Microsoft Purview using the Microsoft Purview governance portal.

Steps to register

To register a new MySQL source in your data catalog, do the following:

  1. Navigate to your Microsoft Purview account in the Microsoft Purview governance portal.
  2. Select Data Map on the left navigation.
  3. Select Register
  4. On Register sources, select MySQL. Select Continue.

On the Register sources (MySQL) screen, do the following:

  1. Enter a Name that the data source will be listed within the Catalog.

  2. Enter the Server name to connect to a MySQL source. This can either be:

    • A host name used to connect to the database server. For example: MyDatabaseServer.com
    • An IP address. For example: 192.169.1.2
  3. Enter the Port used to connect to the database server (3306 by default for MySQL).

  4. Select a collection or create a new one (Optional)

  5. Finish to register the data source.

    register sources options

Scan

Follow the steps below to scan MySQL to automatically identify assets and classify your data. For more information about scanning in general, see our introduction to scans and ingestion.

Authentication for a scan

The supported authentication type for a MySQL source is Basic authentication.

Create and run scan

To create and run a new scan, do the following:

  1. In the Management Center, select Integration runtimes. Make sure a self-hosted integration runtime is set up. If it isn't set up, use the steps mentioned here to create a self-hosted integration runtime.

  2. Navigate to Sources.

  3. Select the registered MySQL source.

  4. Select + New scan.

  5. Provide the below details:

    1. Name: The name of the scan

    2. Connect via integration runtime: Select the Azure auto-resolved integration runtime or your configured self-hosted integration runtime used to perform scan.

    3. Credential: Select the credential to connect to your data source. Make sure to:

      • Select Basic Authentication while creating a credential.
      • Provide the user name used to connect to the database server in the User name input field.
      • Store the user password used to connect to the database server in the secret key.
    4. Database: List subset of databases to import expressed as a semicolon separated list. For example, database1; database2. All user databases are imported if the list is empty. All system databases (for example, SysAdmin) are ignored by default.

      Acceptable schema name patterns using SQL LIKE expressions syntax include using %. For example: A%; %B; %C%; D

      • Start with A or
      • End with B or
      • Contain C or
      • Equal D

      Usage of NOT and special characters aren't acceptable.

    5. Maximum memory available (applicable when using self-hosted integration runtime): Maximum memory (in GB) available on customer's VM to be used by scanning processes. This is dependent on the size of MySQL source to be scanned.

      Note

      As a rule of thumb, please provide 1GB memory for every 1000 tables

      scan MySQL

  6. Select Continue.

  7. Choose your scan trigger. You can set up a schedule or ran the scan once.

  8. Review your scan and select Save and Run.

View your scans and scan runs

To view existing scans, do the following:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab under the left pane.

  2. Select the desired data source. You will see a list of existing scans on that data source under Recent scans, or can view all scans under the Scans tab.

  3. Select the scan that has results you want to view.

  4. This page will show you all of the previous scan runs along with the status and metrics for each scan run. It will also display whether your scan was scheduled or manual, how many assets had classifications applied, how many total assets were discovered, the start and end time of the scan, and the total scan duration.

Manage your scans - edit, delete, or cancel

To manage or delete a scan, do the following:

  1. Go to the Microsoft Purview governance portal. Select the Data Map tab under the left pane.

  2. Select the desired data source. You will see a list of existing scans on that data source under Recent scans, or can view all scans under the Scans tab.

  3. Select the scan you would like to manage. You can edit the scan by selecting Edit scan.

  4. You can cancel an in progress scan by selecting Cancel scan run.

  5. You can delete your scan by selecting Delete scan.

Note

  • Deleting your scan does not delete catalog assets created from previous scans.
  • The asset will no longer be updated with schema changes if your source table has changed and you re-scan the source table after editing the description in the schema tab of Microsoft Purview.

Lineage

After scanning your MySQL source, you can browse data catalog or search data catalog to view the asset details.

Go to the asset -> lineage tab, you can see the asset relationship when applicable. Refer to the supported capabilities section on the supported MySQL lineage scenarios. For more information about lineage in general, see data lineage and lineage user guide.

Next steps

Now that you've registered your source, follow the below guides to learn more about Microsoft Purview and your data.