Connect to Highrise Data in Ruby

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Highrise ODBC Driver

The Highrise ODBC Driver is a powerful tool that allows you to connect with live Highrise account data, directly from any applications that support ODBC connectivity.

Access Highrise data like you would a database - read, write, and update Accounts, Deals, Emails, People, Tasks, etc. through a standard ODBC Driver interface.



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

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

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

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

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 Highrise Data

Create a new Ruby file (for example: HighriseSelect.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 Highrise Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Name, Price FROM Deals") #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 Highrise data with Ruby. To do so, simply run your file from the command line:

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