Learn more
 

Connect to Kintone Data in Ruby


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

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

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

In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

  • Url: The URL of your account.
  • GuestSpaceId: Optional. Set this when using a guest space.

Authenticating with Kintone

Kintone supports the following authentication methods.

Using Password Authentication

You must set the following to authenticate:

  • User: The username of your account.
  • Password: The password of your account.

Using Basic Authentication

If the basic authentication security feature is set on the domain, supply the additional login credentials with BasicAuthUser and BasicAuthPassword. Basic authentication requires these credentials in addition to User and Password.

Using Client SSL

Instead of basic authentication, you can specify a client certificate to authenticate. Set SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword. Additionally, set User and Password to your login credentials.

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

Create a new Ruby file (for example: KintoneSelect.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 Kintone Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT CreatorName, Text FROM Comments WHERE AppId = '1354841'") #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 Kintone data with Ruby. To do so, simply run your file from the command line:

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

Ready to get started?

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

 Download Now

Learn more:

Kintone Icon Kintone ODBC Driver

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

Access Kintone applications and databases from virtually anywhere through a standard ODBC Driver interface.

In this article

Related articles