| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
On this page
|
Description
SQL Macros such as SQL, SQL-query, and SQL-file use Data Sources to connect 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 |
|---|
Note: you must have at least one Data Source in order to begin using this application within Confluence. |
...
| Setup type | Field | Description | |||||
|---|---|---|---|---|---|---|---|
| Simple | Database type | They type of database you are connecting to. | |||||
| Simple | Data source name | You have the option to create a new Data Source Profile by extending an existing Data Source. This may be useful if you'd like to tighten/alter the configuration parameter settings to be more/less restrictive for certain usage. You can of course then secure the usage using our CMSP App. | |||||
| Simple | Hostname | This is the hostname or IP address of your database server. | |||||
| Simple | Port | This is the port used to access your database on the server it is running against. | |||||
| Simple | Database | This is the name of your database. | |||||
| Both | Driver class | The class of JDBC driver that you will use to connect to your database (e.g., com.mysql.jdbc.Driver, or org.postgresql.Driver) | |||||
| Both | Driver JAR location | The path on your Confluence server where the JDBC driver is located.
| |||||
| By connection string | Connection string | The database URL is entered in this format (SQLServer example):jdbc:sqlserver://<hostname>:<port>;database=<database> For example: | |||||
| Both | Username | This is the username of your dedicated database user. | |||||
| Both | Password | This is the password for your dedicated database user. |
Quick Connection Strings
When using the "By connection string" setup option the following examples can be quickly copied into the relevant sections and then modified:
...
| Parameter | Macro Parameter | Default | Description | |||||
|---|---|---|---|---|---|---|---|---|
| Limit rows processed | limit | No limit | The maximum number of rows that will 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 for selection:
| |||||
| Limit query time | queryTimeout | None | The number of seconds that a query can take before we force a 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 | Noone | Used to 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 will return an error message instead of trying to connect to the database. See this article for additional information. | |||||
| Show sql options | showSqlOptions | None | Since 6.4. 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. | |||||
| 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 will generate 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 Add-ons from the Administration menu (cog icon:
) at the top right of your screen. Then scroll down to Bob Swift Configuration on the left-hand nav bar and choose SQL Configuration (see: 
). - Select View and Modify Data Source Profiles (see:
) from the top navigation. - You will see a list of Data Source Profiles and their connection status.
- Click on the remove link to the right of the Data Source Profile you would like to remove.
- When prompted, just confirm or exit.
Testing a Data Source Profile
To test: create a page and use Insert -> Markup to add the following wiki markup : {sql-query:dataSource=example} select 1 {sql-query}
...