Skip to content

MSSQL

Local/Built-in Scheduler

Engine Adapter Type: mssql

Installation

pip install "sqlmesh[mssql]"

Connection options

Option Description Type Required
type Engine type name - must be mssql string Y
host The hostname of the MSSQL server string Y
user The username to use for authentication with the MSSQL server string N
password The password to use for authentication with the MSSQL server string N
port The port number of the MSSQL 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

Airflow Scheduler

Engine Name: mssql

The SQLMesh MsSql Operator is similar to the MsSqlOperator, and relies on the same MsSqlHook implementation.

To enable support for this operator, the Airflow Microsoft MSSQL provider package should be installed on the target Airflow cluster along with SQLMesh with the mssql extra: 

pip install "apache-airflow-providers-microsoft-mssql"
pip install "sqlmesh[mssql]"

The operator requires an Airflow connection to determine the target MSSQL account. Refer to MSSQL connection for more details.

By default, the connection ID is set to mssql_default, but can be overridden using the engine_operator_args parameter to the SQLMeshAirflow instance as in the example below: 

1
2
3
4
5
6
7
sqlmesh_airflow = SQLMeshAirflow(
    "mssql",
    default_catalog="<database name>",
    engine_operator_args={
        "mssql_conn_id": "<Connection ID>"
    },
)