Ready to get started?

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

Download Now

Connect to SuiteCRM Data in Ruby

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

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

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

The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

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

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

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