How to Connect DBeaver to Azure Synapse via a JDBC Driver

The CData JDBC Driver for Azure Synapse implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Azure Synapse data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Azure Synapse Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Azure Synapse).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.azuresynapse.AzureSynapseDriver.
   • Set URL Template to jdbc:azuresynapse:.
   
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.AzureSynapse.jar).

Create a Connection to Azure Synapse Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Azure Synapse) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   Connecting to Azure Synapse

   In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

   • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
   • Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

   Authenticating to Azure Synapse

   Connect to Azure Synapse using the following properties:

   • User: The username provided for authentication with Azure.
   • Password: The password associated with the authenticating user.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Azure Synapse JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.azuresynapse.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   

   Below is a typical connection string:

   jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Azure Synapse Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial