Learn more
 

Ready to get started?

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

 Download Now

Learn more:

Confluence Icon Confluence ODBC Driver

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

Access Confluence data like you would a database - read, write, and update Confluence Attachments, Comments, Groups, Users, etc. through a standard ODBC Driver interface.

In this article

Related articles

Connect to Confluence Data in Ruby


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

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

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

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.

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 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:

#connect to the DSN require 'DBI' cnxn = DBI.connect('DBI:ODBC:CData Confluence Source','','') #execute a SELECT query and store the result set resultSet = cnxn.execute("SELECT Key, Name FROM Pages WHERE Id = '10000'") #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 Confluence data with Ruby. To do so, simply run your file from the command line:

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