Ready to get started?

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

Download Now

Connect to Confluence Data in Aqua Data Studio

Access Confluence data from tools in Aqua Data Studio such as the Visual Query Builder and the Table Data Editor.

The CData JDBC Driver for Confluence integrates Confluence data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Confluence data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Confluence data source can then be accessed from Aqua Data Studio tools.

  1. In Aqua Data Studio, select Register Server from the Servers menu.
  2. In the Register Server form, select the 'Generic - JDBC' connection.
  3. Enter the following JDBC connection properties:
    • Name: Enter a name for the data source; for example, Confluence.
    • Driver Location: Click the Browse button and select the cdata.jdbc.confluence.jar file, located in the lib subfolder of the installation directory.
    • Driver: Enter the Driver's class name, cdata.jdbc.confluence.ConfluenceDriver.
    • URL: Enter the JDBC URL, which starts with jdbc:confluence: and is followed by a semicolon-separated list of connection properties.

      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.

      A typical JDBC URL is below:

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

Query Confluence Data

You can now query the tables exposed.