| Field | Description |
|---|---|
| Data source | SQL Server |
| Supported versions | Data Quality & Observability (self-hosted) currently ships with Microsoft JDBC Driver 12.6.4 for SQL Server. Please refer to the support matrix for Microsoft SQL Server version compatibility. |
| Connection string | jdbc:sqlserver:// |
| Packaged? |  Yes |
| Certified? | Yes |
| Supported features | |
| Estimate job | Yes |
| Analyze data | Yes |
| Schedule | Yes |
| Processing capabilities | |
| Pushdown | Yes |
| Spark agent | Yes |
| Yarn agent | Yes |
| Parallel JDBC | Yes |
| Java Platform version compatibility | |
| JDK 8 |
While the Java 8 version is not officially supported, you can replace the SQL Server driver in the /opt/owl/drivers/mssql folder with the Java 8 version of the supported driver. You can find Java 8 versions of the supported SQL Server on the Maven Repository. |
| JDK 11 | Yes |
Yes | Name | Text | The unique name of your connection. Ensure that there are no spaces in your connection name. |
| Yes | Connection URL | String | The connection string path of your SQL Server connection.
For more information about how to construct your connection URL, see Building the connection URL in the official SQL Server documentation.
When referring to the example below, replace the ${value} sections of the connection URL with your actual value.
jdbc:sqlserver://${host}:1433;databaseName=${dbName};encrypt=true;trustServerCertificate=true
Yes | Driver Name | String | The driver class name of your connection.
com.microsoft.sqlserver.jdbc.SQLServerDriver
Yes | Port | Integer | The port number to establish a connection to the datasource.
The default port is 1433
No | Limit Schemas | Option | Allows you to manage usage and restrict visibility to only the necessary schemas in the Explorer tree.
See Limiting schemas to learn how to limit schemas from the Connection Management page.
When you include a restricted schema in the query of a DQ Job, the query scope may be overwritten when the job runs. While only the schemas you selected when you set up the connection are shown in the Explorer menu, users are not restricted from running SQL queries on any schema from the data source.
No | Source Name | String | N/A |
| No | Target Agent | Option | The [Agent](/data-quality-self-hosted/installation/agent.md) that submits your Spark job for processing. |
| Yes | Auth Type | Option | The method to authenticate your connection.
The configuration requirements are different depending on the Auth Type you select. See Authentication for more details on available authentication types.
No | Properties | String | The configurable driver properties for your connection. Multiple properties must be semicolon-delimited, and each property=value pair, including the last one, must end with a semicolon (;). `abc=123;test=true;` |
## Authentication
Select an authentication type from the dropdown menu. The options available in the dropdown menu are the currently supported authentication types for this data source.
{% tabs %}
{% tab title="Username/Password" %}
| Required | Field | Description |
|---|---|---|
| Yes | Username | The username of your SQL Server account. |
| Yes | Password | The password of your SQL Server account. |
| Required | Field | Description |
|---|---|---|
| Yes | Username | The username of your SQL Server account. |
| Yes | Script | The file path that contains the script file that the password manager uses to interact with and authenticate a user account. :glasses-round: Example: /tmp/keytab/sqlserver_pwd_mgr.sh |
| No | Param $1 | Optional. An additional parameter to authenticate your SQL Server connection. |
| No | Param $2 | Optional. An additional parameter to authenticate your SQL Server connection. |
| No | Param $3 | Optional. An additional parameter to authenticate your SQL Server connection. |
| Required | Field | Description |
|---|---|---|
| Yes | MSI Client ID | The Microsoft Entra MSI Client ID |
| Required | Field | Description |
|---|---|---|
| Yes | Username | The Azure Active Directory (Azure AD) User Principal Name. |
| Yes | Password | The Azure Active Directory (Azure AD) password. |
| Required | Field | Description |
|---|---|---|
| Yes | Principal | The Microsoft Entra service principal ID. |
| Yes | Principal Secret | The Microsoft Entra service principal secret. |
| Required | Field | Description |
|---|---|---|
| Yes | Principal | The Kerberos entity to authenticate and grant access to your connection. :glasses-round: Example: test_user@example.collibra.com |
| Yes | Script | The file path that contains the script file used to interact with and authenticate a Kerberos user. :glasses-round: Example: /tmp/keytab/sqlserver_pwd_mgr.sh |
| No | Param $1 | Optional. Additional Kerberos parameter. |
| No | Param $2 | Optional. Additional Kerberos parameter. |
| No | Param $3 | Optional. Additional Kerberos parameter. |
| Required | Field | Description |
|---|---|---|
| Yes | Principal | The Kerberos entity to authenticate and grant access to your connection. :glasses-round: Example: test_user@example.collibra.com |
| Yes | Keytab | The file path of the keytab file that contains the encrypted key for a Kerberos principal. :glasses-round: Example: /tmp/keytab/sqlserver_user.keytab |
| Required | Field | Description |
|---|---|---|
| Yes | Principal | The Kerberos entity to authenticate and grant access to your connection. :glasses-round: Example: test_user@example.collibra.com |
| Yes | Password | The secret credential associated with your Kerberos principal. |
| Required | Field | Description |
|---|---|---|
| Yes | Username | The username of your SQL Server account. |
| Yes | Password | The password of your SQL Server account. |
| Required | Field | Description |
|---|---|---|
| Yes | Principal | The Kerberos entity to authenticate and grant access to your connection. :glasses-round: Example: test_user@example.collibra.com |
| Yes | TGT | The ticket-granting ticket cache that stores the TGT to authenticate your connection. |