Ready to get started?

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

Download Now

Connect to Alfresco Data in Ruby

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

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

Create an ODBC Connection to Alfresco 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 connect to Alfresco, the following connection properties must be supplied: User, Password, and InstanceUrl. User and Password correspond to the login credentials that you use to access Alfresco in a web browser. InstanceUrl corresponds to the Alfresco instance you will be querying. For instance, if you expect your queries to hit https://search-demo.dev.alfresco.me/alfresco/api/-default-/public/search/versions/1/sql, you should supply search-demo.dev.alfresco.me for InstanceUrl.

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

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

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