Skip to content

feat(connections): Add mssql-python driver. #5839

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StuffbyYuki merged 12 commits into from
Jun 26, 2026
+742 −161
Merged

feat(connections): Add mssql-python driver. #5839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1ceee85
feat(connections): Support `mssql-python` driver.
walanguzzi Jan 8, 2026
df1ac86
fix(deps): Missing `mssql-python` and new extras.
walanguzzi Jan 8, 2026
1b4e12e
test(drivers): `mssql-python` test cases.
walanguzzi Jan 8, 2026
713011d
fix(mssql-python): Constrain supported versions.
walanguzzi Jan 8, 2026
da07f76
docs(mssql): Refer to `mssql-python` extra.
walanguzzi Jan 8, 2026
fffce57
fix(tests): Correct driver name comments & xfail.
walanguzzi Jan 8, 2026
1b8b737
refactor: Drop redundant output converter.
walanguzzi Jan 15, 2026
3084646
fix(tests): Restored output converter.
walanguzzi Jan 18, 2026
1caf749
refactor(typing): Explict cast for `mypy`.
walanguzzi Jun 14, 2026
eb9ae3f
fix(tests): Drop xfail from pyodbc connection-string tests (3.9 XPASS)
walanguzzi Jun 26, 2026
09a5ef6
fix(mssql-python): Allow `login_attempts` kwarg and handle `odbc_prop…
walanguzzi Jun 26, 2026
a80e43c
docs(mssql-python): Note `python >= 3.10` and `login_attempts` option.
walanguzzi Jun 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 35 additions & 17 deletions docs/integrations/engines/azuresql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,41 @@ pip install "sqlmesh[azuresql]"
```
pip install "sqlmesh[azuresql-odbc]"
```
Set `driver: "pyodbc"` in your connection options.


#### Python Driver (Official Microsoft driver for Azure SQL):
See [`mssql-python`](https://pypi.org/project/mssql-python/) for more information.

```
pip install "sqlmesh[azuresql-mssql-python]"
```

Set `driver: "mssql-python"` in your connection options. This driver supports
[Entra ID auth](https://github.com/microsoft/mssql-python/wiki/Microsoft-Entra-ID-support),
for detailed connection options see [this link](https://github.com/microsoft/mssql-python/wiki/Connection-to-SQL-Database).

!!! note
The `mssql-python` driver [requires](https://pypi.org/project/mssql-python/) `python >= 3.10`.


### Connection options

| Option | Description | Type | Required |
| ----------------- | ---------------------------------------------------------------- | :----------: | :------: |
| `type` | Engine type name - must be `azuresql` | string | Y |
| `host` | The hostname of the Azure SQL server | string | Y |
| `user` | The username / client ID to use for authentication with the Azure SQL server | string | N |
| `password` | The password / client secret to use for authentication with the Azure SQL server | string | N |
| `port` | The port number of the Azure SQL server | int | N |
| `database` | The target database | string | N |
| `charset` | The character set used for the connection | string | N |
| `timeout` | The query timeout in seconds. Default: no timeout | int | N |
| `login_timeout` | The timeout for connection and login in seconds. Default: 60 | int | N |
| `appname` | The application name to use for the connection | string | N |
| `conn_properties` | The list of connection properties | list[string] | N |
| `autocommit` | Is autocommit mode enabled. Default: false | bool | N |
| `driver` | The driver to use for the connection. Default: pymssql | string | N |
| `driver_name` | The driver name to use for the connection. E.g., *ODBC Driver 18 for SQL Server* | string | N |
| `odbc_properties` | The dict of ODBC connection properties. E.g., authentication: ActiveDirectoryServicePrincipal. See more [here](https://learn.microsoft.com/en-us/sql/connect/odbc/dsn-connection-string-attribute?view=sql-server-ver16). | dict | N |
| Option | Description | Type | Required |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------: | :------: |
| `type` | Engine type name - must be `azuresql` | string | Y |
| `host` | The hostname of the Azure SQL server | string | Y |
| `user` | The username / client ID to use for authentication with the Azure SQL server | string | N |
| `password` | The password / client secret to use for authentication with the Azure SQL server | string | N |
| `port` | The port number of the Azure SQL server | int | N |
| `database` | The target database | string | N |
| `charset` | The character set used for the connection | string | N |
| `timeout` | The query timeout in seconds. Default: no timeout | int | N |
| `login_timeout` | The timeout for connection and login in seconds. Default: 60 | int | N |
| `login_attempts` | The number of reconnection attempts before failing. Default: 1 <br><br>*This option only applies to the `mssql-python` driver. | int | N |
| `appname` | The application name to use for the connection | string | N |
| `conn_properties` | The list of connection properties | list[string] | N |
| `autocommit` | Is autocommit mode enabled. Default: false | bool | N |
| `driver` | The driver to use for the connection. Default: pymssql | string | N |
| `driver_name` | The driver name to use for the connection (e.g., *ODBC Driver 18 for SQL Server*). | string | N |
| `odbc_properties` | The dict of ODBC connection properties (e.g., *authentication: ActiveDirectoryServicePrincipal*). See more [here](https://learn.microsoft.com/en-us/sql/connect/odbc/dsn-connection-string-attribute?view=sql-server-ver16).<br><br>*For the `mssql-python` driver, please see [this link](https://github.com/microsoft/mssql-python/wiki/Connection-to-SQL-Database). | dict | N |
Loading
Loading