Ready to get started?

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

 Download Now

Learn more:

GitHub Icon GitHub JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with GitHub.

Connect to GitHub Data in JRuby



Create a simple JRuby app with access to live GitHub data.

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

Configure a JDBC Connection to GitHub 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 GitHub\lib).

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

GitHub uses the OAuth 2 authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Getting Started chapter of the CData 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 GitHub JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.github.jar

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

Below is a typical JDBC connection string for GitHub:

jdbc:github:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=GETANDREFRESH

Create a JRuby App with Connectivity to GitHub Data

Create a new Ruby file (for example: GitHubSelect.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 GitHub 2018/lib/cdata.jdbc.github.jar' url = "jdbc:github:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Name, Email FROM Users") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S GitHubSelect.rb

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