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

Create a DAO for the Vault CRM NorthwindProducts 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 MyNorthwindProductsDAO {
  //insert new data into Vault CRM
  @SqlUpdate("INSERT INTO NorthwindProducts (CategoryId, ProductName) values (:categoryId, :productName)")
  void insert(@Bind("categoryId") String categoryId, @Bind("productName") String productName);

  //request specific data from Vault CRM (String type is used for simplicity)
  @SqlQuery("SELECT ProductName FROM NorthwindProducts WHERE CategoryId = :categoryId")
  String findProductNameByCategoryId(@Bind("categoryId") String categoryId);

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

Open a Connection to Vault CRM

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

You are ready to connect after specifying the following connection properties:

• Url: The host you see in the URL after you login to your account. For example: https://my-veeva-domain.veevavault.com
• User: The username you use to login to your account.
• Password: The password you use to login to your account.

Built-in Connection String Designer

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

java -jar cdata.jdbc.vaultcrm.jar

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

A connection string for Vault CRM will typically look like the following:

jdbc:vaultcrm:User=myuser;Password=mypassword;Server=localhost;Database=mydatabase;

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:vaultcrm:User=myuser;Password=mypassword;Server=localhost;Database=mydatabase;");
MyNorthwindProductsDAO dao = dbi.open(MyNorthwindProductsDAO.class);

//do stuff with the DAO

dao.close();

Read Vault CRM Data

With the connection open to Vault CRM, simply call the previously defined method to retrieve data from the NorthwindProducts entity in Vault CRM.

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

Write Vault CRM Data

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

//add a new entry to the NorthwindProducts entity
dao.insert(newCategoryId, newProductName);

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