Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Teams
, (opens new window)

SQL for Confluence
Results will update as you type.
  • SQL for Confluence
  • _InclusionsLibrary
  • _Archive
    • User's Guide
    • Administrator's Guide
      • Get Started - Configuration
      • Getting Help And Support
      • Configure Data Sources
      • Configure Data Source Profiles
      • Pro Tips
      • Better Together
      • Editions
      • Analytics Data
    • SQL Macro
    • SQL-file Macro
    • SQL-query Macro
    You‘re viewing this with anonymous access, so some content might be blocked.
    /
    Get Started - Configuration

    Get Started - Configuration

    May 29, 2019

    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


    OptionDefaultDescription
    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
    • READ_UNCOMMITTED
    • REPEATABLE_READ
    • 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.


    , multiple selections available,

    Need support? Create a request with our support team.

    Copyright © 2005 - 2025 Appfire | All rights reserved.

    {"serverDuration": 32, "requestCorrelationId": "9d5b3175365043f0b89e07906fc0d5c9"}