--- title: Run the MSSQL Connector Externally slug: /connectors/database/mssql/yaml --- # Run the MSSQL Connector Externally {% multiTablesWrapper %} | Feature | Status | | :----------------- | :--------------------------- | | Stage | PROD | | Metadata | {% icon iconName="check" /%} | | Query Usage | {% icon iconName="check" /%} | | Data Profiler | {% icon iconName="check" /%} | | Data Quality | {% icon iconName="check" /%} | | Stored Procedures | {% icon iconName="cross" /%} | | 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: - [Requirements](#requirements) - [Metadata Ingestion](#metadata-ingestion) - [Query Usage](#query-usage) - [Data Profiler](#data-profiler) - [Lineage](#lineage) - [dbt Integration](#dbt-integration) {% partial file="/v1.2/connectors/external-ingestion-deployment.md" /%} ## 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. ```sql -- 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; ``` ### Python Requirements To run the MSSQL ingestion, you will need to install: ```bash pip3 install "openmetadata-ingestion[mssql]" ``` If you want to run the Usage Connector, you'll also need to install: ```bash pip3 install "openmetadata-ingestion[mssql-usage]" ``` ## Metadata Ingestion All connectors are defined as JSON Schemas. [Here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/mssqlConnection.json) you can find the structure to create a connection to MSSQL. In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server. The workflow is modeled around the following [JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json) ### 1. Define the YAML Config This is a sample config for MSSQL: {% codePreview %} {% codeInfoContainer %} #### Source Configuration - Service Connection {% codeInfo srNumber=1 %} **scheme**: Defines how to connect to MSSQL. We support `mssql+pytds`, `mssql+pyodbc`, and `mssql+pymssql`. {% /codeInfo %} {% codeInfo srNumber=2 %} **username**: Specify the User to connect to MSSQL. It should have enough privileges to read all the metadata. {% /codeInfo %} {% codeInfo srNumber=3 %} **password**: Password to connect to MSSQL. {% /codeInfo %} {% codeInfo srNumber=4 %} **hostPort**: Enter the fully qualified hostname and port number for your MSSQL deployment in the Host and Port field. {% /codeInfo %} {% codeInfo srNumber=5 %} **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. {% /codeInfo %} {% codeInfo srNumber=6 %} **uriString**: In case of a `pyodbc` connection. {% /codeInfo %} {% partial file="/v1.2/connectors/yaml/database/source-config-def.md" /%} {% partial file="/v1.2/connectors/yaml/ingestion-sink-def.md" /%} {% partial file="/v1.2/connectors/yaml/workflow-config-def.md" /%} #### Advanced Configuration {% codeInfo srNumber=7 %} **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs. {% /codeInfo %} {% codeInfo srNumber=8 %} **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Athena during the connection. These details must be added as Key-Value pairs. - In case you are using Single-Sign-On (SSO) for authentication, add the `authenticator` details in the Connection Arguments as a Key-Value pair as follows: `"authenticator" : "sso_login_url"` {% /codeInfo %} {% /codeInfoContainer %} {% codeBlock fileName="filename.yaml" %} ```yaml source: type: mssql serviceName: "" serviceConnection: config: type: Mssql ``` ```yaml {% srNumber=1 %} scheme: mssql+pytds ``` ```yaml {% srNumber=2 %} username: ``` ```yaml {% srNumber=3 %} password: ``` ```yaml {% srNumber=4 %} hostPort: ``` ```yaml {% srNumber=5 %} # database: ``` ```yaml {% srNumber=6 %} uriString: uriString ``` ```yaml source: type: mssql serviceName: "" serviceConnection: config: type: Mssql username: password: hostPort: # database: ``` ```yaml {% srNumber=7 %} # connectionOptions: # key: value ``` ```yaml {% srNumber=8 %} # connectionArguments: # key: value ``` {% partial file="/v1.2/connectors/yaml/database/source-config.md" /%} {% partial file="/v1.2/connectors/yaml/ingestion-sink.md" /%} {% partial file="/v1.2/connectors/yaml/workflow-config.md" /%} {% /codeBlock %} {% /codePreview %} {% partial file="/v1.2/connectors/yaml/ingestion-cli.md" /%} {% partial file="/v1.2/connectors/yaml/query-usage.md" variables={connector: "mssql"} /%} {% partial file="/v1.2/connectors/yaml/data-profiler.md" variables={connector: "mssql"} /%} ## Lineage You can learn more about how to ingest lineage [here](/connectors/ingestion/workflows/lineage). ## dbt Integration You can learn more about how to ingest dbt models' definitions and their lineage [here](/connectors/ingestion/workflows/dbt).