Changing to MySQL

By default, WSO2 products use the embedded H2 database as the database for storing user management and registry data. Given below are the steps you need to follow in order to use a MySQL database for this purpose.

Creating the datasource connection to MySQL

A datasource is used to establish the connection to a database. By default, WSO2_CARBON_DB datasource is configured in the master-datasources.xml file for the purpose of connecting 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.

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

1. Open the <PRODUCT_HOME>/conf/datasources/master-datasources.xml file and locate the <datasource> configuration element.

2. You simply have to update the URL pointing to your MySQL database, the username, and password required to access the database and the MySQL driver details as shown below.

   Element	Description
   url	The URL of the database. The default port for MySQL is 3306
   username and password	The name and password of the database user
   driverClassName	The class name of the database driver

   <datasource>
          <name>WSO2_CARBON_DB</name>
          <description>The datasource used for registry and user manager</description>
          <jndiConfig>
              <name>jdbc/WSO2CarbonDB</name>
          </jndiConfig>
          <definition type="RDBMS">
              <configuration>
                  <url>jdbc:mysql://localhost:3306/regdb</url>
                  <username>regadmin</username>
                  <password>regadmin</password>
                  <driverClassName>com.mysql.jdbc.Driver</driverClassName>
                  <maxActive>80</maxActive>
                  <maxWait>60000</maxWait>
                  <minIdle>5</minIdle>
                  <testOnBorrow>true</testOnBorrow>
                  <validationQuery>SELECT 1</validationQuery>
                  <validationInterval>30000</validationInterval>
   			   <defaultAutoCommit>false</defaultAutoCommit>
              </configuration>
          </definition>
   </datasource>

3. You can update the configuration elements given below for your database connection.

   Element	Description
   maxActive	The 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.
   maxWait	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. You can enter zero or a negative value to wait indefinitely.
   minIdle	The minimum number of active connections that can remain idle in the pool without extra ones being created, or enter zero to create none.
   testOnBorrow	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.
   validationQuery	The SQL query that will be used to validate connections from this pool before returning them to the caller.
   validationInterval	The 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.
   defaultAutoCommit	This property is not applicable to the Carbon database in WSO2 products because auto committing is usually handled at the code level, i.e., the default auto commit configuration specified for the RDBMS driver will be effective instead of this property element. Typically, auto committing is enabled for RDBMS drivers by default. When auto committing is enabled, each SQL statement will be committed to the database as an individual transaction, as opposed to committing multiple statements as a single transaction.

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

   Element	Description
   commitOnReturn	If defaultAutoCommit=false, then you can set commitOnReturn=true, so that the pool can complete the transaction by calling the commit on the connection as it is returned to the pool. However, If rollbackOnReturn=true then this attribute is ignored. The default value is false.
   rollbackOnReturn	If defaultAutoCommit=false, then you can set rollbackOnReturn=true so that the pool can terminate the transaction by calling rollback on the connection as it is returned to the pool. The default value is false.

   Configuring the connection pool behavior on return
   When a database connection is returned to the pool, by default  the product rolls back the pending transactions if defaultAutoCommit=true . However, if required you can disable the latter mentioned default behavior by disabling the ConnectionRollbackOnReturnInterceptor, which is a JDBC-Pool JDBC interceptor, and setting the connection pool behavior on return via the datasource configurations by using the following options.
   • Configure the connection pool to commit pending transactions on connection return
     
     1. Navigate to either one of the following locations based on your OS.
        • On Linux/Mac OS:  <PRODUCT_HOME>/bin/integrator.sh/
        • On Windows:  <PRODUCT_HOME>\bin\integrator.bat 

     2. Add the following JVM option:

        -Dndatasource.disable.rollbackOnReturn=true \

     3. Navigate to the <PRODUCT_HOME>/conf/datasources/master-datasources.xml file.
     4. Disable the defaultAutoCommit by defining it as false.

     5. Add the commitOnReturn property and set it to true for all the datasources, including the custom datasources.

        <datasource>
             ...
             <definition type="RDBMS">
                 <configuration>
                       ...
        			   <defaultAutoCommit>false</defaultAutoCommit>
        			   <commitOnReturn>true</commitOnReturn>	
        			   ...
                 </configuration>
             </definition>
        </datasource>

   • Configure the connection pool to rollback pending transactions on connection return

     1. Navigate to the <PRODUCT_HOME>/conf/datasources/master-datasources.xml file.

     2. Disable the defaultAutoCommit by defining it as false.

     3. Add the rollbackOnReturn property to the datasources.

        <datasource>
             ...
             <definition type="RDBMS">
                 <configuration>
                       ...
        			   <defaultAutoCommit>false</defaultAutoCommit>	
        			   <rollbackOnReturn>true</rollbackOnReturn>
        			   ...
                 </configuration>
             </definition>
        </datasource>

Updating other configuration files

• The registry.xml file (stored in the <PRODUCT_HOME>/conf directory) specifies the datasource information corresponding to the database that stores registry information. Therefore, if you have changed the datasource name, you need to update the following accordingly:

  <dbConfig name="wso2registry">
  	<dataSource>jdbc/MY_DATASOURCE_NAME</dataSource>
  </dbConfig>

• The user-mgt.xml file (stored in the <PRODUCT_HOME>/conf directory) specifies the datasource information corresponding to the database that stores user management information. Therefore, if you have changed the datasource name, you need to update the following accordingly:

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

Creating database tables

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

1. To create tables in the registry and user manager database (WSO2CARBON_DB), execute the relevant script as shown below. 

   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 (click here to see if your product is based on this kernel version or newer):

   • 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.