OpenMetadata/openmetadata-docs/content/v1.1.0/connectors/database/mssql/index.md

title	slug
MSSQL	/connectors/database/mssql

MSSQL

{% multiTablesWrapper %}

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

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

{% /multiTablesWrapper %}

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

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

• Remote-Connection
• Requirements
• Metadata Ingestion
• Query Usage
• Data Profiler
• Data Quality
• Lineage
• dbt Integration

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

Requirements

{%inlineCallout icon="description" bold="OpenMetadata 0.12 or later" href="/deployment"%} To deploy OpenMetadata, check the Deployment guides. {%/inlineCallout%}

MSSQL 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;

For Remote Connection

1. SQL Server running

Make sure the SQL server that you are trying to connect is in running state.

2. Allow remote connection on MSSMS(Microsoft SQL Server Management Studio)

This step allow the sql server to accept remote connection request.

{% image src="/images/v1.1.0/connectors/mssql/remote-connection.png" alt="Remote Connection" caption="Rm" /%}

3. Configure Windows Firewall

If you are using SQL server on windows, you must configure the firewall on the computer running SQL Server to allow access.

Step 1: On the Start menu, select Run, type WF.msc, and then select OK.

Step 2: In the Windows Firewall with Advanced Security, in the left pane, right-click Inbound Rules, and then select New Rule in the action pane.

Step 3: In the Rule Type dialog box, select Port, and then select Next.

Step 4: In the Protocol and Ports dialog box, select TCP. Select Specific local ports, and then type the port number of the instance of the Database Engine, such as 1433 for the default instance. Select Next.

Step 5: In the Action dialog box, select Allow the connection, and then select Next.

Step 6: In the Profile dialog box, select any profiles that describe the computer connection environment when you want to connect to the Database Engine, and then select Next.

Step 7: In the Name dialog box, type a name and description for this rule, and then select Finish.

For details step please refer to this link.

Metadata Ingestion

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

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

Connection Details

• Connection Scheme: Defines how to connect to MSSQL. We support mssql+pytds, mssql+pyodbc, and mssql+pymssql.
• Username: Specify the User to connect to MSSQL. It should have enough privileges to read all the metadata.
• Password: Password to connect to MSSQL.
• Host and Port: Enter the fully qualified hostname and port number for your MSSQL deployment in the Host and Port field.
• URI String: In case of a pyodbc connection.
• Database (Optional): 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.

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

{% /extraContent %}

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

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

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

{% /stepsContainer %}

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

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