Ready to get started?

Download a free trial of the Sage Cloud Accounting Driver to get started:

 Download Now

Learn more:

Sage Cloud Accounting Icon Sage Cloud Accounting JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Sage Cloud Accounting.

Create a Data Access Object for Sage Cloud Accounting Data using JDBI

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

Create a DAO for the Sage Cloud Accounting SalesInvoices 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 MySalesInvoicesDAO { //insert new data into Sage Cloud Accounting @SqlUpdate("INSERT INTO SalesInvoices (sent, total_amount) values (:sent, :total_amount)") void insert(@Bind("sent") String sent, @Bind("total_amount") String total_amount); //request specific data from Sage Cloud Accounting (String type is used for simplicity) @SqlQuery("SELECT total_amount FROM SalesInvoices WHERE sent = :sent") String findtotal_amountBysent(@Bind("sent") String sent); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Sage Cloud Accounting

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Sage Cloud Accounting.

You can connect to Sage Business Cloud Accounting using the embedded OAuth connectivity. When you connect, the OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sagebcaccounting.jar

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

A connection string for Sage Cloud Accounting 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:sagebcaccounting:InitiateOAuth=GETANDREFRESH"); MySalesInvoicesDAO dao =; //do stuff with the DAO dao.close();

Read Sage Cloud Accounting Data

With the connection open to Sage Cloud Accounting, simply call the previously defined method to retrieve data from the SalesInvoices entity in Sage Cloud Accounting.

//disply the result of our 'find' method String total_amount = dao.findtotal_amountBysent("TRUE"); System.out.println(total_amount);

Write Sage Cloud Accounting Data

It is also simple to write data to Sage Cloud Accounting, using the previously defined method.

//add a new entry to the SalesInvoices entity dao.insert(newsent, newtotal_amount);

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