Ready to get started?

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

Download Now

Connect to Airtable Data in Ruby

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

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

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

APIKey, BaseId and TableNames parameters are required to connect to Airtable. ViewNames is an optional parameter where views of the tables may be specified.

  • APIKey : API Key of your account. To obtain this value, after logging in go to Account. In API section click Generate API key.
  • BaseId : Id of your base. To obtain this value, it is in the same section as the APIKey. Click on Airtable API, or navigate to https://airtable.com/api and select a base. In the introduction section you can find "The ID of this base is appxxN2ftedc0nEG7."
  • TableNames : A comma separated list of table names for the selected base. These are the same names of tables as found in the UI.
  • ViewNames : A comma separated list of views in the format of (table.view) names. These are the same names of the views as found in the UI.

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

Create a new Ruby file (for example: AirtableSelect.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 Airtable Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Id, Column1 FROM SampleTable_1 WHERE Column1 = 'Value1'") #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 Airtable data with Ruby. To do so, simply run your file from the command line:

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