Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Log in as a user with the Confluence Administrators Global Permission.
  2. Select Add-ons from the Administration menu (cog icon: ) at the top right of your screen. Then scroll down to Bob Swift Configuration on the left-hand nav bar and choose SQL Configuration (see: ).
  3. Select View and Modify Data Source Profiles (see:  ) from the top navigation.
  4. Click on the  button.

The Add Profile screen will provide you with two setup options:

  • Simple - this is the most straightforward way to connect to your database.
  • By connection string - use this option if you want to specify additional parameters and are comfortable constructing a database URL. 

Depending on the setup type, you'll be prompted for the following information.

Setup typeFieldDescription
SimpleDatabase typeThey type of database you are connecting to.
SimpleHostnameThis is the hostname or IP address of your database server.  
SimplePortThis is the port used to access your database on the server it is running against. 
SimpleDatabase This is the name of your database. 
BothDriver classThe class of JDBC driver that you will use to connect to your database (e.g., com.mysql.jdbc.Driver, or org.postgresql.Driver)
BothDriver JAR location

The path on your Confluence server where the JDBC driver is located.

Tip
titleStart with an absolute file reference

Usually better to start with an absolute reference to make sure it is working. Relative references are more maintainable, but can be problematic especially on Windows. After it is working, you can experiment with relative references.


By connection stringConnection stringThe database URL is entered in this format (SQLServer example):
jdbc:sqlserver://<hostname>:<port>;database=<database>

For example:  
jdbc:sqlserver://yourserver:1433;database=confluence

BothUsernameThis is the username of your dedicated database user. 
BothPasswordThis is the password for your dedicated database user.

Extended Parameters

Data Source Profiles allow for the configuration of extended parameter options. These profile-wide settings will be used by all SQL Macros if not overridden at the Macro-level.

Table: extended parameter options explained

ParameterMacro ParameterDefaultDescription
Limit rows processedlimitno rows

View Data Source Profiles

...