Connect to Azure Synapse Data in Aqua Data Studio

The CData JDBC Driver for Azure Synapse integrates Azure Synapse data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Azure Synapse data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Azure Synapse data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Azure Synapse.
   • Driver Location: Click the Browse button and select the cdata.jdbc.azuresynapse.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.azuresynapse.AzureSynapseDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:azuresynapse: and is followed by a semicolon-separated list of 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.

     A typical JDBC URL is below:
     jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;

Query Azure Synapse Data

You can now query the tables exposed.