Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Div
idProductTOC

On this page

Table of Contents
maxLevel1
excludeOn this page
typeflat
separatorpipe

Summary

Section


Column

Configure Data Sources describes two ways to configure data sources for the macros provided by SQL. This page focuses on application server based data source configurations.

The data source is refenced using the dataSource (Data source name) parameter. The exact configuration of a data source is application server and database specific. The configuration must be done by a Confluence administrator and the Confluence application server must be restarted for changes to be active. The configuration must be done very carefully as any errors will result in the data source being unusable (sad). Each database you need to access in Confluence needs to a have a data source configuration.

These are the major This page describes Application server-based Data Source configurations. Major elements of the configuration:

  • Application server
data source
  • -based Data Source configuration - consult your application server documentation on how this is done and problem determination mechanisms. Note that the configuration may be specific to the application server version. For example, older Tomcat versions have some different configurations.
  • JDBC driver specific for the database to be accessed - consult your database documentation and other sources for the best JDBC driver to use.
  • Installation of JDBC driver on the application server
  • Database access - consult your database documentation on how to configure your database for access

Various users have provided some examples that covers many standard situations. This page can be used to share that type of information as well as problem determination information. This is the best place to start especially if you are not an expert in this area.


Column


Info
titleJust Upgraded Confluence?

A common problem is errors after upgrading Confluence. Ensure that your upgrade procedures include updating your server.xml and copying all the JDBC drivers you use into the appropriate location. Also, check out this page for isolating these or application server version differences that cause problems. If you get errors immediately after an upgrade, this is the most likely cause.


Info
titleUpdated documentation

This page is updated from a previous version that has been archived as SQL for Confluence datasource configuration Data Source Configuration - Examples. The former page has been kept as a reference for links and comments. Some of the comments are still useful as they represent user questions and user contributed configurations and solutions. However, some of the information is also out dated.



...

Modify <install-dir>/conf/server.xml to add one or more data source Data Source resource elements. server.xml is an example of adding a few data sources Data Sources for various local and non-local databases.

The essential element is something like the following where the data source Data Source name is myDS:

Code Block
xml
xml
<Resource name="jdbc/myDS"
    auth="Container" 
    type="javax.sql.DataSource" 
    username="confluence" 
    password="confluence"
    maxTotal="25"
    maxWaitMillis="10000"
    maxIdle="10"
    driverClassName="org.postgresql.Driver"
    url="jdbc:postgresql://localhost:5432/mydatabase"
    validationQuery="Select 1"
/>

...

Further Configuration Management

See How to limit active database connections

Other Databases

Support for other databases depends on the capabilities provided by the JDBC driver. SQL expects certain JDBC features to be available. In some cases, parameter choices can affect which capabilities are needed. User testing and community support is about the only help that is available for less popular databases/JDBC drivers. If you have had success with other databases, please add information to this page.

...