Create a Data Access Object for Basecamp Data using JDBI

Ready to get started?

Download a free trial:

Download Now

Learn more:

Basecamp JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Basecamp including Projects, People, Documents, Messages, and more!

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

Create a DAO for the Basecamp Projects 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 MyProjectsDAO { //insert new data into Basecamp @SqlUpdate("INSERT INTO Projects (Drafts, DocumentsCount) values (:drafts, :documentsCount)") void insert(@Bind("drafts") String drafts, @Bind("documentsCount") String documentsCount); //request specific data from Basecamp (String type is used for simplicity) @SqlQuery("SELECT DocumentsCount FROM Projects WHERE Drafts = :drafts") String findDocumentsCountByDrafts(@Bind("drafts") String drafts); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Basecamp

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

Basecamp uses basic or OAuth 2.0 authentication. To use basic authentication you will need the user and password that you use for logging in to Basecamp. To authenticate to Basecamp via OAuth 2.0, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with Basecamp.

See the Getting Started section in the help documentation for a connection guide.

Additionally, you will need to specify the AccountId connection property. This can be copied from the URL after you log in.

Built-in Connection String Designer

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

java -jar cdata.jdbc.basecamp.jar

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

A connection string for Basecamp 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:basecamp:User=test@northwind.db;Password=test123;"); MyProjectsDAO dao =; //do stuff with the DAO dao.close();

Read Basecamp Data

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

//disply the result of our 'find' method String documentsCount = dao.findDocumentsCountByDrafts("True"); System.out.println(documentsCount);

Write Basecamp Data

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

//add a new entry to the Projects entity dao.insert(newDrafts, newDocumentsCount);

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