Learn more
 

Ready to get started?

Download a free trial of the Cosmos DB ODBC Driver to get started:

 Download Now

Learn more:

Cosmos DB Icon Cosmos DB ODBC Driver

The Cosmos DB ODBC Driver is a powerful tool that allows you to connect with live Cosmos DB document databases, directly from any applications that support ODBC connectivity.

Access Cosmos DB like you would a database - read, write, and update through a standard ODBC Driver interface.

In this article

Related articles

Connect to Cosmos DB Data in Ruby


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

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

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

To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

  • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
  • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

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 Cosmos DB Data

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

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