Documentation for JIRA 4.4. Documentation for other versions of JIRA is available too.

Skip to end of metadata
Go to start of metadata

These instructions will help you connect JIRA to a MySQL 5.x database.

Note: A Linux-specific version of these instructions is available.

1. Before You Begin

1.1 Are You Migrating JIRA to Another Server?

If you are Migrating JIRA to Another Server, create an export of your data as an XML backup. You will then be able to transfer data from your old database to your new database, as described in Switching databases.

1.2 Shut Down JIRA

1.3 Known Issues with MySQL

If you are using a MySQL database with any of the following:

  • JIRA 3.13 Standalone or above,
  • version 5.5.25 or higher of Tomcat 5,
  • version 6.0.13 or higher of Tomcat 6,

you may experience problems with your connections dropping out (see http://jira.atlassian.com/browse/JRA-15731 for details). Please read Surviving Connection Closures for information on the changes required to your application server to address this.

If you experience any other issues with using JIRA and MySQL, please refer to our additional notes for more information.

2. Create and Configure the MySQL Database

  1. Create a database user which JIRA will connect as (e.g. jiradbuser). (tick) Remember this database user name, as it will be used to configure JIRA's connection to this database in subsequent steps.
  2. Create a database for JIRA to store issues in (e.g. jiradb). The database must have a character set of UTF8. Enter the following command from within the MySQL command client:

    (if you want your database to be named jiradb). (tick) Remember this database name, as it will be used to configure JIRA's connection to this database in subsequent steps.

  3. Ensure that the user has permission to connect to the database, and permission to create and populate tables.

3. Copy the MySQL JDBC Driver to Your Application Server (JIRA WAR Only)

(warning) Skip this step if you are using JIRA Standalone distribution. JIRA Standalone includes the MySQL JDBC driver.

  1. Download the MySQL Connector/J JDBC driver v5.1
    (warning) A user had reported experiencing problems with the Resin JDBC driver for MySQL. However, the Connector/J driver from MySQL is known to work correctly.
  2. Add the MySQL JDBC driver jar (mysql-connector-java-5.x.x-bin.jar) to the lib/ directory.

4. Configure Your JIRA Server to Connect to Your MySQL Database

There are two ways to configure your JIRA server to connect to your MySQL database:

(info) Please Note:

4.1 Connecting JIRA to MySQL Using the JIRA Configuration Tool

(info) The JIRA Configuration Tool is only available with JIRA Standalone.

To start the JIRA Configuration Tool:

(info) Please Note: You may need to set the JAVA_HOME environment variable to run the JIRA Configuration Tool. See Installing Java for details.

To connect JIRA to MySQL using the JIRA Configuration Tool:

  1. Click the 'Database' tab.
  2. From the 'Database type' drop-down choose 'MySQL'.
    (info) The JIRA Configuration Tool will display your current database configuration settings if any are already set.
  3. Fill in the connection details for your MySQL database.
    • 'Hostname' — The name or IP address of the machine that the MySQL server is installed on.
    • 'Port' — The TCP/IP port that the MySQL server is listening on. You can leave this blank to use the default port.
    • 'Database' — The name of your MySQL database (into which JIRA will save its data).
    • 'Username' — The user that JIRA uses to connect to the MySQL server.
    • 'Password' — The user's password to authenticate with the MySQL server.
  4. JIRA keeps a pool of database connections open to the database server. You can set the maximum size of this pool in the 'Pool Size' text field.
  5. After typing in your settings, click the 'Test Connection' button to test the connection settings. The tool will attempt to connect to the database, and give a message with the results.
  6. Click 'Save' to save your settings when you are done.
    (warning) Please Note:
    • The JIRA Configuration Tool will save your database configuration to a dbconfig.xml file in your JIRA Home Directory. This tool also adds the element <validation-query>select 1</validation-query> to this file, which is usually required when running JIRA with default MySQL installations. See Surviving Connection Closures for more information.
    • Due to a known issue in JIRA 4.4.0, the JIRA Configuration Tool included in this version of JIRA does not add the important 'sessionVariables=storage_engine=InnoDB' parameter into the database URL of the dbconfig.xml file it saves. This parameter is strongly recommended when configuring JIRA with MySQL, to avoid data corruption in JIRA. See the Additional Notes section below for more information.
      Hence, after clicking the 'Save' button, edit the dbconfig.xml file generated in your JIRA Home Directory to add this parameter manually, as shown in the example XML code below. (Remember to separate each parameter in your database URL with an '&' character, which must be 'escaped' by adding 'amp;'.)
      If you use JIRA 4.4.1 or later, you do not need to worry about adding this parameter as this issue has been addressed.
    • JIRA must be restarted for your new settings to take effect.

Congratulations — you have finished! Proceed to 'Next Steps' below.

4.2 Connecting JIRA to MySQL Manually

  1. Edit the dbconfig.xml file at the root of your JIRA Home Directory.
    (info) If this file does not exist, create the file, copy and paste the example XML code below into this file and edit the pasted XML as required.
    (warning) When editing your dbconfig.xml file, escape the '&' characters by adding 'amp;' to the end of each one, as shown in the <url/>element below:

    (minus) Please Note:

    • The database URL in the example dbconfig.xml file content above assumes a UTF-8 database — i.e. that your database was created using a command similar to create database jiradb character set utf8;
    • If you do not specify character set utf8 when creating this database, you risk getting 'Data truncation: Data too long for column' errors when importing data or corruption of non-supported characters. See storing non-ASCII characters in MySQL for details.
    • The <validation-query>select 1</validation-query> element is usually required when configuring JIRA with default MySQL installations. See Surviving Connection Closures for more information.
    • Adding the sessionVariables=storage_engine=InnoDB parameter to the database URL is strongly recommended when configuring JIRA with MySQL, to avoid data corruption. See the Additional Notes section below for more information.
  2. Save your edited dbconfig.xml file (at the root of your JIRA Home Directory).
    (info) JIRA must be restarted for your new settings to take effect.

Proceed to 'Next Steps' below.

4.3. Additional Notes

The default storage engine used by MySQL Server versions prior to 5.5 is MyISAM. Hence, a JIRA database running on a default configuration of a MySQL Server earlier than version 5.5, could experience table creation problems (JRA-24124), which may result in data corruption in JIRA.

Hence, specifying the sessionVariables=storage_engine=InnoDB parameter in your database URL (by following the procedures above) is strongly recommended. Doing so ensures that tables written to JIRA's MySQL database will use the InnoDB storage engine, which supports 'database transactions' required by JIRA.

Be aware that JIRA uses the 'READ-COMMITTED' transaction isolation level with MySQL, which currently only supports row-based binary logging. If you require MySQL's binary logging features, you must configure MySQL's binary logging format to be 'row-based'. If not, you may encounter problems when creating issues in JIRA. For more information, please refer to JIRA Cannot Create Issues when Using MySQL with Binary Logging.

5. Next Steps

You should now have JIRA configured to connect to your MySQL database.

  • If you are using JIRA Standalone, start it up and watch the logs for any errors.
  • If you are using the JIRA WAR, rebuild and redeploy the webapp in your application server.

Installation Notes

Please see JIRA and MySQL.