Configuring a SQL Server Datasource in Apache Tomcat
This page tells you how to set up a SQL Server datasource connection for Confluence.
Step 1. Shut down Confluence
bin/stop-confluence.batto bring down Confluence while you are making these changes.
- Make a backup of your
<CONFLUENCE_HOME>/confluence.cfg.xmlfile and your
<CONFLUENCE_INSTALLATION>/conf/server.xmlfile, so that you can easily revert if you have a problem.
Step 2. Install the SQL Server database driver
- Download the SQL Server JDBC driver:
- Links are available on this page: Database JDBC Drivers.
- Unpack the archive file you have downloaded, and find the JAR file called something like this:
x.xis a version number.
- Alternatively, you can get the driver from your Confluence installation:
- Copy the driver JAR file to the
/libdirectory of your Confluence installation directory.
Step 3. Configure Tomcat
- Edit the
conf/server.xmlfile in your Confluence installation directory.
Find the following lines:
Insert the following DataSource
Resourceelement directly after the lines above (inside the
Contextelement, directly after the opening
If you're using Confluence 5.7 or below, change maxTotal to maxActive.
yourDatabasePasswordwith the actual credentials for your database.
- In the
urlparameter, replace '
yourDatabaseName' with the database server and database name your Confluence data will be stored in.
maxIdledefine the number of database connections that will be allowed at one time, and the number that will be kept open when there is no database activity. These can be adjusted based on your requirements. See the Apache Tomcat 8 Datasource documentation for more information.
If switching from a direct JDBC connection to datasource, you can find the above details in your
Here are the configuration properties for Tomcat's standard data source resource factory (
- driverClassName — Fully qualified Java class name of the JDBC driver to be used.
- maxTotal — The maximum number of active instances that can be allocated from this pool at the same time.
- maxIdle — The maximum number of connections that can sit idle in this pool at the same time.
- maxWaitMillis — The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception.
- password — Database password to be passed to our JDBC driver.
- url — Connection URL to be passed to our JDBC driver. (For backwards compatibility, the property driverName is also recognized.)
- user — Database username to be passed to our JDBC driver.
- validationQuery — SQL query that can be used by the pool to validate connections before they are returned to the application. If specified, this query MUST be an SQL SELECT statement that returns at least one row.
- Why is the
validationQueryelement needed? When a database server reboots, or there is a network failure, all the connections in the connection pool are broken and this normally requires a Application Server reboot. However, the Commons DBCP (Database Connection Pool) which is used by the Tomcat application server can validate connections before issuing them by running a simple SQL query, and if a broken connection is detected, a new one is created to replace it. To do this, you will need to set the "validationQuery" option on the database connection pool.
Step 4. Configure the Confluence web application
- Edit the
confluence/WEB-INF/web.xmlfile in your Confluence installation directory.
Insert the following element just before
</web-app>near the end of the file:
If you're changing an existing Confluence installation over to using a datasource:
- Edit the
- Delete any line that contains a property that begins with
Insert the following at the start of the
Step 5. Restart Confluence
bin/start-confluence.bat to start Confluence with the new settings.
Was this helpful?
Thanks for your feedback!