Load Confluence Data to a Database Using Embulk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Confluence JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Confluence.



Use CData JDBC Driver for Confluence with the open source ETL/ELT tool Embulk to load Confluence data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Confluence, Embulk easily loads data from Confluence to any supported destination. In this article, we explain how to use the CData JDBC Driver for Confluence in Embulk to load Confluence data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Confluence data. When you issue complex SQL queries to Confluence, the driver pushes supported SQL operations, like filters and aggregations, directly to Confluence and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to Confluence Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Confluence\lib).

Embulk supports JDBC connectivity, so you can easily connect to Confluence and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Confluence.

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;

Load Confluence Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
  2. embulk gem install embulk-input-jdbc
  3. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load Confluence data into MySQL using Embulk.

Create a Job to Load Confluence Data

Start by creating a config file in Embulk, using a name like confluence-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for Confluence, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.confluence.ConfluenceDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (confluence-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Confluence 20xx\lib\cdata.jdbc.confluence.jar driver_class: cdata.jdbc.confluence.ConfluenceDriver url: jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York; table: "Pages" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Pages" mode: insert

After creating the file, run the Embulk job.

embulk run confluence-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Confluence Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Confluence 20xx\lib\cdata.jdbc.confluence.jar driver_class: cdata.jdbc.confluence.ConfluenceDriver url: jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York; query: "SELECT Key, Name FROM Pages WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Pages" mode: insert

More Information & Free Trial

By using CData JDBC Driver for Confluence as a connector, Embulk can integrate Confluence data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.