Skip to content

Commit 75522a9

Browse files
docs: update Azure SQL and MSSQL authentication details and connection options
1 parent f92af4d commit 75522a9

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

docs/integrations/engines/azuresql.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,35 @@
22

33
[Azure SQL](https://azure.microsoft.com/en-us/products/azure-sql) is "a family of managed, secure, and intelligent products that use the SQL Server database engine in the Azure cloud."
44

5-
The Azure SQL adapter only supports authentication with a username and password. It does not support authentication with Microsoft Entra or Azure Active Directory.
6-
75
## Local/Built-in Scheduler
86
**Engine Adapter Type**: `azuresql`
97

108
### Installation
9+
#### User / Password Authentication:
1110
```
1211
pip install "sqlmesh[azuresql]"
1312
```
13+
#### Microsoft Entra ID / Azure Active Directory Authentication:
14+
```
15+
pip install "sqlmesh[azuresql-odbc]"
16+
```
1417

1518
### Connection options
1619

1720
| Option | Description | Type | Required |
1821
| ----------------- | ---------------------------------------------------------------- | :----------: | :------: |
1922
| `type` | Engine type name - must be `azuresql` | string | Y |
2023
| `host` | The hostname of the Azure SQL server | string | Y |
21-
| `user` | The username to use for authentication with the Azure SQL server | string | N |
22-
| `password` | The password to use for authentication with the Azure SQL server | string | N |
24+
| `user` | The username / client ID to use for authentication with the Azure SQL server | string | N |
25+
| `password` | The password / client secret to use for authentication with the Azure SQL server | string | N |
2326
| `port` | The port number of the Azure SQL server | int | N |
2427
| `database` | The target database | string | N |
2528
| `charset` | The character set used for the connection | string | N |
2629
| `timeout` | The query timeout in seconds. Default: no timeout | int | N |
2730
| `login_timeout` | The timeout for connection and login in seconds. Default: 60 | int | N |
2831
| `appname` | The application name to use for the connection | string | N |
2932
| `conn_properties` | The list of connection properties | list[string] | N |
30-
| `autocommit` | Is autocommit mode enabled. Default: false | bool | N |
33+
| `autocommit` | Is autocommit mode enabled. Default: false | bool | N |
34+
| `driver` | The driver to use for the connection. Default: pymsql | string | N |
35+
| `driver_name` | The driver name to use for the connection. E.g., *ODBC Driver 18 for SQL Server* | string | N |
36+
| `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 |

docs/integrations/engines/mssql.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,23 @@
44
**Engine Adapter Type**: `mssql`
55

66
### Installation
7+
#### User / Password Authentication:
78
```
89
pip install "sqlmesh[mssql]"
910
```
11+
#### Microsoft Entra ID / Azure Active Directory Authentication:
12+
```
13+
pip install "sqlmesh[mssql-odbc]"
14+
```
1015

1116
### Connection options
1217

1318
| Option | Description | Type | Required |
1419
| ----------------- | ------------------------------------------------------------ | :----------: | :------: |
1520
| `type` | Engine type name - must be `mssql` | string | Y |
1621
| `host` | The hostname of the MSSQL server | string | Y |
17-
| `user` | The username to use for authentication with the MSSQL server | string | N |
18-
| `password` | The password to use for authentication with the MSSQL server | string | N |
22+
| `user` | The username / client id to use for authentication with the MSSQL server | string | N |
23+
| `password` | The password / client secret to use for authentication with the MSSQL server | string | N |
1924
| `port` | The port number of the MSSQL server | int | N |
2025
| `database` | The target database | string | N |
2126
| `charset` | The character set used for the connection | string | N |
@@ -24,3 +29,6 @@ pip install "sqlmesh[mssql]"
2429
| `appname` | The application name to use for the connection | string | N |
2530
| `conn_properties` | The list of connection properties | list[string] | N |
2631
| `autocommit` | Is autocommit mode enabled. Default: false | bool | N |
32+
| `driver` | The driver to use for the connection. Default: pymsql | string | N |
33+
| `driver_name` | The driver name to use for the connection. E.g., *ODBC Driver 18 for SQL Server* | string | N |
34+
| `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 |

0 commit comments

Comments
 (0)