Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
On this page
|
Overview
SQL, SQL File, and SQL Query macros use data sources to connect to and access your databases. Creating one or more data source profiles is the fastest and most convenient method of establishing a connection. You can also create data source profiles that extend data sources configured within your application server.
Info |
---|
You must provide at least one data source to use this application within Confluence. |
Note | ||
---|---|---|
| ||
All profile sensitive information (such as passwords) are now encrypted to provide enhanced security. This encryption-decryption of profile passwords is not available if the app is downgraded from version 10.3 to a lower release version. If you must downgrade the app version, passwords of all the profiles must be re-entered to ensure proper working of profiles. |
Add data source profiles
...
Tip |
---|
The configuration for other databases (other than the ones listed in the table above) is similar to the information found in the examples section on: Configure Application Server Based Data Sources. |
Extended parameters
Data source profiles allow for the configuration of extended parameter options. These profile-wide settings are used by all SQL macros if not overridden at the macro-level.
...
Parameter | Macro Parameter | Default | Description | |||||
---|---|---|---|---|---|---|---|---|
Limit rows processed | limit | No limit | The maximum number of rows to 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 from a selection list:
| |||||
Limit query time | queryTimeout | None | The number of seconds that a query can take before a forced timeout. This prevents queries that take too long from impacting other users. Individual queries can use the queryTimeout parameter to override this value.
| |||||
Limit max active | maxActive | None | Limit the number of actively executing SQL queries for a specific data source. Once the maximum active limit is reached, the next requested render of a SQL macro using the specific data source returns an error message instead of trying to connect to the database. See this article for additional information. | |||||
Show sql options | showSqlOptions | None | A comma-separated list of code or code-pro (Code Pro Macro) parameters used when Show SQL is selected. This allows for customization of how the SQL code is shown. See How to improve the display of SQL source. Since 6.4 | |||||
Connection properties | connectionProperties | None | A list of driver specific properties passed to the driver for creating connections. Each property is given as name=value , multiple properties are separated by semicolons (; ). See Apache Tomcat JNDI resources. | |||||
Initial SQLs | initalSql<n> | None | SQL that is run after the SQL connection is established where n is a number (1, 2, 3, ...). Multiple initial SQL statements are allowed to support databases that only allow single SQL statements. Example use for Oracle:
No results are kept and any errors generates a macro exception. Using beforeSql is recommended for Postgres and other database that support multiple SQL statements as it is more efficient than multiple separated actions. | |||||
Before SQL | beforeSql | None | SQL that is added before macro defined SQL. | |||||
After SQL | afterSql | None | SQL that is added after macro defined SQL. |
...
Indicator | Definition |
---|---|
Indicates that the connection information supplied for the data source Profile will allow connections from Confluence to the targeted database. This does not indicate that the data source profile is in use by any macros on Confluence pages. | |
Indicates that your connection-specific information is incorrect. See troubleshooting data source profile connections. |
Modify data source profiles
...
- Create a new page or edit an existing one.
- Enter {SQL to get macro suggestions for the SQL macros. Select the SQL macro.
- The SQL settings navigation pane pops up.
- Enter the Data source profile under the SQL statement tab.
Enter the following query in the SQL statement text area.
- Click Preview (See: ) to see the results.