AzureSQL

Configure and schedule AzureSQL metadata, usage, and profiler workflows from the OpenMetadata UI.
​Requirements​
​Metadata Ingestion​
​Query Usage and Lineage Ingestion​
​Data Profiler and Quality Tests​
​DBT Integration​
If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to connect using Airflow SDK or with the CLI.
Run AzureSQL Connector with the Airflow SDK
Run AzureSQL Connector with the CLI
Requirements
OpenMetadata (version 0.10 or later)
To deploy OpenMetadata, follow the procedure Try OpenMetadata in Docker.
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.
Metadata Ingestion
1. Visit the Services Page
The first step is ingesting the metadata from your sources. Under Settings you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.
To visit the Services page, select Services from the Settings menu.
Navigate to Settings >> Services
2. Create a New Service
Click on the Add New Service button to start the Service creation.
Add a New Service from the Services Page
3. Select the Service Type
Select AzureSQL as the service type and click Next.
4. Name and Describe your Service
Provide a name and description for your service as illustrated below.
Service Name
OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other AzureSQL services that you might be ingesting metadata from.
5. Configure the Service Connection
In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your AzureSQL service as desired.
Connection Options
6. Configure the Metadata Ingestion
Once the service is created, we can add a Metadata Ingestion Workflow, either directly from the Add Ingestion button in the figure above, or from the Service page:
Add a Metadata Ingestion Workflow from the Service Page
Metadata Ingestion Options
7. Schedule the Ingestion and Deploy
Scheduling can be set up at an hourly, daily, or weekly cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.
Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.
If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.
Schedule the Ingestion Pipeline and Deploy
Scheduling Options
After configuring the workflow, you can click on Deploy to create the pipeline.
8. View the Ingestion Pipeline
Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.
9. Workflow Deployment Error
If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.
You can then edit the Ingestion Pipeline and Deploy it again.
Edit and Deploy the Ingestion Pipeline
From the Connection tab, you can also Edit the Service if needed.
Query Usage and Lineage Ingestion
You can learn more about how to configure the Usage Workflow to ingest Query and Lineage information from the UI below:
Usage Workflow
Data Profiler and Quality Tests
You can learn more about how to configure the Data Profiler and about executing Data Quality tests from the UI below:
Profiler Workflow
DBT Integration
You can learn more about how to ingest DBT models' definitions and their lineage below:
DBT Integration
Run using Airflow SDK
You can learn more about how to host and run the different workflows on your own Airflow instances below:
Run AzureSQL Connector with the Airflow SDK
One-time ingestion with the CLI
You can learn more about how to run a one-time ingestion of the different workflows using the metadata CLI below:
Run AzureSQL Connector with the CLI