Skip to content

Commit a866dff

Browse files
authored
Chore: Add documentation for the MSSQL connection config (#1341)
1 parent 27c29b4 commit a866dff

File tree

7 files changed

+32
-5
lines changed

7 files changed

+32
-5
lines changed

docs/guides/connections.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ default_gateway: local_db
8181
* [Databricks](../integrations/engines/databricks.md)
8282
* [DuckDB](../integrations/engines/duckdb.md)
8383
* [MySQL](../integrations/engines/mysql.md)
84+
* [MSSQL](../integrations/engines/mssql.md)
8485
* [Postgres](../integrations/engines/postgres.md)
8586
* [GCP Postgres](../integrations/engines/gcp-postgres.md)
8687
* [Redshift](../integrations/engines/redshift.md)

docs/integrations/engines/mssql.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# MSSQL
2+
3+
## Local/Built-in Scheduler
4+
**Engine Adapter Type**: `mssql`
5+
6+
### Installation
7+
```
8+
pip install "sqlmesh[mssql]"
9+
```
10+
11+
### Connection options
12+
13+
| Option | Description | Type | Required |
14+
|-------------------|--------------------------------------------------------------|:--------:|:--------:|
15+
| `host` | The hostname of the MSSQL server | string | Y |
16+
| `user` | The username to use for authentication with the MSSQL server | string | Y |
17+
| `password` | The password to use for authentication with the MSSQL server | string | Y |
18+
| `port` | The port number of the MSSQL server | int | N |
19+
| `database` | The target database | string | N |
20+
| `charset` | The character set used for the connection | string | N |
21+
| `timeout` | The query timeout in seconds. Default: no timeout | int | N |
22+
| `login_timeout` | The timeout for connection and login in seconds. Default: 60 | int | N |
23+
| `appname` | The application name to use for the connection | string | N |
24+
| `conn_properties` | The list of connection properties | [string] | N |
25+
| `autocommit` | Is autocommit mode enabled. Default: false | bool | N |

docs/integrations/engines/mysql.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ pip install "sqlmesh[mysql]"
1515
| `host` | The hostname of the MysQL server | string | Y |
1616
| `user` | The username to use for authentication with the MySQL server | string | Y |
1717
| `password` | The password to use for authentication with the MySQL server | string | Y |
18-
| `port` | The port number of the MySQL server | int | Y |
18+
| `port` | The port number of the MySQL server | int | N |
1919
| `charset` | The character set used for the connection | string | N |
20-
| `ssl_disabled` | Is SSL disabled | bool | N |
20+
| `ssl_disabled` | Is SSL disabled | bool | N |

docs/integrations/overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ SQLMesh supports the following execution engines for running SQLMesh projects:
1414
* [Databricks](./engines/databricks.md)
1515
* [DuckDB](./engines/duckdb.md)
1616
* [MySQL](./engines/mysql.md)
17+
* [MSSQL](./engines/mssql.md)
1718
* [Postgres](./engines/postgres.md)
1819
* [GCP Postgres](./engines/gcp-postgres.md)
1920
* [Redshift](./engines/redshift.md)
2021
* [Snowflake](./engines/snowflake.md)
21-
* [Spark](./engines/spark.md)
22+
* [Spark](./engines/spark.md)

docs/reference/configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ These pages describe the connection configuration options for each execution eng
158158
* [Databricks](../integrations/engines/databricks.md)
159159
* [DuckDB](../integrations/engines/duckdb.md)
160160
* [MySQL](../integrations/engines/mysql.md)
161+
* [MSSQL](../integrations/engines/mssql.md)
161162
* [Postgres](../integrations/engines/postgres.md)
162163
* [GCP Postgres](../integrations/engines/gcp-postgres.md)
163164
* [Redshift](../integrations/engines/redshift.md)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ nav:
6262
- integrations/engines/databricks.md
6363
- integrations/engines/duckdb.md
6464
- integrations/engines/mysql.md
65+
- integrations/engines/mssql.md
6566
- integrations/engines/postgres.md
6667
- integrations/engines/gcp-postgres.md
6768
- integrations/engines/redshift.md

sqlmesh/core/config/connection.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -681,7 +681,6 @@ class MSSQLConnectionConfig(_ConnectionConfig):
681681
timeout: t.Optional[int] = 0
682682
login_timeout: t.Optional[int] = 60
683683
charset: t.Optional[str] = "UTF-8"
684-
as_dict: t.Optional[bool] = False
685684
appname: t.Optional[str] = None
686685
port: t.Optional[int] = 1433
687686
conn_properties: t.Optional[t.Union[t.Iterable[str], str]] = None
@@ -702,7 +701,6 @@ def _connection_kwargs_keys(self) -> t.Set[str]:
702701
"timeout",
703702
"login_timeout",
704703
"charset",
705-
"as_dict",
706704
"appname",
707705
"port",
708706
"conn_properties",

0 commit comments

Comments
 (0)