Connect to Couchbase Data in JRuby

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

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

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

To connect using the Login method, set User, Password, and Server to the credentials for the account and the address of the server you want to connect to.

Built-in Connection String Designer

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

java -jar cdata.jdbc.couchbase.jar

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

Below is a typical JDBC connection string for Couchbase:

jdbc:couchbase:User=myuseraccount;Password=mypassword;Server=http://mycouchbaseserver;

Create a JRuby App with Connectivity to Couchbase Data

Create a new Ruby file (for example: CouchbaseSelect.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 Couchbase 2018/lib/cdata.jdbc.couchbase.jar'

url = "jdbc:couchbase:User=myuseraccount;Password=mypassword;Server=http://mycouchbaseserver;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT FirstName, TotalDue FROM Customer")
while (rs.next) do
 puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S CouchbaseSelect.rb

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