Ready to get started?

Learn more about the CData ODBC Driver for HPCC or download a free trial:

Download Now

Connect to HPCC Systems Data in Ruby

Connect to HPCC Systems data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.

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

Create an ODBC Connection to HPCC Systems 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.

To connect, set the following connection properties: Set URL to the machine name or IP address of the server and the port the server is running on, for example, https://server:port. The User and Password are required to authenticate to the HPCC Systems cluster specified in the URL. Note that LDAP authentication is not currently supported by our ODBC driver.

Set Version to the WsSQL Web server version. Note that if you have not already done so, you will need to install the WsSQL service on the HPCC Systems server. The WsSQL Web service is used to interact with the underlying HPCC Systems platform.

Set Cluster to the target cluster.

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 HPCC Systems Data

Create a new Ruby file (for example: HPCCSelect.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 HPCC Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT SUM(hpcc::test::orders.Price), hpcc::test::customers.CustomerName FROM hpcc::test::orders INNER JOIN hpcc::test::customers ON hpcc::test::orders.CustomerId=hpcc::test::customers.CustomerId;GROUP BY hpcc::test::customers.CustomerName") #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 HPCC Systems data with Ruby. To do so, simply run your file from the command line:

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