Setting up MySQL (V1)

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:
   

   FLUSH PRIVILEGES;

8. Log out from the MySQL prompt by executing the following command:
   

   quit;

Setting up the drivers

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

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.

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

   The elements in the above configuration are described 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
   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 an 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>/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/. 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">
   	<dataSource>jdbc/MY_DATASOURCE_NAME</dataSource>
   </dbConfig>

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.

   <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 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';

   
   

   If you are using MySQL version 5.7 or later, rename mysql5.7.sql to mysql.sql and execute the following command:

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

   We plan to merge the two scripts (mysql5.7.sql and mysql.sql) in a later version.

2. Restart the server.

   You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

   • For Windows: <PRODUCT_HOME>/bin/wso2server.bat -Dsetup

   • For Linux: <PRODUCT_HOME>/bin/wso2server.sh -Dsetup

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.