Ready to get started?

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

 Download Now

Learn more:

Veeva Vault Icon Veeva JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Veeva account data including Documents, Users, Groups, and more!

Create a Data Access Object for Veeva Data using JDBI

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

Create a DAO for the Veeva 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 Veeva @SqlUpdate("INSERT INTO NorthwindProducts (CategoryId, ProductName) values (:categoryId, :productName)") void insert(@Bind("categoryId") String categoryId, @Bind("productName") String productName); //request specific data from Veeva (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 Veeva

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

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:
  • 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 Veeva JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.veevavault.jar

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

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


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:veevavault:User=myuser;Password=mypassword;Server=localhost;Database=mydatabase;"); MyNorthwindProductsDAO dao =; //do stuff with the DAO dao.close();

Read Veeva Data

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

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

Write Veeva Data

It is also simple to write data to Veeva, 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 Veeva by integrating with the CData JDBC Driver for Veeva. Download a free trial and work with live Veeva data in custom Java applications today.