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

Create a DAO for the Zuora Invoices 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 MyInvoicesDAO {
 //request specific data from Zuora (String type is used for simplicity)
 @SqlQuery("SELECT BillingCity FROM Invoices WHERE BillingState = :billingState")
 String findBillingCityByBillingState(@Bind("billingState") String billingState);

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

Open a Connection to Zuora

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

Zuora uses the OAuth standard to authenticate users. See the online Help documentation for a full OAuth authentication guide.

Configuring Tenant property

In order to create a valid connection with the provider you need to choose one of the Tenant values (USProduction by default) which matches your account configuration. The following is a list with the available options:

• USProduction: Requests sent to https://rest.zuora.com.
• USAPISandbox: Requests sent to https://rest.apisandbox.zuora.com"
• USPerformanceTest: Requests sent to https://rest.pt1.zuora.com"
• EUProduction: Requests sent to https://rest.eu.zuora.com"
• EUSandbox: Requests sent to https://rest.sandbox.eu.zuora.com"

Selecting a Zuora Service

Two Zuora services are available: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

DataQuery

The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

Limitations

• The maximum number of input records per table after filters have been applied: 1,000,000
• The maximum number of output records: 100,000
• The maximum number of simultaneous queries submitted for execution per tenant: 5
• The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
• The maximum processing time for each query in hours: 1
• The maximum size of memory allocated to each query in GB: 2
• The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

AQuADataExport

AQuA API export is designed to export all the records for all the objects ( tables ). AQuA query jobs have the following limitations:

Limitations

• If a query in an AQuA job is executed longer than 8 hours, this job will be killed automatically.
• The killed AQuA job can be retried three times before returned as failed.

Built-in Connection String Designer

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

java -jar cdata.jdbc.zuora.jar

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

👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

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

jdbc:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;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:zuora:OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH;");
MyInvoicesDAO dao = dbi.open(MyInvoicesDAO.class);

//do stuff with the DAO

dao.close();

Read Zuora Data

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

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

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