How to connect to Confluence Data from IntelliJ

The CData JDBC Driver for Confluence enables you to access Confluence as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Confluence data in IntelliJ.

Create a JBDC Data Source for Confluence

Follow the steps below to add the driver JAR and define connection properties required to connect to Confluence data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.confluence.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.confluence.ConfluenceDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:confluence: and includes connection properties separated with semicolons.

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

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

Edit and Save Confluence Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.