Ready to get started?

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

Download Now

Connect to Gmail Data in JRuby

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

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

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

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

There are two ways to authenticate to Gmail. Before selecting one, first ensure that you have enabled IMAP access in your Gmail account settings. See the "Connecting to Gmail" section under "Getting Started" in the installed documentation for a guide.

The User and Password properties, under the Authentication section, can be set to valid Gmail user credentials.

Alternatively, instead of providing the Password, you can use the OAuth authentication standard. To access Google APIs on behalf on individual users, you can use the embedded credentials or you can register your own OAuth app.

OAuth also enables you to use a service account to connect on behalf of users in a Google Apps domain. To authenticate with a service account, you will need to register an application to obtain the OAuth JWT values.

In addition to the OAuth values, you will need to provide the User. See the "Getting Started" chapter in the help documentation for a guide to using OAuth.

Built-in Connection String Designer

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

java -jar cdata.jdbc.gmail.jar

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

Below is a typical JDBC connection string for Gmail:

jdbc:gmail:User=username;Password=password;

Create a JRuby App with Connectivity to Gmail Data

Create a new Ruby file (for example: GmailSelect.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 Gmail 2018/lib/cdata.jdbc.gmail.jar' url = "jdbc:gmail:User=username;Password=password;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Subject, Size FROM Inbox") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S GmailSelect.rb

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