Query Confluence Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to Confluence data as if it were a MySQL database. This article shows how to create a virtual database for Confluence in Connect and work with live Confluence data in MySQL Workbench.

Create a Virtual MySQL Database for Confluence Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect and click Connections.
2. Select "Confluence" from Available Data Sources.
3. Enter the necessary authentication properties 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.
4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Confluence from MySQL Workbench.

Query Confluence from MySQL Workbench

The steps below outline connecting to the virtual Confluence database in Connect from MySQL Workbench and issuing basic queries to work with live Confluence data.

Connect to Confluence through Connect

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData Connect).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

Query Confluence Data

1. Open the connection you just created (CData Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Confluence data, like SELECT * FROM confluencedb.Pages;

With access to live Confluence data from MySQL Workbench, you can easily query and update Confluence, just like you would a MySQL database. Request a demo of the CData Connect and start working with Confluence just like a MySQL database today.