Connect to Buildkite Data in JRuby

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Buildkite makes it easy to integrate connectivity to live Buildkite data in JRuby. This article shows how to create a simple JRuby app that connects to Buildkite data, executes a query, and displays the results.

Configure a JDBC Connection to Buildkite Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Buildkite\lib).

JRuby natively supports JDBC, so you can easily connect to Buildkite and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

Start by setting the Profile connection property to the location of the Buildkite Profile on disk (e.g. C:\profiles\Buildkite.apip). Next, set the ProfileSettings connection property to the connection string for Buildkite (see below).

Buildkite API Profile Settings

Buildkite uses HTTP API key authentication. Your Buildkite API access token is used to authenticate requests as a Bearer token. You can generate or view your tokens at https://buildkite.com/user/api-access-tokens.

After setting the following connection properties, you are ready to connect:

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Buildkite API access token.
• Organization: Set this to your Buildkite organization slug (e.g. acme-inc).

Built-in Connection String Designer

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

java -jar cdata.jdbc.api.jar

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

Below is a typical JDBC connection string for Buildkite:

jdbc:api:Profile=C:\profiles\Buildkite.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Organization=your_organization_slug';

Create a JRuby App with Connectivity to Buildkite Data

Create a new Ruby file (for example: APISelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java'
require 'rubygems'
require 'C:/Program Files/CData/CData JDBC Driver for Buildkite 2018/lib/cdata.jdbc.api.jar'

url = "jdbc:api:Profile=C:\profiles\Buildkite.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;Organization=your_organization_slug';"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Id, BuildNumber FROM Builds")
while (rs.next) do
  puts rs.getString(1) + ' ' + rs.getString(2)
end

With the file completed, you are ready to display your Buildkite data with JRuby. To do so, simply run your file from the command line:

jruby -S APISelect.rb

Writing SQL-92 queries to Buildkite allows you to quickly and easily incorporate Buildkite data into your own JRuby applications. Download a free trial today!