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.
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.
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 that Visual C++ Redistributable (version Visual Studio 2012 Update 4 or newer) is installed on the machine where the self-hosted integration runtime is running. If you don't have this update installed, download it now.
Download the Db2 JDBC driver on the machine where your self-hosted integration runtime is running. Note down the folder path so you can use it to set up the scan.
To use a kubernetes supported self-hosted integration runtime:
Download the Db2 JDBC driver on the machine where your self-hosted integration runtime is running. Note down the folder path so you can use it to set up the scan.
Note
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.
On the Register sources (Db2) screen, do the following steps:
Enter a Name that the data source is within the Catalog.
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: MyDatabaseServer.com
An IP address. For example: 192.169.1.2
Enter the Port used to connect to the database server (446 by default for Db2).
Select a collection from the list.
Finish to register the data source.
Scan
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:
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 in prerequisites to create a self-hosted integration runtime.
Navigate to Sources.
Select the registered Db2 source.
Select + New scan.
Provide the below details:
Name: The name of the scan
Connect via integration runtime: Select the configured self-hosted integration runtime
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.
Database: The name of the database instance to import.
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.
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.
For Kubernetes-supported self-hosted integration runtime: ./drivers/Db2. It's the path to valid JAR folder location. The value must be a valid relative file path. Please refer to the documentation to set up a scan with external drivers for uploading drivers in advance.
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.
Note
As a thumb rule, please provide 1GB memory for every 1000 tables
Select Continue.
Choose your scan trigger. You can set up a schedule or ran the scan once.
Review your scan and select Save and Run.
View your scans and scan runs
To view existing scans:
Go to the Microsoft Purview portal. On the left pane, select Data map.
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.
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.
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 registered your source, follow the below guides to learn more about Microsoft Purview and your data.
Administer an SQL Server database infrastructure for cloud, on-premises and hybrid relational databases using the Microsoft PaaS relational database offerings.