Create a Data Access Object for SAP HANA XS Advanced Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SAP HANA XS Advanced JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SAP HANA XS Advanced.



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

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

Open a Connection to SAP HANA XS Advanced

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to SAP HANA XS Advanced.

SAP HANA XSA uses the OAuth authentication standard. Before connecting, it is necessary to establish an SAP HANA XSA OData Service. See the OAuth section in the Help documentation for a guide.

Built-in Connection String Designer

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

java -jar cdata.jdbc.saphanaxsa.jar

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

A connection string for SAP HANA XS Advanced will typically look like the following:

jdbc:saphanaxsa:OAuthClientID=my-ouath-client-id;OAuthClientSecret=my-oauth-client-secret;URL=https://hxehost:51027/euro.xsodata;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH

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:saphanaxsa:OAuthClientID=my-ouath-client-id;OAuthClientSecret=my-oauth-client-secret;URL=https://hxehost:51027/euro.xsodata;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH"); MyDAO dao = dbi.open(MyDAO.class); //do stuff with the DAO dao.close();

Read SAP HANA XS Advanced Data

With the connection open to SAP HANA XS Advanced, simply call the previously defined method to retrieve data from the entity in SAP HANA XS Advanced.

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

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