---
title: "App configuration - Cloud"
canonical: "https://support.appfire.com/space/SQL/74323863/App%20configuration%20-%20Cloud"
format: markdown
---
> Macro (aura-html)
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](https://appfire.atlassian.net/wiki/x/ahtuB) or [installing](https://appfire.atlassian.net/wiki/x/_xpuB) *SQL for Confluence* cloud app, navigate to the SQL for Confluence Configuration screen:
1. Log in with the system administrator [global permission](https://confluence.atlassian.com/doc/global-permissions-overview-138709.html).
2. Navigate to > Macro (inline-media-image)
***> Settings > Atlassian Marketplace**** *on the sidebar, or search SQL in the search text box.
3. Click *SQL Configuration* to manage the app configuration.
The following configuration settings are available:
- [Global configuration](#sqlCld_100_config_gc)
- [Data source profiles](#sqlCld_100_config_profile)
## > Macro (anchor)
Forge update notes
SQL for Confluence Cloud 4.0.0 uses Atlassian Forge.
Existing data source profiles, credentials, permissions, and configuration settings are preserved after the update. Administrators do not need to reconnect or reauthorize data sources.
After the update, existing data can take 1–2 minutes to appear in the app.
The Forge update includes minor user interface changes to SQL macros and configuration pages. Note that Macro Security isn’t available in the Forge version of SQL for Confluence Cloud.
## 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:
- *250*
- *500*
- *1000*
- *2500*
- *5000*
- *10000*
- *25000*
> ⚠️ Refer to [this note](#sqlCld_100_config_paramPriority) 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:
- *1*
- *5*
- *10*
- *30*
- *60*
- *120*
> ⚠️ - 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](#sqlCld_100_config_paramPriority) 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:
- *10*
- *25*
- *50*
- *100*
> ⚠️ Refer to [this note](#sqlCld_100_config_paramPriority) 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:
- *Read committed *
- *Read uncommitted*
- *Repeatable read*
- *Serializable*
- *None*
> ⚠️ - This parameter requires that the target database support transaction isolation levels.
> ⚠️ - Refer to [this note](#sqlCld_100_config_paramPriority) to know more about the default behavior for common parameters available in the configuration as well as macro editor. |
| 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](https://appfire.atlassian.net/wiki/x/ehduB) to know more about the information collected if this option is enabled. |
## > Macro (anchor)
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.
> ⚠️ At least one data source profile must be configured before using the *SQL for Confluence* - *SQL Query* macro.
> ℹ️ ### How a profile affects macro behavior:
> ℹ️
> ℹ️ The *SQL Query* macro behaves as follows depending on the chosen database and the database privileges the user (configured in the profile) holds:
| Database | Points to note |
| --- | --- |
| PostgreSQL
MySQL | Macro creates a read-only session for the database connection established through the specified profile. 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.
- Allows SQL statements or scripts in read-only mode only.
- Error messages are displayed if Create, Insert, Update, or Delete SQL statements are given in editor or in a script attached to a page. This is because the database itself does not allow execution of such statements as the logged in user has read-only privileges. |
| 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. Once the statements are run:
- the database reflects the operations performed, and,
- the macro 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 privilege*s 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.
You can perform the following actions on this screen:
- Click **Add Profile** to create a profile as follows:
- [Step 1](#sqlCld_100_config_profile_add01) - Specify the database that the macro may access.
- [Step 2](#sqlCld_100_config_profile_add02) - Specify database and user authentication details.
- [Step 3](#sqlCld_100_config_profile_add03) - Save the details to create a profile.
- Click :edit: to edit the profile details. Click **Update profile** to save the changes after updating the relevant parameters, or, **Cancel** to return to the Data source profiles screen.
- Click > Macro (inline-media-image)
to remove the profile.
> ⚠️ Ensure that there are no macros in pages which reference profile(s) to be deleted. After the profile is deleted, the macro cannot connect to the configured data source in the pages, and relevant error messages are displayed.
### Create data source profiles
Clicking the **Add profile** button opens the Add profile wizard. The succeeding sections explain the information required to establish a connection with the required database.
#### > Macro (anchor)
Add profile wizard - Step 1
Select the database that the macro must access, query, and retrieve information.
#### > Macro (anchor)
Add profile wizard - Step 2
After selecting the relevant SQL database, provide details such as the database connection details, user authentication method, and more.
The following table lists the parameters to be provided:
| Section | Parameter | Default value | Description |
| --- | --- | --- | --- |
| > Macro (anchor) | Profile name | | Enter the name to be used for the profile. Users can then select from the list of profiles displayed in the macro editor. *This field is mandatory. * |
| Database connection | Hostname | | Enter the host name or the IP address of the database server to be accessed. *This field is mandatory. *
> ⚠️ ### Configuration note
> ⚠️
> ⚠️ Ensure that the database host allows connections from the *SQL for Confluence* app. This requires updating the host's firewall settings to allow these IP addresses:
> ⚠️
> ⚠️ - 184.73.28.18
> ⚠️ - 52.45.207.55
> ⚠️
> ⚠️ If these addresses are not allowed, errors are generated and relevant messages are shown. |
| Port | | Enter the port number required to access the relevant database on the server. *This field is mandatory.* |
| Database | | Enter the database name the macros must query for information. *This field is mandatory.* |
| Authentication type
> ❌ ### 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*. | Authentication type | *Basic* | Select the authentication method to be used to connect to the specified database. *This field is mandatory.*
The options are as follows:
- *Basic* - This is the default authentication method. This method uses the basic user authentication (user name and password) to validate access to the required database.
- *AWS IAM* - This authentication method is used to manage access to Amazon Web Services (AWS) and resources securely with access keys.
> ⚠️ The [Amazon Relation Database Service (RDS) documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAM.html) specifies the databases supported with IAM authentication as follows:
> ⚠️
> ⚠️ - Amazon RDS for MySQL
> ⚠️ - Amazon RDS for PostgreSQL
> ⚠️
> ⚠️ For more information about authenticating to a database instance using IAM, see [IAM database authentication for MySQL and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html).
> ✅ Refer to [this article](https://aws.amazon.com/iam/) for more information about IAM, and [this article](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) to know more about AWS access keys used to authenticate users. |
| User | | Enter the user name to be used to log in the required database or AWS account. Based on the value of *Authentication type*, provide the following:
- *Basic*: Enter the user name or ID to be used to log into the required database.
- *AWS IAM*: Enter the user ID of the AWS account used to log into the required database.
*This field is mandatory.* |
| Password | | Enter the password to be used along with the user name to access the required database. *This field is mandatory.*
> ⚠️ - This field appears only if *Authentication type* is *Basic*.
> ⚠️ - All profile sensitive information (such as passwords) are encrypted to provide enhanced security. |
| AWS region | | Enter the AWS region (specified when creating the AWS account) where the relevant database is hosted.
An AWS region is a physical location that contains clusters of data centers where cloud based services are accessed over the internet. For more information about regions, refer to the [AWS global infrastructure documentation](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/).
> ⚠️ This field is displayed only if *Authentication type* is *AWS IAM*. |
| Key ID | | Enter the AWS key ID of the user to log in the required database. *This field is mandatory.*
> ⚠️ This field is displayed only if *Authentication type* is *AWS IAM*.
Access keys are long-term credentials for an IAM user or the AWS account root user. For more information about AWS access keys, refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). |
| Secret access key | | Enter the AWS secret access key (part of a user's AWS access key) to be used to log in the required database. *This field is mandatory.*
> ⚠️ This field is displayed only if *Authentication type* is *AWS IAM*.
For more information about AWS access keys, refer to the [AWS IAM documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html). |
| Test connection | | Click this link to test whether a connection can be established with the required database using the specified authentication details. After the test is completed, either of the following indicators are shown:
> Macro (nested-table) |
| Extended parameters | 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 *Limit rows processed* parameter in the [macro editor](https://appfire.atlassian.net/wiki/x/8QtuB) to override this value.
The following options are available from a selection list:
- *250*
- *500*
- *1000*
- *2500*
- *5000*
- *10000*
- *25000*
> ⚠️ Refer to [this note](#sqlCld_100_config_paramPriority) to know more about the default behavior for common parameters available in the configuration as well as macro editor. |
| Limit query time | *1**20* | 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 *Limit query time* parameter in [macro editor](https://appfire.atlassian.net/wiki/x/8QtuB) to override this value.
The following options are available from a selection list:
- *1*
- *5*
- *10*
- *30*
- *60*
- *120*
> ⚠️ Refer to [this note](#sqlCld_100_config_paramPriority) to know more about the default behavior for common parameters available in the configuration as well as macro editor. |
> Macro (anchor)
> ⚠️ ### Priority used for common parameters in configuration and macro editor:
> ⚠️
> ⚠️ There are some parameters, such as *Limit rows processed* or *Limit query time*, that are available in Global configuration, profile configuration, as well as macro editor. Any parameter defined at the macro level overrides the values set at the Global or profile configuration levels. The order of overriding the default setting is:
> ⚠️
> ⚠️ ***Macro level parameter > Profile configuration > Global configuration***
#### > Macro (anchor)
Add wizard - Step 3
Click **Save profile** to create the profile, or, **Cancel** to go back to the Data source profiles screen. The newly created profile is now displayed along with the connection status on the Data source profiles screen.
## Helpful resources
- [Migration guide](https://appfire.atlassian.net/wiki/x/ahtuB) to know more about migrating data from server/DC to cloud
- [User guide](https://appfire.atlassian.net/wiki/x/1xVuB) to understand app usage