Ready to get started?

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

Download Now

Connect to Alfresco Data in JRuby

Create a simple JRuby app with access to live Alfresco data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Alfresco makes it easy to integrate connectivity to live Alfresco data in JRuby. This article shows how to create a simple JRuby app that connects to Alfresco data, executes a query, and displays the results.

Configure a JDBC Connection to Alfresco Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Alfresco\lib).

JRuby natively supports JDBC, so you can easily connect to Alfresco and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Alfresco JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.alfresco.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for Alfresco:

jdbc:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;

Create a JRuby 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:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Alfresco 2018/lib/cdata.jdbc.alfresco.jar' url = "jdbc:alfresco:User=MyUsername; Password=MyPassword; Format=Solr; InstanceUrl=api-explorer.alfresco.com;" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT DBID, Column1 FROM Alfresco") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Alfresco data with JRuby. To do so, simply run your file from the command line:

jruby -S AlfrescoSelect.rb

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