Connect to and manage Db2 in Microsoft Purview

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

Supported capabilities

Metadata Extraction Full Scan Incremental Scan Scoped Scan Classification Labeling Access Policy Lineage Data Sharing Live view
Yes Yes No Yes No No No Yes No No

The supported IBM Db2 versions are Db2 for LUW 9.7 to 11.x. Db2 for z/OS (mainframe) and iSeries (AS/400) aren't supported now.

When scanning IBM Db2 source, Microsoft Purview supports:

  • Extracting technical metadata including:

    • Server
    • Databases
    • Schemas
    • Tables including the columns, foreign keys, indexes, and constraints
    • Views including the columns
    • Triggers
  • Fetching static lineage on assets relationships among tables and views.

You can scan an entire Db2 database, or scope the scan to a subset matching the given names or name patterns.

Known limitations

When object is deleted from the data source, currently the subsequent scan won't automatically remove the corresponding asset in Microsoft Purview.


  • An Azure account with an active subscription. Create an account for free.

  • An active Microsoft Purview account.

  • You need Data Source Administrator and Data Reader permissions to register a source and manage it in the Microsoft Purview governance portal. For more information about permissions, see Access control in Microsoft Purview.

  • Set up the latest self-hosted integration runtime. For more information, seeĀ the create and configure a self-hosted integration runtime guide. The minimal supported Self-hosted Integration Runtime version is 5.12.7984.1.

    • Ensure JDK 11 is installed on the machine where the self-hosted integration runtime is installed. Restart the machine after you newly install the JDK for it to take effect.

    • Ensure Visual C++ Redistributable (version Visual Studio 2012 Update 4 or newer) is installed on the self-hosted integration runtime machine. If you don't have this update installed, you can download it here.

    • Download the Db2 JDBC driver on the machine where your self-hosted integration runtime is running. Note down the folder path, which you'll use to set up the scan.


      The driver should be accessible by the self-hosted integration runtime. By default, self-hosted integration runtime uses local service account "NT SERVICE\DIAHostService". Make sure it has "Read and execute" and "List folder contents" permission to the driver folder.

  • The Db2 user must have the CONNECT permission. Microsoft Purview connects to the syscat tables in IBM Db2 environment when importing metadata.


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

Steps to register

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

  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 Db2. Select Continue.

On the Register sources (Db2) screen, do the following steps:

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

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

    • A host name used to connect to the database server. For example:
    • An IP address. For example:
  3. Enter the Port used to connect to the database server (446 by default for Db2).

  4. Select a collection from the list.

  5. Finish to register the data source.

    register sources options


Follow the steps to scan Db2 to automatically identify assets. For more information about scanning in general, see our introduction to scans and ingestion.

Authentication for a scan

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

Create and run scan

To create and run a new scan, follow these steps:

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

  4. Select + New scan.

  5. Provide the below details:

    1. Name: The name of the scan

    2. Connect via integration runtime: Select the configured self-hosted integration runtime

    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: The name of the database instance to import.

    5. Schema: List subset of schemas to import expressed as a semicolon separated list. For example, schema1;schema2. All user schemas are imported if that list is empty. All system schemas (for example, SysAdmin) and objects are ignored by default.

      Acceptable schema name patterns can be static names or contain wildcard %. 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.

    6. Driver location: Specify the path to the JDBC driver location in your machine where self-host integration runtime is running, for example, D:\Drivers\Db2. It's the path to valid JAR folder location. The value must be a valid absolute file path and does not contain space. Make sure the driver is accessible by the self-hosted integration runtime, learn more from prerequisites section.

    7. Maximum memory available: Maximum memory (in GB) available on customer's VM to be used by scanning processes. The memory needed is dependent on the size of Db2 source to be scanned.


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

      scan Db2

  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:

  1. Go to the Microsoft Purview governance portal. On the left pane, select Data map.
  2. Select the data source. You can view a list of existing scans on that data source under Recent scans, or you can view all scans on the Scans tab.
  3. Select the scan that has results you want to view. The pane shows you all the previous scan runs, along with the status and metrics for each scan run.
  4. Select the run ID to check the scan run details.

Manage your scans

To edit, cancel, or delete a scan:

  1. Go to the Microsoft Purview governance portal. On the left pane, select Data Map.

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

  3. Select the scan that you want to manage. You can then:

    • Edit the scan by selecting Edit scan.
    • Cancel an in-progress scan by selecting Cancel scan run.
    • Delete your scan by selecting Delete scan.


  • 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 on the Schema tab of Microsoft Purview.


After scanning your Db2 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 Db2 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.