Skip to end of metadata
Go to start of metadata

The following sections describe how to replace the default H2 databases with MySQL: 

Setting up the database and users

Follow the steps below to set up a MySQL database:

  1. Download and install MySQL on your computer using the following command:

    For instructions on installing MySQL on MAC OS, go to Homebrew.

    sudo apt-get install mysql-server mysql-client
  2. Start the MySQL service using the following command:
    sudo /etc/init.d/mysql start
  3. Log in to the MySQL client as the root user (or any other user with database creation privileges).
    mysql -u root -p
  4. Enter the password when prompted.

    In most systems, there is no default root password. Press the Enter key without typing anything if you have not changed the default root password.

  5. In the MySQL command prompt, create the database using the following command:
    create database regdb;

    For users of Microsoft Windows, when creating the database in MySQL, it is important to specify the character set as latin1. Failure to do this may result in an error (error code: 1709) when starting your cluster. This error occurs in certain versions of MySQL (5.6.x), and is related to the UTF-8 encoding. MySQL originally used the latin1 character set by default, which stored characters in a 2-byte sequence. However, in recent versions, MySQL defaults to UTF-8 to be friendlier to international users. Hence, you must use latin1 as the character set as indicated below in the database creation commands to avoid this problem. Note that this may result in issues with non-latin characters (like Hebrew, Japanese, etc.). The database creation command should be as follows:

    mysql> create database <DATABASE_NAME> character set latin1;

    For users of other operating systems, the standard database creation commands will suffice. For these operating systems, the database creation command should be as follows:.

    mysql> create database <DATABASE_NAME>;
  6. Give authorization of the database to the regadmin user as follows:
    GRANT ALL ON regdb.* TO regadmin@localhost IDENTIFIED BY "regadmin";
  7. Once you have finalized the permissions, reload all the privileges by executing the following command: 
  8. Log out from the MySQL prompt by executing the following command:

Setting up the drivers

Download the MySQL Java connector JAR file, and copy it to the <PRODUCT_HOME>/repository/components/lib/ directory.

Tip: Be sure to use the connector version that is supported by the MySQL version you use. If you come across any issues due to version incompatibility, follow the steps below:

  1. Shut down the server and remove all existing connectors from <PRODUCT_HOME>/repository/components/lib and <PRODUCT_HOME>/repository/components/dropins.
  2. Download the connector JAR that is compatible with your current MySQL version.
  3. Copy the JAR file only to <PRODUCT_HOME>/repository/components/lib. Files will be copied automatically to the dropins folder at the server startup.
  4. Start the server with the -Dsetup parameter as sh wso2server.sh -Dsetup.

Setting up datasource configurations

A datasource is used to establish the connection to a database. By default, WSO2_CARBON_DB datasource is used to connect to the default  H2 database, which stores registry and user management data. After setting up the MySQL database to replace the default H2 database, either change the default configurations of the WSO2_CARBON_DB datasource, or configure a new datasource to point it to the new database as explained below.

Changing the default WSO2_CARBON_DB datasource

Follow the steps below to change the type of the default WSO2_CARBON_DB datasource.

  1. Edit the default datasource configuration in the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file as shown below.

    Do not change the datasource name WSO2_CARBON_DB in the below configurations.

           <description>The datasource used for registry and user manager</description>
           <definition type="RDBMS">
                   <validationQuery>SELECT 1</validationQuery>

    The elements in the above configuration are described below:

    urlThe URL of the database. The default port for MySQL is 3306
    username and passwordThe name and password of the database user
    driverClassNameThe class name of the database driver
    maxActiveThe maximum number of active connections that can be allocated  at the same time from this pool. Enter any negative value to denote an unlimited number of active connections.
    maxWaitThe 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. You can enter zero or a negative value to wait indefinitely.
    minIdleThe minimum number of active connections that can remain idle in the pool without extra ones being created, or enter zero to create none.


    The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and another attempt will be made to borrow another.
    validationQueryThe SQL query that will be used to validate connections from this pool before returning them to the caller.
    validationIntervalThe indication to avoid excess validation, and only run validation at the most, at this frequency (time in milliseconds). If a connection is due for validation, but has been validated previously within this interval, it will not be validated again.

    For more information on other parameters that can be defined in the  <PRODUCT_HOME>/repository/conf/datasources/ master-datasources.xml file, see Tomcat JDBC Connection Pool.

Configuring new  datasources to manage registry or user management data

Follow the steps below to configure new datasources to point to the new  databases you create to manage registry and/or user management data separately.

  1. Add a new datasource with similar configurations as the WSO2_CARBON_DB datasource above to the <PRODUCT_HOME>/repository/conf/datasources directory. Change its elements with your custom values. For instructions, see Setting up datasource configurations.
  2. If you are setting up a separate database to store registry-related data, update the following configurations in the <PRODUCT_HOME>/repository/conf/registry.xml file.

    <dbConfig name="wso2registry">
  3. If you are setting up a separate database to store user management data, update the following configurations in the <PRODUCT_HOME>/repository/conf/user-mgt.xml file.

    	<Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property>

Creating database tables

To create the database tables, connect to the database that you created earlier and run the following scripts 

  1. To create tables in the registry and user manager database (WSO2CARBON_DB), use the below script:

     You may have to enter the password for each command when prompted.

    mysql -u regadmin -p -Dregdb < '<PRODUCT_HOME>/dbscripts/mysql.sql';

    For MySQL 5.7:

    From Carbon kernel 4.4.6 onwards your product will be shipped with two scripts for MySQL as follows:

    • mysql.sql : Use this script for MySQL versions prior to version 5.7.

    • mysql5.7.sql : Use this script for MySQL 5.7 and later versions.

    Note that if you are automatically creating databases during server startup using the -DSetup option, the mysql.sql script will be used by default to set up the database. Therefore, if you have MySQL version 5.7 set up for your server, be sure to do the following before starting the server:

    1. First, change the existing mysql.sql file to a different filename.

    2. Change the <PRODUCT_HOME>/dbscripts/mysql5.7.sql script to mysql.sql.
    3. Change the <PRODUCT_HOME>/dbscripts/identity/mysql5.7.sql script to mysql.sql.

    MySQL 5.7 is only recommended for products that are based on Carbon 4.4.6 or a later version.

  2. Restart the server.

Changing the registry/user management databases

If you change the database that comes by default or set up a separate database for registry or user management related data, follow the below instructions.

  1. Add the datasource to the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file . Change its elements with your custom values. For instructions, see  Setting up datasource configurations.

Changing the product-specific/identity databases

The topics above show how to change the WSO2_CARBON_DB, which is used to store registry and user manager information. If you changed the product-specific database (WSO2AM_DB) that comes by default or set up a separate database for identity related data, the instructions are the same. In summary:

  1. Add the datasource to the master-datasources.xml file. The datasource for the product-specific database is already there in the file by the name WSO2AM_DB. Change its elements with your custom values.

  2. Create the database tables using the following scripts:  

    For the product-specific database

    Use the scripts in the <PRODUCT_HOME>/dbscripts/apimgt folder

    For the identity database

    Use the scripts in the <PRODUCT_HOME>/dbscripts/identity folder

  • No labels