Create a Data Access Object for Tally Data using 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 Tally integrates connectivity to live Tally data in Java applications. By pairing these technologies, you gain simple, programmatic access to Tally data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Tally data.

Create a DAO for the Tally Company 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 MyCompanyDAO {
 //request specific data from Tally (String type is used for simplicity)
 @SqlQuery("SELECT Address FROM Company WHERE CompanyNumber = :companyNumber")
 String findAddressByCompanyNumber(@Bind("companyNumber") String companyNumber);

 /*
 * close with no args is used to close the connection
 */
 void close();
}

Open a Connection to Tally

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

Set the following connection properties to connect to Tally Instance:

• Url: Set this to the URL for your Tally instance. For example: http://localhost:9000.

Built-in Connection String Designer

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

java -jar cdata.jdbc.tally.jar

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

A connection string for Tally will typically look like the following:

jdbc:tally:Url='http://localhost:9000'

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:tally:Url='http://localhost:9000'");
MyCompanyDAO dao = dbi.open(MyCompanyDAO.class);

//do stuff with the DAO

dao.close();

Read Tally Data

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

//disply the result of our 'find' method
String address = dao.findAddressByCompanyNumber("1000");
System.out.println(address);

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