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

Create a DAO for the Salesforce Data Cloud Account 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 MyAccountDAO {
 //request specific data from Salesforce Data Cloud (String type is used for simplicity)
 @SqlQuery("SELECT [Account Name] FROM Account WHERE EmployeeCount = :employeeCount")
 String find[Account Name]ByEmployeeCount(@Bind("employeeCount") String employeeCount);

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

Open a Connection to Salesforce Data Cloud

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Salesforce Data Cloud.

Salesforce Data Cloud supports authentication via the OAuth standard.

OAuth

Set to OAuth.

Desktop Applications

CData provides an embedded OAuth application that simplifies authentication at the desktop.

You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Salesforce Data Cloud console. For further information, see Creating a Custom OAuth App in the Help documentation.

Before you connect, set these properties:

• : GETANDREFRESH. You can use to avoid repeating the OAuth exchange and manually setting the .
• (custom applications only): The Client ID assigned when you registered your custom OAuth application.
• (custom applications only): The Client Secret assigned when you registered your custom OAuth application.

When you connect, the driver opens Salesforce Data Cloud's OAuth endpoint in your default browser. Log in and grant permissions to the application.

The driver then completes the OAuth process as follows:

• Extracts the access token from the callback URL.
• Obtains a new access token when the old one expires.
• Saves OAuth values in so that they persist across connections.

For other OAuth methods, including Web Applications and Headless Machines, refer to the Help documentation.

Built-in Connection String Designer

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

java -jar cdata.jdbc.salesforcedatacloud.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 Salesforce Data Cloud will typically look like the following:

jdbc:salesforcedatacloud: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:salesforcedatacloud:InitiateOAuth=GETANDREFRESH;");
MyAccountDAO dao = dbi.open(MyAccountDAO.class);

//do stuff with the DAO

dao.close();

Read Salesforce Data Cloud Data

With the connection open to Salesforce Data Cloud, simply call the previously defined method to retrieve data from the Account entity in Salesforce Data Cloud.

//disply the result of our 'find' method
String [Account Name] = dao.find[Account Name]ByEmployeeCount("250");
System.out.println([Account Name]);

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