The CData JDBC Driver for Confluence enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Confluence using wizards in RazorSQL.
Create a JDBC Data Source for Confluence Data
- Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
- In the Connection Wizard that appears, set the following properties:
- Driver Location: Set this property to the path to the lib subfolder in the installation directory.
- Driver Class: Set the driver class to cdata.jdbc.confluence.ConfluenceDriver.
- Username: Enter the username. (This property can also be set in the JDBC URL.)
- Password: Enter the password. (This property can also be set in the JDBC URL.)
JDBC URL: Enter connection parameters. The JDBC URL begins 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 the following:
jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
Query Confluence Data and Select Tables
After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.