.png?version=1&modificationDate=1662627367996&cacheVersion=1&api=v2&width=226&height=72)
Administrators configure the global query timeout (queryTimeout parameter) to stop SQL queries from running longer than the limit. It prevents queries that take too long to impact other users.
The Limit query time is configured as below.
The administrator sets the default value on the SQL for Confluence configuration page. To set the 'Maximum number of seconds for query to run' in Global Configuration, refer to Global Configuration.
Administrators can enable the Restrict overriding global configuration limits flag to prevent overriding the Limit query time parameter and enforce the default value set on the Global configuration page. For more information, refer to Get Started - Configuration - 11.x.
An administrator can override the global queryTimeout setting for specific data source profiles in Global Configuration. The global setting takes effect if this is not overridden. For more information, refer to Data Source Profiles - Limit query time.
Users can change the default queryTimeout parameter value for the SQL and SQL-Query macros. Selecting a value from the list for Maximum number of seconds for query to run overrides the default.
Overriding the queryTimeout parameter
The default value is set by the administrator via the Global configuration page or Profile configuration page.
Selecting a value in the sql and sql-query macros overrides the default. The order of overriding the default setting is Macro level parameter > Profile configuration > Global configuration.
Your database and JDBC driver must support the selected value to use this parameter.
If the Restrict overriding global configuration limits flag is enabled on the Global configuration page, then the default value set for the Limit query time parameter on the Global configuration page is considered and cannot be overridden.
Administrators can limit (or control) who can use this parameter through the use of our Macro Security for Confluence app.
Below are a few scenario illustrations which show how the queryTimeout value is evaluated.
Macro queryTimeout | Profile queryTimeout | Global queryTimeout | Outcome: queryTimeout value |
|---|---|---|---|
No Limit | No Limit | No Limit | The queryTimeout is set to unlimited. The page will be timed out based on the Confluence Page timeout value. |
No Limit | No Limit | 600 | queryTimeout is set to the Confluence Page timeout value. |
No Limit | 300 | 600 | queryTimeout is set to the Confluence Page timeout value. |
No Limit | 600 | No Limit | queryTimeout is set to the Confluence Page timeout value. |
30 | No Limit | No Limit | queryTimeout is set to 30. queryTimeout considers value 30 as the macro queryTimeout value is provided. |
Default value | No Limit | 10 | queryTimeout is set to 10. The default value of macro queryTimeout will consider Global queryTimeout value. |
Default value | Not set | 10 | queryTimeout is set to 10. The default value of macro queryTimeout will consider Global queryTimeout value. |
Default value | 30 | 60 | queryTimeout is set to 30. Profile queryTimeout is considered when profile queryTimeout has a value other than No limit and no selection( Select a value). |
5 | 10 | 60 | queryTimeout is set to 5. queryTimeout considers value 5 as the macro queryTimeout value is provided. |
If the Macro queryTimeout parameter is set to No Limit, then queryTimeout considers the Confluence Page timeout value.
Suppose the queryTimeout parameter is set to No Limit in all three configuration options: Macro level parameter, Profile configuration, and Global configuration. In that case, the queryTimeout is set to unlimited, and the page will be timed out based on the Confluence Page timeout value.
Administrators can view the Confluence page timeout value in the path General Configuration > Users and Security > Security Configuration > Page timeout.
