Get Started - Configuration - 11.x

Owned by Nisha Shantilal
Last updated: Oct 22, 2024
3 min read

On this page

The SQL for Confluence (Pro Edition) app version 11.x has removed the support for application server-defined data sources in Confluence 8.x. (Atlassian has ended support for the data source connections in Confluence 8.0. For more information, refer to Configuring a data source connection.)

In Confluence 8.x, we recommend reconfiguring the application server-defined data source profile to the connection string profile. For more information, refer to How to convert an application server defined data source profile to a connection string profile.

SQL for Confluence (Pro Edition) app version 11.x works seamlessly with Confluence 7.x (Confluence 7.4 to Confluence 7.20) versions, including support for application server-defined data sources (JNDI data source connections).

Summary

This Getting Started - Configuration page provides instructions for configuring the Appfire Atlassian app - SQL for Confluence version 11.0. It also lists the various configuration options with a detailed description, so that you can customize your app using the available options.

Configure SQL for Confluence

After upgrading or installing SQL for Confluence, follow the steps mentioned below to navigate to the Global configuration:

  1. Log in as a user with the system administrator's Global Permission.
  2. Select CONFLUENCE ADMINISTRATION > Manage apps from the Administration menu (cog icon: ) at the top right of your screen. Then scroll down to BOB SWIFT CONFIGURATION on the navigation bar to the left and choose SQL (Pro Edition). 
    (See: )

Global Configuration

This configuration page contains global settings that will control the behavior of data sources and data source profiles. Once saved, settings chosen on this page is applied to all macros across pages.

Table: configuration options explained

OptionDefaultDescription
Limit rows processedNo limit

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

  • No limit
  • 250 (Recommended)
  • 500
  • 1,000
  • 2,500
  • 5,000
  • 10,000
  • 15,000
  • 20,000
  • 25,000
Limit query timeNo limit

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

The following options are available from a selection list:

  • No limit
  • 1
  • 5
  • 10
  • 30
  • 60
  • 120 (Recommended)
  • 300
  • 600

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.
  • To know more about how the queryTimeout parameter value is evaluated, refer to the scenario page Limit query time - 11.x.
Transaction isolation levelRead committed

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

  • Read committed 
  • Read uncommitted
  • Repeatable read
  • Serializable
  • None

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

Restrict overriding global configuration limitsOff
  • Enable this option to prevent overriding and enforce the global configuration settings for the parameters, Limit rows processed, and Limit query time.
  • If this option is disabled and the parameters Limit rows processed and Limit query time are configured in a profile or SQL macro, refer to the Common SQL parameters - 11.x page to know the order in which these parameter values are evaluated.
Confluence 8.x compatibility warning messageOff
  • By default, the Confluence 8.x compatibility warning message is shown on the View and modify data source profiles page (Applies to Confluence 8.x).
  • Enable this option to hide the Confluence 8.x compatibility warning message.
  • Enabling this option is recommended only after reconfiguring the global data source profiles. To reconfigure the global data source profiles, refer to How to convert an application server defined data source profile to a connection string profile.
Disable anti-XSS modeOff

Anti-XSS mode reduces exposure to XSS exploits related to SQL app macros. By default, the app respects Confluence's global Anti-XSS settings. This configuration allows an administrator to globally turn off anti-XSS mode only for the SQL Macro. An alternative method is to enable groups or individuals from using the disableAntiXss parameter to control this for individual Macros. This may be necessary for queries that require producing HTML constructs. 

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

Help us improve the productONEnable this option to report usage data that helps us to improve the app continually. The app does not send any private user data or personally identifiable information. To learn more about what is shared, refer to Analytics data.

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.