Download Azure Synapse JDBC Driver

Download the Azure Synapse JDBC driver, copy the JDBC URL into DbSchema, and start designing schemas with ER diagrams — free Community Edition.

About the Azure Synapse JDBC driver

A JDBC driver is a Java .jar library that lets applications connect to Azure Synapse. DbSchema uses JDBC to reverse engineer schemas, run SQL, and generate documentation. Driver files are usually published by the database vendor or an open-source project.

JDBC URL format

Host, port, database name, and SSL options are passed in a URL starting with jdbc:. Each Azure Synapse driver uses its own syntax — see the connection details below.

The Azure Synapse JDBC driver

Azure Synapse Analytics is Microsoft's enterprise analytics service that combines big data and data warehousing. It provides dedicated SQL pools (formerly SQL DW) and serverless SQL pools for querying data lakes — all integrated with Azure Data Lake Storage.

The Azure Synapse JDBC URL

• Required File(s): mssql-jdbc-12.8.0.jre11.jar
• Java Driver Class: com.microsoft.sqlserver.jdbc.SQLServerDriver
• JDBC URL: jdbc:sqlserver://HOST:1433;user=USER;password=PASSWORD;database=DB;encrypt=true;trustServerCertificate=true;hostNameInCertificate=*.database.windows.net;loginTimeout=30;
• Website: Azure Synapse

Download Azure Synapse JDBC Driver

The driver archive is a zip file. Extract it and load the .jar files using DbSchema's Driver Manager. The driver can also be found here.

Set Up the Azure Synapse Connection

Two things trip up a first connection: which of the workspace's endpoints to use as the host, and the workspace firewall that blocks unknown addresses.

1. Take the host from the workspace, not from the pool. The overview page of the Synapse workspace lists a Dedicated SQL endpoint and a Serverless SQL endpoint, both ending in .sql.azuresynapse.net. Use the dedicated one to work with a dedicated SQL pool, and the serverless one to query the lake.
2. Add an IP firewall rule on the workspace. In the workspace's networking settings create a rule with a name, a start IP and an end IP. The rule applies to every public endpoint of the workspace at once — dedicated pools, the serverless pool and development.
3. Check outbound port 1433 on your side. Synapse communicates over 1433, and corporate networks often block outgoing traffic on it. That produces a timeout identical to a missing firewall rule, so rule it out before hunting in the portal.
4. Copy the JDBC URL from the Azure portal. You will find it in the workspace overview, next to the endpoint you chose.
5. Paste the URL into DbSchema. In the Connection Dialog set Connection Mode to Edit the JDBC URL Manually and paste the string you copied. The user and the password are entered in the first tab, not in the URL.

To sign in with Microsoft Entra ID rather than a SQL login, pick one of the Active Directory entries in the Connection Mode combo; the interactive one opens a browser and satisfies MFA.

DbSchema and Azure Synapse

DbSchema connects to Azure Synapse dedicated SQL pools using the SQL Server JDBC driver and renders distribution tables, hash-distributed and replicated table types in the schema diagram. Use the SQL Editor for Synapse-specific T-SQL including PolyBase and CETAS statements.