Ready to get started?

Download a free trial of the TSheets Driver to get started:

 Download Now

Learn more:

TSheets Icon TSheets JDBC Driver

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

Create a Data Access Object for TSheets Data using JDBI

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

Create a DAO for the TSheets Timesheets 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 MyTimesheetsDAO { //request specific data from TSheets (String type is used for simplicity) @SqlQuery("SELECT JobcodeId FROM Timesheets WHERE JobCodeType = :jobCodeType") String findJobcodeIdByJobCodeType(@Bind("jobCodeType") String jobCodeType); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to TSheets

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

TSheets uses the OAuth2 standard for authentication and authorization. To construct your own OAuth app and connect to data, refer to OAuth section in the Help.

Built-in Connection String Designer

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

java -jar cdata.jdbc.tsheets.jar

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

A connection string for TSheets 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:tsheets:OAuthClientId=myclientid;OAuthClientSecret=myclientsecret;CallbackUrl=http://localhost:33333;InitiateOAuth=GETANDREFRESH"); MyTimesheetsDAO dao =; //do stuff with the DAO dao.close();

Read TSheets Data

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

//disply the result of our 'find' method String jobcodeId = dao.findJobcodeIdByJobCodeType("regular"); System.out.println(jobcodeId);

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