Ready to get started?

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

Download Now

Connect to BigCommerce Data in Ruby

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

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

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

BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

  1. Log in to your BigCommerce account.
  2. From the Home Page, select Advanced Settings > API Accounts.
  3. Click Create API Account.
  4. A text box named API Path will appear on your screen.
  5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
  6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
  7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.

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

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

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