Connect to CockroachDB Data in Ruby

The CData ODBC Driver for CockroachDB makes it easy to integrate connectivity to live CockroachDB data in Ruby. This article shows how to create a simple Ruby app that connects to CockroachDB data, executes a query, and displays the results.

Create an ODBC Connection to CockroachDB Data

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Set the following to connect to CockroachDB.

• Server: The host name or IP address of the server.
• Port: The port number of the CockroachDB server. If not specified, the default port is 26257.
• Database: The name of the Cockroach database. If not specified, you connect to the user's default database.
• User: The Cockroach DB user account used to authenticate.
• Password: The password used to authenticate the user.

Installing Ruby and Necessary Gems

If you do not have Ruby installed, refer to the Ruby installation page. With Ruby installed, you will need to install the ruby-dbi, dbd-odbc, and ruby-odbc gems:

gem install dbi
gem install dbd-odbc
gem install ruby-odbc

Create a Ruby App with Connectivity to CockroachDB Data

Create a new Ruby file (for example: CockroachDBSelect.rb) and open it in a text editor. Copy the following code into your file:

#connect to the DSN
require 'dbi'
cnxn = DBI.connect('DBI:ODBC:CData CockroachDB Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT ShipName, ShipCity FROM Orders WHERE ShipCountry = 'USA'")

#display the names of the columns
resultSet.column_names.each do |name|
 print name, "\t"
end
puts

#display the results
while row = resultSet.fetch do
 (0..resultSet.column_names.size - 1).each do |n|
 print row[n], "\t"
 end
 puts
end
resultSet.finish

#close the connection
cnxn.disconnect if cnxn

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

ruby CockroachDBSelect.rb

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