Learn more
 

Ready to get started?

Download a free trial of the IBM Cloud Object Storage Driver to get started:

 Download Now

Learn more:

IBM Cloud Object Storage Icon IBM Cloud Object Storage JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with IBM Cloud Object Storage.

In this article

Related articles

Connect to IBM Cloud Object Storage Data in JRuby


Create a simple JRuby app with access to live IBM Cloud Object Storage data.

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

Configure a JDBC Connection to IBM Cloud Object Storage 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 IBM Cloud Object Storage\lib).

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

Register a New Instance of Cloud Object Storage

If you do not already have Cloud Object Storage in your IBM Cloud account, follow the procedure below to install an instance of SQL Query in your account:

  1. Log in to your IBM Cloud account.
  2. Navigate to the page, choose a name for your instance and click Create. You will be redirected to the instance of Cloud Object Storage you just created.

Connecting using OAuth Authentication

There are certain connection properties you need to set before you can connect. You can obtain these as follows:

API Key

To connect with IBM Cloud Object Storage, you need an API Key. You can obtain this as follows:

  1. Log in to your IBM Cloud account.
  2. Navigate to the Platform API Keys page.
  3. On the middle-right corner click "Create an IBM Cloud API Key" to create a new API Key.
  4. In the pop-up window, specify the API Key name and click "Create". Note the API Key as you can never access it again from the dashboard.

Cloud Object Storage CRN

If you have multiple accounts, you will need to specify the CloudObjectStorageCRN explicitly. To find the appropriate value, you can:

  • Query the Services view. This will list your IBM Cloud Object Storage instances along with the CRN for each.
  • Locate the CRN directly in IBM Cloud. To do so, navigate to your IBM Cloud Dashboard. In the Resource List, Under Storage, select your Cloud Object Storage resource to get its CRN.

Connecting to Data

You can now set the following to connect to data:

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • ApiKey: Set this to your API key which was noted during setup.
  • CloudObjectStorageCRN (Optional): Set this to the cloud object storage CRN you want to work with. While the connector attempts to retrieve this automatically, specifying this explicitly is recommended if you have more than Cloud Object Storage account.

When you connect, the connector completes the OAuth process.

  1. Extracts the access token and authenticates requests.
  2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Built-in Connection String Designer

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

java -jar cdata.jdbc.ibmcloudobjectstorage.jar

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

Below is a typical JDBC connection string for IBM Cloud Object Storage:

jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;

Create a JRuby App with Connectivity to IBM Cloud Object Storage Data

Create a new Ruby file (for example: IBMCloudObjectStorageSelect.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 IBM Cloud Object Storage 2018/lib/cdata.jdbc.ibmcloudobjectstorage.jar' url = "jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Key, Etag FROM Objects") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

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

jruby -S IBMCloudObjectStorageSelect.rb

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