Query Azure Synapse Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for Azure Synapse, DataGrip can work with live Azure Synapse data. This article shows how to establish a connection to Azure Synapse data in DataGrip and use the table editor to load Azure Synapse data.

Create a New Driver Definition for Azure Synapse

The steps below describe how to create a new Data Source in DataGrip for Azure Synapse.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Azure Synapse Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.azuresynapse.jar).
   • Set Class to cdata.jdbc.azuresynapse.AzureSynapse.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Azure Synapse

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Azure Synapse Driver" to create a new Azure Synapse Data Source.
2. In the new window, configure the connection to Azure Synapse with a JDBC URL.

   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.

   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.
3. Set URL to the connection string, e.g., jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Azure Synapse

To browse through the Azure Synapse entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Id, ProductName FROM Products WHERE ProductName = 'Konbu'

Download a free, 30-day trial of the CData JDBC Driver for Azure Synapse and start working with your live Azure Synapse data in DataGrip. Reach out to our Support Team if you have any questions.