Update the Microsoft SQL Server JDBC URL in Jira server
Platform Notice: Server and Data Center Only - This article only applies to Atlassian products on the server and data center platforms.
With JIRA 7.5, we've shipped a new Microsoft JDBC Driver 6.2.1 for SQL Server, which requires an update to the driver's URL in the
dbconfig.xml file. In most cases, you can make the update automatically by running the JIRA configuration tool. However, if you've customized your DB configuration by adding properties to the URL, you'll need to adjust your URL to the new pattern manually.
Running the JIRA configuration tool
If you haven't made any changes to the JDBC URL, the JIRA Configuration Tool can be used to automatically update the configuration file:
- Go to
<installation-directory>/bin, and run the
config.bat / config.shfile
- Click Save. Your configuration will be updated
- Restart JIRA
If you're running on Windows, it's possible you don't have the necessary
JAVA_HOME environment variable set (so the configuration tool will not run). In that case, you can configure the environment variable manually and restart Windows for it to take effect, and then run the configuration tool. Alternatively, you can update the URL manually as shown below.
Updating the URL Manually
If for some reason you cannot run the configuration tool (or it hasn't corrected the problem) you'll need to edit
- Shut down JIRA, and back up your current
- Adjust the
urlfor the database to the following:
- Adjust the
driver-classfor the database to the following:
The new connection string URL takes the following format:
To specify a database name, you must include it at the end of the URL in the form of
For example, if your old database configuration looked like this:
You'd want to change it to:
Note about Named Instances and Port Numbers
In some cases, we've seen users unable to start JIRA, as JIRA reported it
could not open the database requested by the login which would cause JIRA's startup to fail. In some environments, the login request doesn't get passed the correct instance. Removing the port number and specifying an instance name should allow the connection to succeed.
The old scheme was:
In the new scheme, this would be:
However, the login request appeared to be being passed to an incorrect instance - and thus the following was used:
As per Microsoft's documentation:
If both a
instanceName are used, the
portNumber will take precedence and the
instanceName will be ignored.
Note about Integrated Security
Please see KB article here - Using Integrated Security with MsSQL for Jira