Skip to main content
Version: Next

Azure Synapse Analytics

Connect Microsoft Azure Synapse Analytics to Lakehousecat using a connection URI. Azure Synapse uses the SQL Server wire protocol — the connection is established the same way as a Microsoft SQL Server connection.

Connection Fields​

FieldRequiredDescription
Connection URIYesFull connection string including credentials, host, port, and database name. Example: azuresynapse://user:password@workspace.sql.azuresynapse.net:1433/mydb
Use SSHNoEnable if the workspace endpoint is accessible only via an SSH bastion host. When enabled, SSH settings fields appear: Host, Port, Username, Password, Private Key, and Private Key Passphrase. See SSH Tunneling.

Prerequisites​

  • Admin or Builder role in Lakehousecat
  • An Azure Synapse Analytics workspace with a dedicated SQL pool or serverless SQL endpoint
  • A SQL login with read access to the schemas and tables you want to expose
  • Network connectivity from the Lakehousecat backend to the Synapse endpoint (direct or via SSH)
  • The Microsoft ODBC driver, provisioned once through a job definition (see below)

Provision the ODBC driver (one-time)​

Lakehousecat does not ship Microsoft's ODBC Driver 18 for SQL Server, which Synapse also uses. You fetch it once from Microsoft through the azuresynapse_driver_provisioning job definition and accept Microsoft's licence terms while doing so. Then load through azuresynapse_load and validate the connection or discover the schema through azuresynapse_schema_validate. The driver works on amd64 and arm64. If you already provisioned the driver for SQL Server, you can reuse its file ID.

Validate and load calls made directly against the platform API don't work for Azure Synapse. They return a message that points to these job definitions.

See Vendor Drivers for the steps and network requirements.

Notes​

  • Azure Synapse Analytics uses the same SQL Server wire protocol as Microsoft SQL Server. The connection URI scheme azuresynapse:// is normalized internally.
  • Use a read-only login to follow the principle of least privilege.
  • For large warehouses, configure schema and table filters in the Filters tab after creation to limit the scope of semantic extraction.
  • Serverless SQL pools and dedicated SQL pools are both supported via the same connection method.

Next Steps​

After provisioning the driver, load the datasource through the azuresynapse_load job definition, then open the Operations tab to trigger semantic extraction.