Get Started - Configuration

On this page

Configure SQL for Confluence

After upgrading or installing SQL for Confluence, navigate to the Global Configuration screen by:

  1. Logging in as a user with the System Administrator Global Permission.
  2. Selecting 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: )

Global Configuration

This configuration page contains global settings that will control the behavior of Data Sources and Data Source Profiles. Once saved, settings provided on this page are applicable to Data Sources and Data Source Profiles configured sitewide.

Table: configuration options explained

Limit rows processedNo limit

The maximum number of rows that will be processed and displayed by SQL macros. This prevents queries that result in a large number of rows from using excessive resources. Individual queries can use the limit parameter to override this value. The following options are available for selection:

  • No limit
  • 250 - Recommended
  • 500
  • 1000
  • 2500
  • 5000
  • 10000
  • 15000
Limit query timeNo limit

The number of seconds that a query can take before we force a timeout. This prevents queries that take too long from impacting other users. Individual queries can use the queryTimeout parameter to override this value.

Note, this parameter:

  • Requires that the target database and JDBC driver support the remote query timeout server configuration option (queryTimeout).
  • Administrators can limit (or control) who can use this parameter through the use of our Macro Security for Confluence app.
Transaction isolation levelREAD_COMMITTED

Default level used if macro parameter does not specify a specific level. The following options are available for selection:

  • READ_COMMITTED - Default value
  • None

Note this parameter requires that the target database and JDBC driver support transaction isolation levels.

Disable anti-XSS modeOFF

Anti-XSS mode reduces exposure to XSS exploits related to SQL add-on macros. By default, the app respects Confluence's global Anti-XSS setting. This configuration allows an administrator to globally turn off anti-XSS mode only for the SQL Macro of this app. An alternative is to enable groups or individuals to use the disableAntiXss parameter to control this on an individual Macro basis. This may be necessary for queries wanting to produce HTML constructs. 

Note that disableAntiXss parameter use can be controlled by our Macro Security for Confluence app.

Send statisticsONAs part of building awesome apps, we sometimes need to gather some basic usage data to continually improve. No private user data is sent. For more details on what data is being sent, please refer to this page.

Next Step: Understanding Data Sources

With global settings now in place, the next step is to bring you up to speed on Data Sources and Data Source Profiles.