Query Confluence Data as a SQL Server Database in Node.js

You can use CData Connect AI to query Confluence data through a SQL Server interface. Follow the procedure below to create a virtual database for Confluence in Connect AI and start querying using Node.js.

CData Connect AI provides a pure MySQL, cloud-to-cloud interface for Confluence, allowing you to easily query live Confluence data in Node.js — without replicating the data to a natively supported database. As you query data in Node.js, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc) directly to Confluence, leveraging server-side processing to quickly return Confluence data.

Configure Confluence Connectivity for NodeJS

Connectivity to Confluence from NodeJS is made possible through CData Connect AI. To work with Confluence data from NodeJS, we start by creating and configuring a Confluence connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "Confluence" from the Add Connection panel
👁 Selecting a data source

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.
   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Confluence Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Confluence data from Node.js.

Query Confluence from Node.js

The following example shows how to define a connection and execute queries to Confluence with the SQL Server module. You will need the following information:

• server: tds.cdata.com
• port: 14333
• user: a Connect AI user (e.g. [email protected])
• password: the PAT for the above user
• database: The connection you configured for Confluence (Confluence1)

Connect to Confluence data and start executing queries with the code below:

var sql = require('mssql')
var config = {
	server: 'tds.cdata.com',
	port: 14333, 
	user: '[email protected]', //update me
	password: 'CONNECT_USER_PAT', //update me	
	options: {
		encrypt: true,
		database: 'Confluence1'
	}
}

sql.connect(config, err => { 
 if(err){
 throw err ;
 }
 new sql.Request().query('SELECT * FROM Pages', (err, result) => {
 console.dir(result)
 })
 
});

sql.on('error', err => {
 console.log("SQL Error: " ,err);
})