This document outlines the integration with the Azure SQL Database connector, enabling streamlined metadata management through features such as crawling, profiling, querying, data preview, and lineage building (both automatic and manual). It also supports impact analysis and ensures secure authentication via Credential Manager.
Overview
Connector Details
|
Connector Category |
RDBMS |
|
Connector Version |
6.3.x |
|
Releases Supported (Available from) |
- |
|
Connectivity [How the connection is established with Azure SQL Database] |
JDBC driver |
|
Verified Azure SQL Database Version |
Above SQL Server 2005 |
Note: The Azure SQL Database connector has been validated with the mentioned "Verified Azure SQL Database Versions" and is expected to be compatible with other supported Azure SQL Database versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.
Connector Features
|
Feature |
Availability |
|
|
✅ |
|
|
✅ |
|
|
✅ |
|
|
✅ |
|
|
✅ |
|
|
✅ |
|
|
✅ |
|
|
✅ |
|
|
❌ |
|
|
✅ |
|
Metadata Mapping
The following objects are crawled from Azure SQL Database and mapped to the corresponding UI assets.
|
Azure SQL Object |
Azure SQL Attribute |
OvalEdge Attribute |
OvalEdge Category |
OvalEdge Type |
|
Schema |
s.name |
Schema |
Schemas |
- |
|
Table |
Table Name |
Table |
Tables |
Table |
|
Table Data Type |
Table |
Tables |
Table |
|
|
Table Comments |
Source Description |
Descriptions |
Source Description |
|
|
Columns |
Column Name |
Column |
Table Columns |
- |
|
Data Type |
Column Type |
Table Columns |
- |
|
|
Description |
Source Description |
Table Columns |
- |
|
|
Ordinal Position |
Column Position |
Table Columns |
- |
|
|
Length |
Data Type Size |
Table Columns |
- |
|
|
Views |
View Name |
View |
Tables |
View |
|
text |
View Query |
Views |
View |
|
|
Procedures |
ROUTINE_NAME |
Name |
Procedures |
- |
|
DESCRIPTION |
Source Description |
Descriptions |
- |
|
|
ROUTINE_DEFINITION |
Procedure |
Procedures |
- |
|
|
Functions |
ROUTINE_NAME |
Name |
Functions |
- |
|
ROUTINE_DEFINITION |
Function |
Functions |
- |
|
|
DESCRIPTION |
Source Description |
Descriptions |
- |
|
|
Triggers |
Trigger Name |
Name |
Triggers |
- |
|
Trigger Definition |
Trigger Data |
Triggers |
- |
|
|
Trigger Type |
Type |
Triggers |
- |
Set up a Connection
Prerequisites
The following are the prerequisites to establish a connection:
External Supporting Files
|
File Name |
Download Link |
Description |
|
JTDS - 1.3.1 |
Link |
Use this file when connecting to Azure SQL Database using the jTDS 1.3.1 driver. Place the file in the Third Party Jars folder. |
Important: The supporting file is required to enable connectivity with Azure SQL Database using the jTDS 1.3.1 driver. Use this file according to the installation environment.
Whitelisting Ports
Make sure that inbound port “1433” is whitelisted to enable successful connectivity with the Azure SQL database.
Important: The default port number for Azure SQL database is 1433. If a different port is used, ensure that the updated port number is specified during connection setup, the port is whitelisted, and communication between the system and Azure SQL database is properly established.
Service Account User Permissions
Important: It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
Note: 👨💻 Who can provide these permissions? These permissions are typically granted by the Azure SQL database administrator, as users may not have the required access to assign them independently.
|
Objects |
Access Permission |
|
Schemas |
SELECT |
|
Tables |
SELECT |
|
Table Columns |
SELECT |
|
Views |
SELECT |
|
Functions |
SELECT |
|
Stored Procedures |
SELECT |
|
Triggers |
SELECT |
|
Synonyms |
SELECT |
|
Relationships |
SELECT |
Connection Configuration Steps
Important: Users are required to have the Connector Creator role in order to configure a new connection.
Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Azure SQL Database, and complete the required parameters.
Note: Fields marked with an asterisk (*) are mandatory for establishing a connection.
|
Field Name |
Description |
||||||
|
Connector Type |
By default, "Azure SQL Database" is displayed as the selected connector type. |
||||||
|
Connector Settings |
|||||||
|
Authentication |
The following three types of authentication are supported for Azure SQL Database:
|
||||||
|
Credential Manager* |
Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection. Supported Credential Managers:
|
||||||
|
License Add Ons |
|
||||||
|
Connector Name* |
Enter a unique name for the Azure SQL Database connection (Example: "AzureSQLDatabase_Prod"). |
||||||
|
Connector Environment |
Select the environment (Example: PROD, STG) configured for the connector. |
||||||
|
Server* |
Enter the Azure SQL database server name or IP address (Example: xxxx-sxxxxxx.xxxx4ijtzasl.xx-south-1.rxs.xxxxx.com or 1xx.xxx.1.xx). |
||||||
|
Port* |
By default, the port number for the Azure SQL Database, "1433" is auto-populated. If required, the port number can be modified as per custom port number that is configured for the Azure SQL Database. |
||||||
|
Database* |
Enter the database name to which the service account user has access within the Azure SQL Database. |
||||||
|
Domain |
If the authentication type is set to Windows Authentication, and the OvalEdge Application is installed on a Linux environment, enter the verified Azure SQL Database domain name. |
||||||
|
Driver* |
By default, the Azure SQL Database driver details are auto-populated. |
||||||
|
Username* |
Enter the service account username set up to access the Azure SQL database (Example: "oesauser"). |
||||||
|
Password* |
Enter the password associated with the service account user. |
||||||
|
Connection String |
Configure the connection string for the Azure SQL database:
Replace placeholders with actual database details. {sid} refers to Database Name |
||||||
|
Default Governance Roles |
|
|
Default Governance Roles* |
Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection. |
|
Admin Roles |
|
|
Admin Roles* |
Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in the security settings are available for selection. |
|
No of Archive Objects |
|
|
No Of Archive Objects* |
This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive. Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module. |
|
Bridge |
|
|
Select Bridge* |
If applicable, select the bridge from the drop-down list. The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules. |
- After entering all connection details, the following actions can be performed:
- Click Validate to verify the connection.
- Click Save to store the connection for future use.
- Click Save & Configure to apply additional settings before saving.
- The saved connection will appear on the Connectors home page.
Manage Connector Operations
Crawl/Profile
Important: To perform crawl and profile operations, users must be assigned the Integration Admin role.
The Crawl/Profile button allows users to select one or more schemas for crawling and profiling.
- Navigate to the Connectors page and click Crawl/Profile.
- Select the schemas to be crawled.
- The Crawl option is selected by default. To perform both operations, select the Crawl & Profile radio button.
- Click Run to collect metadata from the connected source and load it into the Data Catalog.
- After a successful crawl, the information appears in the Data Catalog > Databases tab.
The Schedule checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.
- Click the Schedule checkbox to enable the Select Period drop-down.
- Select a time period for the operation from the drop-down menu.
- Click Schedule to initiate metadata collection from the connected source.
- The system will automatically execute the selected operation (Crawl or Crawl & Profile) at the scheduled time.
Other Operations
The Connectors page provides a centralized view of all configured connectors, along with their health status.
Managing connectors includes:
- Connectors Health: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
- Viewing: Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.
Nine Dots Menu Options:
To view, edit, validate, build lineage, configure, or delete connectors, click on the Nine Dots menu.
- Edit Connector: Update and revalidate the data source.
- Validate Connector: Check the connection's integrity.
- Settings: Modify connector settings.
- Crawler: Configure data extraction.
- Profiler: Customize data profiling rules and methods.
- Query Policies: Define query execution rules based on roles.
- Access Instructions: Add notes on how data can be accessed.
- Business Glossary Settings: Manage term associations at the connector level.
- Anomaly Detection Settings: Configure anomaly detection preferences at the connector level.
- Others: Configure notification recipients for metadata changes.
- Build Lineage: Automatically build data lineage using source code parsing.
- Delete Connector: Remove a connector with confirmation.