Create a Data Access Object for TigerGraph Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

TigerGraph JDBC Driver

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



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

Create a DAO for the TigerGraph person 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 MypersonDAO { //request specific data from TigerGraph (String type is used for simplicity) @SqlQuery("SELECT locationId FROM person WHERE locationId = :locationId") String findlocationIdBylocationId(@Bind("locationId") String locationId); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to TigerGraph

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

To authenticate with your TigerGraph instance, set the User, Password, and URL properties to valid TigerGraph credentials. By default connections are made on port 14240.

Built-in Connection String Designer

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

java -jar cdata.jdbc.tigergraph.jar

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

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

jdbc:tigergraph:User=MyUserName;Password=MyPassword;URL=MyURL;

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:tigergraph:User=MyUserName;Password=MyPassword;URL=MyURL;"); MypersonDAO dao = dbi.open(MypersonDAO.class); //do stuff with the DAO dao.close();

Read TigerGraph Data

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

//disply the result of our 'find' method String locationId = dao.findlocationIdBylocationId("chn"); System.out.println(locationId);

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