Create a Data Access Object for Pipedrive Data using JDBI

Ready to get started?

Download a free trial:

Download Now

Learn more:

Pipedrive JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Pipedrive.

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

Create a DAO for the Pipedrive Deals 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 MyDealsDAO { //insert new data into Pipedrive @SqlUpdate("INSERT INTO Deals (Value, UserEmail) values (:value, :userEmail)") void insert(@Bind("value") String value, @Bind("userEmail") String userEmail); //request specific data from Pipedrive (String type is used for simplicity) @SqlQuery("SELECT UserEmail FROM Deals WHERE Value = :value") String findUserEmailByValue(@Bind("value") String value); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Pipedrive

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

Built-in Connection String Designer

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

java -jar cdata.jdbc.pipedrive.jar

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

A connection string for Pipedrive 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:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;"); MyDealsDAO dao =; //do stuff with the DAO dao.close();

Read Pipedrive Data

With the connection open to Pipedrive, simply call the previously defined method to retrieve data from the Deals entity in Pipedrive.

//disply the result of our 'find' method String userEmail = dao.findUserEmailByValue("50000"); System.out.println(userEmail);

Write Pipedrive Data

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

//add a new entry to the Deals entity dao.insert(newValue, newUserEmail);

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