How to connect to Azure Synapse Data from IntelliJ

The CData JDBC Driver for Azure Synapse enables you to access Azure Synapse as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Azure Synapse data in IntelliJ.

Create a JBDC Data Source for Azure Synapse

Follow the steps below to add the driver JAR and define connection properties required to connect to Azure Synapse data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.azuresynapse.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.azuresynapse.AzureSynapseDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:azuresynapse: and includes connection properties separated with semicolons.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

     jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;

Edit and Save Azure Synapse Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.