App configuration - Cloud
This guide contains information on how the app must be configured for optimal performance.
Compatibility of databases with the app:
MySQL is supported from version 8 (2018) onwards.
SQL Server is supported from version 2005 onwards.
Postgres is supported from version 9.5 (2016) onwards.
After migrating or installing SQL for Confluence cloud app, navigate to the SQL for Confluence Configuration screen:
Log in with the system administrator global permission.
Navigate to > Settings > Atlassian Marketplace on the sidebar, or search SQL in the search text box.
Click SQL Configuration to manage the app configuration.
The following configuration settings are available:
Global configuration
Here, a Confluence administrator can configure the global behavior of SQL for Confluence macros.
Parameter | Default value | Description |
|---|---|---|
Limit rows processed | 250 | Select the maximum number of rows to be processed and displayed on Confluence pages. This setting prevents queries from using excessive resources that can result in a large number of rows. Individual queries can use the Maximum number of rows to retrieve and display parameter in the macro editor to override this value. The following options are available from a selection list:
Refer to this note to know more about the default behavior for common parameters available in the configuration as well as macro editor. |
Limit query time | 120 | Select the time in 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 Maximum number of seconds for query to run parameter in the macro editor to override this value. The following options are available from a selection list:
|
Rows per page | 10 | Select the number of rows to be displayed on a page. The total number of rows fetched depends on the limit applied on the number of rows to be processed (in Limit rows processed and Maximum number of rows to retrieve and display parameter in the macro editor). Based on this, a pagination bar is displayed below the table. The following options are available:
Refer to this note to know more about the default behavior for common parameters available in the configuration as well as macro editor. |
Transaction isolation level | Read committed | Specify the default isolation level to be used for transactions if the Transaction isolation level macro parameter did not specify a specific level. The following options are available for selection:
|
Disable anti-XSS mode | Off | Anti-XSS mode reduces exposure to XSS exploits related to SQL app macros. This configuration allows an administrator to globally turn off anti-XSS mode only for the SQL Macro. To turn off anti-XSS mode, toggle the Disable anti-XSS mode to ON. |
Help us improve the product | On | Enable this option to allows us to collect some usage data that helps us improve our product continually. No private user data is sent. Please refer to this page to know more about the information collected if this option is enabled. |
Data source profiles
An administrator creates profiles that contain parameters used to access, query, and retrieve information from the required data source. In turn, users then choose a profile in the macro editor to display the information on Confluence pages. Some key points about profiles are:
Profiles allow user authentication to be hidden from page viewers and editors. Only Confluence administrators have access to this information.
Enables the macro editor to quickly configure the macro by reusing a shared definition for data source access.
Any configuration change takes effect immediately.
Important information:
Administrators must ensure to use credentials of database users with read-only privileges for profiles intended for use with the SQL Query macro. We recommend creating a read-only database user to be used specifically with the SQL for Confluence - SQL Query macro.
Need support? Create a request with our support team.