Create a Data Access Object for Zoho CRM Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Zoho CRM JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Zoho CRM account data including Leads, Contacts, Opportunities, Accounts, and more!

A brief overview of creating a SQL Object API for Zoho CRM 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 Zoho CRM integrates connectivity to live Zoho CRM data in Java applications. By pairing these technologies, you gain simple, programmatic access to Zoho CRM data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Zoho CRM data.

Create a DAO for the Zoho CRM Accounts 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 MyAccountsDAO { //insert new data into Zoho CRM @SqlUpdate("INSERT INTO Accounts (Industry, Annual_Revenue) values (:industry, :annual_Revenue)") void insert(@Bind("industry") String industry, @Bind("annual_Revenue") String annual_Revenue); //request specific data from Zoho CRM (String type is used for simplicity) @SqlQuery("SELECT Annual_Revenue FROM Accounts WHERE Industry = :industry") String findAnnual_RevenueByIndustry(@Bind("industry") String industry); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Zoho CRM

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Zoho CRM.

You will need to obtain an AuthToken to authenticate to Zoho CRM. You can generate an AuthToken on the Zoho CRM website or by calling the GetAuthToken stored procedure. Note that when you generate an AuthToken from Zoho CRM, you can only generate an AuthToken for your user account. You can generate AuthTokens for other user accounts by calling GetAuthToken.

See the "Getting Started" chapter in the help documentation for a guide.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Zoho CRM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.zohocrm.jar

Fill in the connection properties and copy the connection string to the clipboard.

A connection string for Zoho CRM 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:zohocrm:AuthToken=2ad3b3e719f6bed7368e5e7e26e4f988;"); MyAccountsDAO dao =; //do stuff with the DAO dao.close();

Read Zoho CRM Data

With the connection open to Zoho CRM, simply call the previously defined method to retrieve data from the Accounts entity in Zoho CRM.

//disply the result of our 'find' method String annual_Revenue = dao.findAnnual_RevenueByIndustry("Data/Telecom OEM"); System.out.println(annual_Revenue);

Write Zoho CRM Data

It is also simple to write data to Zoho CRM, using the previously defined method.

//add a new entry to the Accounts entity dao.insert(newIndustry, newAnnual_Revenue);

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