Ready to get started?

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

Download Now

Query Confluence Data in MySQL Workbench

Execute MySQL queries against live Confluence data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for Confluence to query Confluence data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Confluence data in MySQL Workbench.

Connect to Confluence Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Confluence data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Confluence from MySQL Workbench

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

Connect to Confluence through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for Confluence).
  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 SQL Gateway for Confluence).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve Confluence data, like SELECT * FROM `CData Confluence Sys`.Pages;

With access to live Confluence data from MySQL Workbench, you can easily query and update Confluence, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for Confluence and the CData SQL Gateway.