Connect to Confluence Data in JRuby

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

Configure a JDBC Connection to Confluence 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 Confluence\lib).

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

Obtaining an API Token

An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Connect Using a Confluence Cloud Account

To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):

• User: The user which will be used to authenticate with the Confluence server.
• APIToken: The API Token associated with the currently authenticated user.
• Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Connect Using a Confluence Server Instance

To connect to a Server instance, provide the following:

• User: The user which will be used to authenticate with the Confluence instance.
• Password: The password which will be used to authenticate with the Confluence server.
• Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.

Built-in Connection String Designer

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

java -jar cdata.jdbc.confluence.jar

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

Below is a typical JDBC connection string for Confluence:

jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;

Create a JRuby App with Connectivity to Confluence Data

Create a new Ruby file (for example: ConfluenceSelect.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 Confluence 2018/lib/cdata.jdbc.confluence.jar'

url = "jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;"
conn = java.sql.DriverManager.getConnection(url)
stmt = conn.createStatement
rs = stmt.executeQuery("SELECT Key, Name FROM Pages")
while (rs.next) do
 puts rs.getString(1) + ' ' + rs.getString(2)
end

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

jruby -S ConfluenceSelect.rb

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