OpenMetadata/openmetadata-docs/content/v1.2.x-SNAPSHOT/connectors/database/azuresql/index.md

title	slug
AzureSQL	/connectors/database/azuresql

AzureSQL

{% multiTablesWrapper %}

Feature	Status
Stage	PROD
Metadata	{% icon iconName="check" /%}
Query Usage	{% icon iconName="cross" /%}
Data Profiler	{% icon iconName="check" /%}
Data Quality	{% icon iconName="check" /%}
Lineage	Partially via Views
DBT	{% icon iconName="check" /%}
Supported Versions	--

Feature	Status
Lineage	Partially via Views
Table-level	{% icon iconName="check" /%}
Column-level	{% icon iconName="check" /%}

{% /multiTablesWrapper %}

In this section, we provide guides and references to use the AzureSQL connector.

Configure and schedule AzureSQL metadata and profiler workflows from the OpenMetadata UI:

• AzureSQL
  • Requirements
  • Metadata Ingestion
    • Service Name
    • Connection Options
    • Metadata Ingestion Options
  • Troubleshooting
    • Workflow Deployment Error
  • Related

{% partial file="/v1.2/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/azuresql/yaml"} /%}

Requirements

Make sure if you have whitelisted ingestion container IP on Azure SQL firewall rules. Checkout this document on how to whitelist your IP using azure portal.

AzureSQL database user must grant SELECT privilege to fetch the metadata of tables and views.

-- Create a new user
-- More details https://learn.microsoft.com/en-us/sql/t-sql/statements/create-user-transact-sql?view=sql-server-ver16
CREATE USER Mary WITH PASSWORD = '********';
-- Grant SELECT on table
GRANT SELECT TO Mary;

Metadata Ingestion

{% partial file="/v1.2/connectors/metadata-ingestion-ui.md" variables={ connector: "Azure SQL", selectServicePath: "/images/v1.2/connectors/azuresql/select-service.png", addNewServicePath: "/images/v1.2/connectors/azuresql/add-new-service.png", serviceConnectionPath: "/images/v1.2/connectors/azuresql/service-connection.png", } /%}

{% stepsContainer %} {% extraContent parentTagName="stepsContainer" %}

Connection Options

• Username: Specify the User to connect to AzureSQL. It should have enough privileges to read all the metadata.
• Password: Password to connect to AzureSQL.
• Host and Port: Enter the fully qualified hostname and port number for your AzureSQL deployment in the Host and Port field.
• Database: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases.
• Driver: Connecting to AzureSQL requires ODBC driver to be installed. Specify ODBC driver name in the field. You can download the ODBC driver from here. In case of docker or kubernetes deployment this driver comes out of the box with version ODBC Driver 18 for SQL Server.

{% partial file="/v1.2/connectors/database/advanced-configuration.md" /%}

{% /extraContent %}

{% partial file="/v1.2/connectors/test-connection.md" /%}

{% partial file="/v1.2/connectors/database/configure-ingestion.md" /%}

{% partial file="/v1.2/connectors/ingestion-schedule-and-deploy.md" /%}

{% /stepsContainer %}

{% partial file="/v1.2/connectors/troubleshooting.md" /%}

{% partial file="/v1.2/connectors/database/related.md" /%}