Ready to get started?

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

Download Now

Analyze Confluence Data in R

Use standard R functions and the development environment of your choice to analyze Confluence data with the CData JDBC Driver for Confluence.

Access Confluence data with pure R script and standard SQL on any machine where R and Java can be installed. You can use the CData JDBC Driver for Confluence and the RJDBC package to work with remote Confluence data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Confluence and visualize Confluence data by calling standard R functions.

Install R

You can match the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running open R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open 3.2.3, which is preconfigured to install packages from the Jan. 1, 2016 snapshot of the CRAN repository. This snapshot ensures reproducibility.

Load the RJDBC Package

To use the driver, download the RJDBC package. After installing the RJDBC package, the following line loads the package:

library(RJDBC)

Connect to Confluence as a JDBC Data Source

You will need the following information to connect to Confluence as a JDBC data source:

  • Driver Class: Set this to cdata.jdbc.confluence.ConfluenceDriver
  • Classpath: Set this to the location of the driver JAR. By default this is the lib subfolder of the installation folder.

The DBI functions, such as dbConnect and dbSendQuery, provide a unified interface for writing data access code in R. Use the following line to initialize a DBI driver that can make JDBC requests to the CData JDBC Driver for Confluence:

driver <- JDBC(driverClass = "cdata.jdbc.confluence.ConfluenceDriver", classPath = "MyInstallationDir\lib\cdata.jdbc.confluence.jar", identifier.quote = "'")

You can now use DBI functions to connect to Confluence and execute SQL queries. Initialize the JDBC connection with the dbConnect function.

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 sample dbConnect call, including a typical JDBC connection string:

conn <- dbConnect(driver,"jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")

Schema Discovery

The driver models Confluence APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

dbListTables(conn)

Execute SQL Queries

You can use the dbGetQuery function to execute any SQL query supported by the Confluence API:

pages <- dbGetQuery(conn,"SELECT Key, Name FROM Pages WHERE Id = '10000'")

You can view the results in a data viewer window with the following command:

View(pages)

Plot Confluence Data

You can now analyze Confluence data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(pages$Name, main="Confluence Pages", names.arg = pages$Key, horiz=TRUE)