| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
On this page
|
Include Page _SQL for Confluence 11.x announcement _SQL for Confluence 11.x announcement
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. |
...
| Database | Example |
|---|---|
| PostgreSQL | dbUrl=jdbc:postgresql://localhost:5432/test | dbUser=confluence | dbPassword=confluence | dbDriver=org.postgresql.Driver | dbJar=https://jdbc.postgresql.org/download/postgresql-42.2.5.jar |
| PostgreSQL (using specific Schema) | dbUrl=jdbc:postgresql://localhost:5432/test?currentSchema=jiraschema | dbUser=confluence | dbPassword=confluence | dbDriver=org.postgresql.Driver | dbJar=https://jdbc.postgresql.org/download/postgresql-42.2.5.jar |
| MySQL | dbUrl=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true | dbUser=confluence | dbPassword=confluence | dbDriver=com.mysql.jdbc.Driver | dbJar=http://central.maven.org/maven2/mysql/mysql-connector-java/5.1.47/mysql-connector-java-5.1.47.jar |
Microsoft SQL Server | dbDriver=com.microsoft.sqlserver.jdbc.SQLServerDriver | dbUrl=jdbc:sqlserver://localhost:2433;database=test;integratedSecurity=false | dbUser=confluence | dbPassword=confluence | dbJar=../lib/mssql-jdbc-7.0.0.jre8.jar |
...
| 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. |
...
- Log in as a user with the Confluence administrators Global Permission.
- Select Manage apps from the CONFLUENCE ADMINISTRATION menu (cog icon:
) at the top right of your screen. - Scroll down to BOB SWIFT CONFIGURATION in the navigation pane to the left and click SQL (Pro Edition) (see:
). - Click View and modify data source profiles (see:
) tab at the top. - You will see a list of data source profiles and their connection status.
...
- Log in as a user with the Confluence administrators Global Permission.
- Select Manage apps from the CONFLUENCE ADMINISTRATION menu (cog icon: ) at the top right of your screen.
- Scroll down to BOB SWIFT CONFIGURATION in the navigation sidebar to the left and click SQL (Pro Edition) (see: ).
- Click View and modify data source profiles (see:) tab at the top.
- You will see a list of data source profiles and their connection status.
- Click the Edit link to the right of the data source profile you would like to modify.
The edit dialog will appear and will default to the By connection string view. You can edit the fields under this option or toggle to the Simple setup type and make the necessary changes.
Info You will be able to toggle to the Simple setup type only after clearing the configuration information that appears under the By connection string.
- To save changes, click the Next and then Save profile (see:
).
...
- Log in as a user with the Confluence administrator's Global Permission.
- Select Manage apps from the CONFLUENCE ADMINISTRATION menu (cog icon: ) at the top right of your screen.
- Scroll down to BOB SWIFT CONFIGURATION in the navigation pane to the left and select SQL (Pro edition) (see:).
- Click View and modify data source profiles (see: ) tab at the top. You see a list of data source profiles and their connection status.
- Click the Remove link to the right of the data source profile that you want to remove.
- Click Yes, delete it!.
...