Validate Confluence Data with QuerySurge

QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData JDBC Driver for Confluence, QuerySurge can work with live Confluence data. This article walks through connecting to Confluence data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Confluence data. When you issue complex SQL queries to Confluence, the driver pushes supported SQL operations, like filters and aggregations, directly to Confluence and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Confluence data using native data types.

Connecting to Confluence Data in QuerySurge

To connect to live Confluence data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.

Deploy the JDBC Driver

1. Download the CData JDBC Driver for Confluence installer, unzip the package, and run the JAR file to install the driver.
2. Once the driver is installed, stop the Agent Service.
3. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Confluence\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
4. Restart the Agent Service.

For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.

Configure a New Connection to Confluence

1. Log into QuerySurge and navigate to the Admin view.
2. Click Configuration -> Connections in the Administration Tree.
3. Click Add to create a new connection.
4. In the QuerySurge Connection Wizard, click Next.
5. Name the connection (e.g. CData JDBC Connection to Confluence).
6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
7. Set the Driver Class to cdata.jdbc.confluence.ConfluenceDriver and click Next.

8. Set the Connection URL using the necessary connection properties to authenticate with Confluence. Your Connection URL will look something like the following:

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

   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.

   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.
9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM Pages LIMIT 1) and click Next.
10. Click Test Connection to ensure the connection is configured properly and click Save to add the connection.

Once the connection is added, you can write SQL queries against your Confluence data in QuerySurge.

Compare Confluence Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying Confluence data with a QueryPair.

1. Select "Design Library" from the Design Menu
2. Click QueryPairs under QuerySurge Design
3. Click "Create New QueryPair"
4. Name the QueryPair and click Save
5. In either the Source or Target panes, select the connection created above (select the same connection to query Confluence twice or another connection to perform a comparison)
6. Write queries in the Editor for each pane, e.g. SELECT * FROM Pages
7. Click the "Design-Time Run" tab to execute the queries
8. When the query execution is finished, click "View Query Results" to see the Confluence data returned by the query

Download a free, 30-day trial of the CData JDBC Driver for Confluence and start working with your live Confluence data in QuerySurge. Reach out to our Support Team if you have any questions.