Setting up MySQL

The following sections describe how to set up a MySQL database:

Setting up the database and users

1. Download and install MySQL on your computer. 

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

   sudo apt-get install mysql-server mysql-client

2. Start the MySQL service. If you are using Linux, use 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 <DATABASE_NAME>; 

   For example: 

   create database regdb;

   About using MySQL in different operating systems

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

The default datasource configuration are defined in the 2 files listed below, which are located in the <PRODUCT_HOME>/repository/conf/datasources directory. The database configurations in registry.xml and user-mgt.xml refer to the WSO2_CARBON_DB datasource.

The datasource configuration options are as follows:

• url - The URL of the database.

• username  - The name of the database user.

• password - The password of the database user.
• driverClassName  - The class name of the database driver.
• maxActive - The maximum number of active connections that can be allocated from this pool at the same time, or enter a negative value for no limit.
• 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. 

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

Setting up the drivers

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

Creating database tables

Create the following database tables either manually or automatically.

Using the script

You can create database tables manually by executing the following script:

1. Run the MySQL script individually for the latter mentioned databases that are provided with the product using the below command (outside the MySQL prompt):

   mysql -u <USERNAME> -p -D<DATABASE-NAME> '<PATH-TO-MYSQL-DB-SCRIPT>';

   For example:

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

   Enter the password for each command when prompted.

2. Start the WSO2 product instance as follows:
   

   • For Linux:

     wso2server.sh

   • For Windows:

     wso2server.bat

Using a startup parameter

You can create database tables automatically when starting the product for the first time by running the following command:

• For Linux:

  wso2server.sh -Dsetup

• For Windows:

  wso2server.bat -Dsetup