Fabric

Info

The Fabric engine adapter is a community contribution. Due to this, only limited community support is available.

Local/Built-in Scheduler

Engine Adapter Type: fabric

NOTE: Fabric Warehouse is not recommended to be used for the SQLMesh state connection.

Installation

Microsoft Entra ID / Azure Active Directory Authentication:

pip install "sqlmesh[fabric]"

Python Driver (Official Microsoft driver for Fabric SQL databases):

See mssql-python for more information.

pip install "sqlmesh[fabric-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.

Connection options

Option	Description	Type	Required
type	Engine type name - must be fabric	string	Y
host	The hostname of the Fabric Warehouse server	string	Y
user	The client id to use for authentication with the Fabric Warehouse server	string	N
password	The client secret to use for authentication with the Fabric Warehouse server	string	N
port	The port number of the Fabric Warehouse 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: pyodbc	string	N
driver_name	The driver name to use for the connection. E.g., ODBC Driver 18 for SQL Server	string	N
tenant_id	The Azure / Entra tenant UUID	string	Y
workspace_id	The Fabric workspace UUID. The preferred way to retrieve it is by running notebookutils.runtime.context.get("currentWorkspaceId") in a python notebook.	string	Y
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