...
| 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: - 250
- 500
- 1000
- 2500
- 5000
- 10000
- 25000
| Note |
|---|
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: | Note |
|---|
- Requires that the target database support the remote query timeout server configuration option (Maximum number of seconds for query to run).
- Refer to this note to know more about the default behavior for common parameters available in the configuration as well as macro editor.
|
|
| 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:
| Note |
|---|
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 COMMITTEDRead 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: - READ COMMITTED
- READ UNCOMMITTED
- REPEATABLE READ
- SERIALIZABLERead committed
- Read uncommitted
- Repeatable read
- Serializable
- None
| Note |
|---|
- This parameter requires that the target database support transaction isolation levels.
- Refer to this note to know more about the default behavior for common parameters available in the configuration as well as macro editor.
|
|
| 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. |
...
- 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.
| Note |
|---|
| title | Important information: |
|---|
|
- Administrators must ensure to use credentials of database users with read-only privileges for profile creation.
- At least one data source profile must be configured before using the SQL for Confluence
macros |
| Info |
|---|
| title | How database and user type in profile affects macro behavior: |
|---|
|
The SQL Query macro behaves as follows depending on the chosen database and the database privileges the user holds: | Database type | Read-only user | Read-write user | Macro behaviour w.r.t. Create, Insert, Update, or Delete (CRUD) statements given as SQL statements, or in scripts attached to a page |
|---|
PostgreSQL MySQL |  |  | Given SQL statement(s) or the script file is executed, and results are displayed in a table in the Preview panel of the macro editor. | | PostgreSQL | | | Macro creates a read-only session for the database connection established through the specified profile. - Allows SQL statements or scripts in read-only mode only.
- Error messages are displayed if CRUD statements are given in editor or in a script attached to a page. The database itself does not allow CRUD statements as the logged in user has read-only privileges.
| | MySQL | | | Microsoft SQL Server | | | Given SQL statement(s) or the script file is executed, and results are displayed in a table in the Preview panel of the macro editor. | | | Macro executes the given SQL statement or attached script file and the database reflects the operations performed. Once the statements are run, the macro then executes a rollback that reverts the database to its previous state. Thus, Confluence administrators must make sure to provide credentials of a user with read-only privileges configured in the database. |
|
The Data source profiles screen displays a complete list of profiles available for use with the macro, and also provides options to add, update, or delete profiles.
...