Connect to Confluence Data in NetBeans

The CData JDBC Driver for Confluence integrates connectivity to live Confluence data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to Confluence data in NetBeans. You will create a connection and load Confluence data in the Table Editor.

Create a JDBC Data Source for Confluence in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

• Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.confluence.jar file. The driver JAR is located in the lib subfolder of the installation directory.
• Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.confluence.ConfluenceDriver from the menu.
• Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

1. In the Service window, right-click the Database node and click New Connection.

2. In the New Connection Wizard, enter the following connection properties:

   • Driver Name: In the menu, select the CData JDBC Driver for Confluence.
   • User Name: Enter the username. This can also be defined in the JDBC URL.
   • Password: Enter the password. This can also be defined in the JDBC URL.

   • JDBC URL: Specify the JDBC URL.

     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.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

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

Query Confluence Data

To connect to Confluence data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data..