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 DBeaver

Manage Confluence data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for Confluence implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Confluence data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Confluence Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.confluence.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the ConfluenceDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.confluence.ConfluenceDriver.
  6. Add jdbc:confluence: in the URL Template field.

Create a Connection to Confluence Data

Follow the steps below to add credentials and other required connection properties.

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to 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 connection string:

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

Query Confluence Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.