Connect to Azure Synapse Data in Ruby

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

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

Connecting to Azure Synapse

In addition to providing authentication (see below), set the following properties to connect to a Azure Synapse database:

• Server: The server running Azure. You can find this by logging into the Azure portal and navigating to Azure Synapse Analytics -> Select your database -> Overview -> Server name.
• Database: The name of the database, as seen in the Azure portal on the Azure Synapse Analytics page.

Authenticating to Azure Synapse

Connect to Azure Synapse using the following properties:

• User: The username provided for authentication with Azure.
• Password: The password associated with the authenticating 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 Azure Synapse Data

Create a new Ruby file (for example: AzureSynapseSelect.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 AzureSynapse Source','','')

#execute a SELECT query and store the result set
resultSet = cnxn.execute("SELECT Id, ProductName FROM Products WHERE ProductName = 'Konbu'")

#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 Azure Synapse data with Ruby. To do so, simply run your file from the command line:

ruby AzureSynapseSelect.rb

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