Azure SQL

Azure SQL is "a family of managed, secure, and intelligent products that use the SQL Server database engine in the Azure cloud."

Local/Built-in Scheduler

Engine Adapter Type: azuresql

pip install "sqlmesh[azuresql]"

pip install "sqlmesh[azuresql-odbc]"

Set driver: "pyodbc" in your connection options.

See 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, for detailed connection options see this link.

Note

The mssql-python driver requires python >= 3.10.

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 *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. *For the `mssql-python` driver, please see this link.	dict	N