Connect to and manage PostgreSQL in Microsoft Purview
This article outlines how to register PostgreSQL, and how to authenticate and interact with PostgreSQL in Microsoft Purview. For more information about Microsoft Purview, read the introductory article.
|Metadata Extraction||Full Scan||Incremental Scan||Scoped Scan||Classification||Labeling||Access Policy||Lineage||Data Sharing||Live view|
The supported PostgreSQL server versions are 8.4 to 12.x.
When scanning PostgreSQL source, Microsoft Purview supports:
Extracting technical metadata including:
- 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 PostgreSQL database, or scope the scan to a subset of schemas matching the given name(s) or name pattern(s).
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.
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 will need to configure a self hosted integration runtime to connect to it.
- If your data store isn't publicly accessible, set up the latest self-hosted integration runtime. For more information, see the create and configure a self-hosted integration runtime guide.
- 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.
Required permissions for scan
The PostgreSQL user must have read access to system tables in order to access advanced metadata.
This section describes how to register PostgreSQL in Microsoft Purview using the Microsoft Purview governance portal.
Steps to register
To register a new PostgreSQL source in your data catalog, follow these steps:
- Navigate to your Microsoft Purview account in the Microsoft Purview governance portal.
- Select Data Map on the left navigation.
- Select Register
- On Register sources, select PostgreSQL. Select Continue.
On the Register sources (PostgreSQL) screen, follow these steps:
Enter a Name that the data source will be listed within the Catalog.
Enter the Server name to connect to a PostgreSQL source. This can either be:
- A host name used to connect to the database server. For example:
- An IP address. For example:
- A host name used to connect to the database server. For example:
Enter the Port used to connect to the database server (5432 by default for PostgreSQL).
Select a collection or create a new one (Optional)
Finish to register the data source.
Follow the steps below to scan PostgreSQL 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 PostgreSQL source is Basic authentication.
Create and run scan
To create and run a new scan, follow these steps:
If your server is publicly accessible, skip to step two. Otherwise, you'll need to make sure your self-hosted integration runtime is configured:
In the Microsoft Purview governance portal, navigate to Sources.
Select the registered PostgreSQL source.
Select + New scan.
Provide the below details:
Name: The name of the scan
Connect via integration runtime: Select the Azure auto-resolved integration runtime if your server is publicly accessible, or your configured self-hosted integration runtime if it isn't publicly available.
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： Specify 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 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.
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 PostgreSQL source to be scanned.
As a rule of thumb, please provide 1GB memory for every 1000 tables
Select Test connection to validate the settings (available when using Azure Integration Runtime).
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 governance 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.
- Select the run ID to check the scan run details.
Manage your scans
To edit, cancel, or delete a scan:
Go to the Microsoft Purview governance 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 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.
Go to the asset -> lineage tab, you can see the asset relationship when applicable. Refer to the supported capabilities section on the supported PostgreSQL lineage scenarios. For more information about lineage in general, see data lineage and lineage user guide.
Now that you've registered your source, follow the below guides to learn more about Microsoft Purview and your data.