Ready to get started?

Download a free trial of the Microsoft OneDrive Driver to get started:

 Download Now

Learn more:

Microsoft OneDrive Icon Microsoft OneDrive JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft OneDrive.

Create a Data Access Object for Microsoft OneDrive Data using JDBI

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

Create a DAO for the Microsoft OneDrive Files 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 MyFilesDAO { //request specific data from Microsoft OneDrive (String type is used for simplicity) @SqlQuery("SELECT Name FROM Files WHERE Id = :id") String findNameById(@Bind("id") String id); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Microsoft OneDrive

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

OneDrive uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the OAuth section of the Help documentation for an authentication guide.

Built-in Connection String Designer

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

java -jar cdata.jdbc.onedrive.jar

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

A connection string for Microsoft OneDrive 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:onedrive:OAuthClientId=MyApplicationId;OAuthClientSecret=MySecretKey;OAuthCallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH"); MyFilesDAO dao =; //do stuff with the DAO dao.close();

Read Microsoft OneDrive Data

With the connection open to Microsoft OneDrive, simply call the previously defined method to retrieve data from the Files entity in Microsoft OneDrive.

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

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