Ready to get started?

Learn more about the CData JDBC Driver for MarkLogic or download a free trial:

Download Now

Create a Data Access Object for MarkLogic Data using JDBI

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

Create a DAO for the MarkLogic Customer 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 MyCustomerDAO { //insert new data into MarkLogic @SqlUpdate("INSERT INTO Customer (Id, TotalDue) values (:id, :totalDue)") void insert(@Bind("id") String id, @Bind("totalDue") String totalDue); //request specific data from MarkLogic (String type is used for simplicity) @SqlQuery("SELECT TotalDue FROM Customer WHERE Id = :id") String findTotalDueById(@Bind("id") String id); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to MarkLogic

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

Set User, Password, and Server to the credentials for the MarkLogic account and the address of the server you want to connect to. You should also specify the REST API Port if you want to use a specific instance of a REST Server.

Built-in Connection String Designer

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

java -jar cdata.jdbc.marklogic.jar

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

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

jdbc:marklogic:User='myusername';Password='mypassword';Server='http://marklogic';

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:marklogic:User='myusername';Password='mypassword';Server='http://marklogic';"); MyCustomerDAO dao = dbi.open(MyCustomerDAO.class); //do stuff with the DAO dao.close();

Read MarkLogic Data

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

//disply the result of our 'find' method String totalDue = dao.findTotalDueById("1"); System.out.println(totalDue);

Write MarkLogic Data

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

//add a new entry to the Customer entity dao.insert(newId, newTotalDue);

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