Ready to get started?

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

 Download Now

Learn more:

Salesforce Icon Salesforce JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Salesforce account data including Leads, Contacts, Opportunities, Accounts, and more!

Connect to Salesforce Data in JRuby



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

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

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

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

There are several authentication methods available for connecting to Salesforce: Login, OAuth, and SSO. The Login method requires you to have the username, password, and security token of the user.

If you do not have access to the username and password or do not wish to require them, you can use OAuth authentication.

SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and TokenUrl connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the help documentation for more information.

Built-in Connection String Designer

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

java -jar cdata.jdbc.salesforce.jar

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

Below is a typical JDBC connection string for Salesforce:

jdbc:salesforce:User=username;Password=password;SecurityToken=Your_Security_Token;

Create a JRuby App with Connectivity to Salesforce Data

Create a new Ruby file (for example: SalesforceSelect.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 Salesforce 2018/lib/cdata.jdbc.salesforce.jar' url = "jdbc:salesforce:User=username;Password=password;SecurityToken=Your_Security_Token;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Industry, AnnualRevenue FROM Account") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S SalesforceSelect.rb

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