Create a Data Access Object for Salesloft Data using JDBI



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

Create a DAO for the Salesloft Accounts 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 MyAccountsDAO { //insert new data into Salesloft @SqlUpdate("INSERT INTO Accounts (Country, Name) values (:country, :name)") void insert(@Bind("country") String country, @Bind("name") String name); //request specific data from Salesloft (String type is used for simplicity) @SqlQuery("SELECT Name FROM Accounts WHERE Country = :country") String findNameByCountry(@Bind("country") String country); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Salesloft

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

SalesLoft authenticates using the OAuth authentication standard or an API Key. OAuth requires the authenticating user to interact with SalesLoft using the browser.

Using OAuth

For OAuth authentication, create an OAuth app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the OAuth section in the Help documentation for an authentication guide.

Using APIKey

Alternatively, you can authenticate with an APIKey. Provision an API key from the SalesLoft user interface: https://accounts.salesloft.com/oauth/applications/. You will receive a Key which will be used when issuing requests.

Built-in Connection String Designer

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

java -jar cdata.jdbc.salesloft.jar

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

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

jdbc:salesloft:AuthScheme=OAuth;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;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:salesloft:AuthScheme=OAuth;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackUrl=http://localhost:33333;InitiateOAuth=GETANDREFRESH"); MyAccountsDAO dao = dbi.open(MyAccountsDAO.class); //do stuff with the DAO dao.close();

Read Salesloft Data

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

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

Write Salesloft Data

It is also simple to write data to Salesloft, using the previously defined method.

//add a new entry to the Accounts entity dao.insert(newCountry, newName);

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

Ready to get started?

Download a free trial of the Salesloft Driver to get started:

 Download Now

Learn more:

Salesloft Icon Salesloft JDBC Driver

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