Ready to get started?

Download a free trial of the Azure Synapse Driver to get started:

 Download Now

Learn more:

Azure Synapse Icon Azure Synapse JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Azure Synapse.

Create a Data Access Object for Azure Synapse Data using JDBI

A brief overview of creating a SQL Object API for Azure Synapse data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Azure Synapse integrates connectivity to live Azure Synapse data in Java applications. By pairing these technologies, you gain simple, programmatic access to Azure Synapse data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Azure Synapse data.

Create a DAO for the Azure Synapse Products Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyProductsDAO { //insert new data into Azure Synapse @SqlUpdate("INSERT INTO Products (ProductName, ProductName) values (:productName, :productName)") void insert(@Bind("productName") String productName, @Bind("productName") String productName); //request specific data from Azure Synapse (String type is used for simplicity) @SqlQuery("SELECT ProductName FROM Products WHERE ProductName = :productName") String findProductNameByProductName(@Bind("productName") String productName); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Azure Synapse

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Azure Synapse.

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 connection string for Azure Synapse will typically look like the following:


Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:azuresynapse:User=myuser;Password=mypassword;Server=localhost;Database=Northwind;"); MyProductsDAO dao =; //do stuff with the DAO dao.close();

Read Azure Synapse Data

With the connection open to Azure Synapse, simply call the previously defined method to retrieve data from the Products entity in Azure Synapse.

//disply the result of our 'find' method String productName = dao.findProductNameByProductName("Konbu"); System.out.println(productName);

Write Azure Synapse Data

It is also simple to write data to Azure Synapse, using the previously defined method.

//add a new entry to the Products entity dao.insert(newProductName, newProductName);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Azure Synapse by integrating with the CData JDBC Driver for Azure Synapse. Download a free trial and work with live Azure Synapse data in custom Java applications today.