JDBC Driver for Azure Synapse

Build 22.0.8389


This section shows how to establish a connection to data in DbVisualizer, use the table editor to edit and save data, and execute SQL.

Add the JDBC Driver for Azure Synapse

Complete the following steps to add the driver .jar file in a driver definition:

  1. In DbVisualizer, select Tools > Driver Manager and then select Driver > Create Driver.
  2. Enter a name for the driver.
  3. Enter the following in the URL Format box:
  4. In the Driver JAR Files section, click the folder icon and browse to the driver .jar file, cdata.jdbc.azuresynapse.jar. By default, this is located in the lib subfolder of the installation directory. Note that the .lic file in this folder must be located in the same folder as the .jar file.
  5. In the Driver Class menu, select the AzureSynapseDriver class, cdata.jdbc.azuresynapse.AzureSynapseDriver.

Create a Database Connection for Azure Synapse

Complete the following steps to select the Azure Synapse driver and build the JDBC URL to create the JDBC data source:

  1. In the main DbVisualizer window, select Tools > Connection Wizard.

  2. Enter an alias for the connection.
  3. Select the driver definition you created.
  4. In the following fields, enter the JDBC URL and provide authentication.

    See Establishing a Connection for a guide.

  5. Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:cdata:azuresynapse: followed by the connection properties in a semicolon-separated list of name-value pairs.

    A typical connection string is below:


  6. Database UserId: Enter the username for authentication to Azure Synapse, if needed.
  7. Database Password: Enter the password for authentication to Azure Synapse, if needed.
Note: After you successfully create a database connection for Azure Synapse you should set the "Database Type" property to "Generic".

Discover Schemas and Query Azure Synapse Data

In the main DbVisualizer window, click Connect on the Connection tab for the newly created connection. You can then browse data and execute SQL in the following ways:

  • To access the available tables, from the Databases tab, expand the nodes for the connection, database, schema, and table or view.
  • To browse through table data and metadata, right-click a table and click Open in New Tab.
  • To execute SQL queries, select SQL Commander > New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 22.0.8389