Skip to content

Commit 027fbb0

Browse files
treysptreysp
committed
Add docs
1 parent 99404f3 commit 027fbb0

1 file changed

Lines changed: 53 additions & 22 deletions

File tree

‎docs/integrations/engines/mssql.md‎

Lines changed: 53 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,65 @@
11
# MSSQL
22

3-
## Local/Built-in Scheduler
4-
**Engine Adapter Type**: `mssql`
3+
## Installation
54

6-
### Installation
7-
#### User / Password Authentication:
5+
### User / Password Authentication:
86
```
97
pip install "sqlmesh[mssql]"
108
```
11-
#### Microsoft Entra ID / Azure Active Directory Authentication:
9+
### Microsoft Entra ID / Azure Active Directory Authentication:
1210
```
1311
pip install "sqlmesh[mssql-odbc]"
1412
```
1513

14+
## Incremental by unique key `MERGE`
15+
16+
SQLMesh executes a `MERGE` statement to insert rows for [incremental by unique key](../../concepts/models/model_kinds.md#incremental_by_unique_key) model kinds.
17+
18+
By default, the `MERGE` statement updates all non-key columns of an existing row when a new row with the same key values is inserted. If all column values match between the two rows, those updates are unnecessary.
19+
20+
SQLMesh provides an optional performance optimization that skips unnecessary updates by comparing column values with the `EXISTS` and `EXCEPT` operators.
21+
22+
Enable the optimization by setting the `mssql_merge_exists` key to `true` in the [`physical_properties`](../../concepts/models/overview.md#physical_properties) section of the `MODEL` statement.
23+
24+
For example:
25+
26+
```sql linenums="1" hl_lines="7-9"
27+
MODEL (
28+
name sqlmesh_example.unique_key,
29+
kind INCREMENTAL_BY_UNIQUE_KEY (
30+
unique_key id
31+
),
32+
cron '@daily',
33+
physical_properties (
34+
mssql_merge_exists = true
35+
)
36+
);
37+
```
38+
39+
!!! warning "Not all column types supported"
40+
The `mssql_merge_exists` optimization is not supported for all column types, including `GEOMETRY`, `XML`, `TEXT`, `NTEXT`, `IMAGE`, and most user-defined types.
41+
42+
Learn more in the [MSSQL `EXCEPT` statement documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/set-operators-except-and-intersect-transact-sql?view=sql-server-ver17#arguments).
43+
44+
## Local/Built-in Scheduler
45+
**Engine Adapter Type**: `mssql`
46+
1647
### Connection options
1748

18-
| Option | Description | Type | Required |
19-
| ----------------- | ------------------------------------------------------------ | :----------: | :------: |
20-
| `type` | Engine type name - must be `mssql` | string | Y |
21-
| `host` | The hostname of the MSSQL server | string | Y |
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 |
24-
| `port` | The port number of the MSSQL server | int | N |
25-
| `database` | The target database | string | N |
26-
| `charset` | The character set used for the connection | string | N |
27-
| `timeout` | The query timeout in seconds. Default: no timeout | int | N |
28-
| `login_timeout` | The timeout for connection and login in seconds. Default: 60 | int | N |
29-
| `appname` | The application name to use for the connection | string | N |
30-
| `conn_properties` | The list of connection properties | list[string] | N |
31-
| `autocommit` | Is autocommit mode enabled. Default: false | bool | N |
32-
| `driver` | The driver to use for the connection. Default: pymssql | 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 |
49+
| Option | Description | Type | Required |
50+
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------: | :------: |
51+
| `type` | Engine type name - must be `mssql` | string | Y |
52+
| `host` | The hostname of the MSSQL server | string | Y |
53+
| `user` | The username / client id to use for authentication with the MSSQL server | string | N |
54+
| `password` | The password / client secret to use for authentication with the MSSQL server | string | N |
55+
| `port` | The port number of the MSSQL server | int | N |
56+
| `database` | The target database | string | N |
57+
| `charset` | The character set used for the connection | string | N |
58+
| `timeout` | The query timeout in seconds. Default: no timeout | int | N |
59+
| `login_timeout` | The timeout for connection and login in seconds. Default: 60 | int | N |
60+
| `appname` | The application name to use for the connection | string | N |
61+
| `conn_properties` | The list of connection properties | list[string] | N |
62+
| `autocommit` | Is autocommit mode enabled. Default: false | bool | N |
63+
| `driver` | The driver to use for the connection. Default: pymssql | string | N |
64+
| `driver_name` | The driver name to use for the connection (e.g., *ODBC Driver 18 for SQL Server*). | string | N |
65+
| `odbc_properties` | 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)