We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Connect to Phoenix Data in Ruby
Connect to Phoenix data in Ruby with ruby-dbi, dbd-odbc, and ruby-odbc.
The CData ODBC Driver for Phoenix makes it easy to integrate connectivity to live Phoenix data in Ruby. This article shows how to create a simple Ruby app that connects to Phoenix data, executes a query, and displays the results.
Create an ODBC Connection to Phoenix 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.
Connect to Apache Phoenix via the Phoenix Query Server. Set the Server and Port (if different from the default port) properties to connect to Apache Phoenix. The Server property will typically be the host name or IP address of the server hosting Apache Phoenix.
Authenticating to Apache Phoenix
By default, no authentication will be used (plain). If authentication is configured for your server, set AuthScheme to NEGOTIATE and set the User and Password properties (if necessary) to authenticate through Kerberos.
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 Phoenix Data
Create a new Ruby file (for example: ApachePhoenixSelect.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 ApachePhoenix Source','','')
#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Id, Column1 FROM MyTable WHERE Id = '123456'")
#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 Phoenix data with Ruby. To do so, simply run your file from the command line:
ruby ApachePhoenixSelect.rb
Writing SQL-92 queries to Phoenix allows you to quickly and easily incorporate Phoenix data into your own Ruby applications. Download a free trial today!