Configure Microsoft SQL Server as a Source

Overview

This article describes the steps needed to configure Microsoft SQL Server as a source in DvSum Data Catalog (DC). The same steps apply to configure a source in DvSum Data Quality (DQ) with only a slight variation.

Before setting up SQL as a source in DvSum, please ensure all prerequisites are completed. Refer to the article “Prerequisites and Permissions for DvSum Data Source Configuration.”

Step-by-Step Configuration Guide

1. Add a New Data Source

Navigate to Administration → Data Sources.
Click ⊕ Add Source.
Select Microsoft SQL Server.
Provide a name for the source and click Save.

2. Environment Assignment

If Environments are enabled in the application, users can assign the Data Source to an Environment (for example, Development, UAT, or Production) and associate it with a Logical Source.

Environment assignment helps organize Data Sources across different deployment stages, while Logical Sources represent the same business dataset across multiple environments. Together, they support environment-aware asset promotion and management.

To assign an Environment and Logical Source:

Open the Data Source details page --> Settings --> General.
Select the appropriate Environment.
Select or create a Logical Source, if applicable.
Save the changes.

For detailed information about configuring and managing Environments and Logical Sources, refer to the Environment Management article.

3. Configure Connection

Once the source is saved, the connection settings detail page appears.

Option 1: Connect Using DvSum Web Service (Recommended)

Whitelist the DvSum application by IP address as indicated in the settings.
Enter the required connection details:
1. Host: SQL Server hostname or IP.
2. Port: Default is 1433 unless changed.
3. Instance Name: (if applicable).
4. Authentication Type: The method used to verify credentials and establish a secure connection to the data source.

Tenant Id: The unique identifier of your Microsoft Entra ID tenant.
Client Id: The unique identifier for the application registered in your Azure portal to access OneLake.
Client Secret: The secret key generated in your Azure portal to authenticate the application and authorize access to OneLake.

5. DB Login & Password: Use SQL Authentication credentials.

6. Click Authenticate to verify credentials.

Option 2: Connect Using DvSum Edge Gateway (For On-Premises SQL Server)

Install install a DvSum Edge Gateway behind the firewall.
Connect to SQL Server using the installed web service.
Authenticate the source.

Note: In SQL authentication type, both Lakehouse and Warehouse schemas are visible, functioning as mini Lakehouse and Warehouse sources within a SQL source.

4. Select Database & Schemas

Once authenticated:

Choose the Database from the available list.
(Optional) Limit the scan to specific schemas by selecting them.
Click Done (top-right corner) and then Save.

Note: When adding or editing a Data Source, if incorrect details or invalid credentials are entered, it will still allows to save the Data Source. However, authentication will fail, and the Data Source will be marked as unusable with a red icon. The Data Source will not be usable until the correct credentials are provided.

The connection is saved, but it cannot be used until valid authentication details are updated.