Learn more
 

Ready to get started?

Download a free trial of the Azure DevOps Driver to get started:

 Download Now

Learn more:

Azure DevOps Icon Azure DevOps JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Azure DevOps.

In this article

Related articles

Create a Data Access Object for Azure DevOps Data using JDBI


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

Create a DAO for the Azure DevOps Builds 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 MyBuildsDAO { //request specific data from Azure DevOps (String type is used for simplicity) @SqlQuery("SELECT BuildNumber FROM Builds WHERE Reason = :reason") String findBuildNumberByReason(@Bind("reason") String reason); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Azure DevOps

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

You can connect to your Azure DevOps account by providing the Organization and PersonalAccessToken.

Obtaining a Personal Access Token

A PersonalAccessToken is necessary for account authentication.

To generate one, log in to your Azure DevOps Organization account and navigate to Profile -> Personal Access Tokens -> New Token. The generated token will be displayed.

If you wish to authenticate to Azure DevOps using OAuth refer to the online 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 Azure DevOps JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.azuredevops.jar

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

A connection string for Azure DevOps will typically look like the following:

jdbc:azuredevops:AuthScheme=Basic;Organization=MyAzureDevOpsOrganization;ProjectId=MyProjectId;PersonalAccessToken=MyPAT;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:azuredevops:AuthScheme=Basic;Organization=MyAzureDevOpsOrganization;ProjectId=MyProjectId;PersonalAccessToken=MyPAT;InitiateOAuth=GETANDREFRESH"); MyBuildsDAO dao = dbi.open(MyBuildsDAO.class); //do stuff with the DAO dao.close();

Read Azure DevOps Data

With the connection open to Azure DevOps, simply call the previously defined method to retrieve data from the Builds entity in Azure DevOps.

//disply the result of our 'find' method String buildNumber = dao.findBuildNumberByReason("Manual"); System.out.println(buildNumber);

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