Ready to get started?

Learn more about CData Cloud Hub or sign up for a free trial:

Learn More

Connect to Confluence Data as a Federated Tables in MySQL

Use the CData Cloud Hub to set up federated tables for Confluence data in MySQL .

You can use the CData Cloud Hub to set up federated tables in MySQL for Confluence data. The Cloud Hub provides a MySQL interface for Confluence: After configuring a virtual MySQL database for Confluence, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Confluence data just as you would local MySQL tables.

The CData Cloud Hub provides a pure MySQL, cloud-to-cloud interface for Confluence, allowing you to easily query live Confluence data alongside existing MySQL data — all without replicating the data. Using optimized data processing out of the box, the CData Cloud Hub pushes all supported SQL operations (filters, JOINs, etc) directly to Confluence, leveraging server-side processing to quickly return Confluence data.

Create a Virtual MySQL Database for Confluence Data

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

  1. Login to Cloud Hub and click Databases.
  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 Test Database.
  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 data from any MySQL client.

Create a FEDERATED Server and Tables for Confluence Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the Cloud Hub. Note that the username and password of the FEDERATED server must match a user account you defined on the Cloud Hub.

CREATE SERVER fedConfluence
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'cloud_hub_user', PASSWORD 'cloud_hub_passwd', HOST 'myinstance.cdatacloud.net', PORT 3306, DATABASE 'confluencedb');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Pages). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_pages (
  ...,
  key  TYPE(LEN),
  name  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=utf8
CONNECTION='fedConfluence/Pages';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the Cloud Hub using any MySQL client and run SHOW COLUMNS FROM Pages to get the table schema.

Execute Queries

You can now execute queries to the Confluence FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Confluence. Refer to the following example:

SELECT 
  fed_pages.key, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_pages 
ON 
  local_table.foreign_key = fed_pages.key;