Create a Data Access Object for Sage 200 Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Sage 200 JDBC Driver

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

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

Create a DAO for the Sage 200 Banks 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 MyBanksDAO { //request specific data from Sage 200 (String type is used for simplicity) @SqlQuery("SELECT Code FROM Banks WHERE Code = :code") String findCodeByCode(@Bind("code") String code); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Sage 200

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

  • Schema: Determines which Sage 200 edition you are connecting to. Specify either StandardUK or ProfessionalUK.
  • Subscription Key: Provides access to the APIs that are used to establish a connection. You will first need to log into the Sage 200 API website and subscribe to the API edition that matches your account. You can do so here: Afterwards, the subscription key may be found in your profile after logging into Sage 200.

Built-in Connection String Designer

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

java -jar cdata.jdbc.sage200.jar

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

A connection string for Sage 200 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:sage200:SubscriptionKey=12345;Schema=StandardUK;InitiateOAuth=GETANDREFRESH"); MyBanksDAO dao =; //do stuff with the DAO dao.close();

Read Sage 200 Data

With the connection open to Sage 200, simply call the previously defined method to retrieve data from the Banks entity in Sage 200.

//disply the result of our 'find' method String code = dao.findCodeByCode("12345"); System.out.println(code);

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