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:
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
- Start the MySQL service using the following command:
sudo /etc/init.d/mysql start
- Log in to the MySQL client as the root user (or any other user with database creation privileges).
mysql -u root -p
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.
- 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>;
- Give authorization of the database to the regadmin user as follows:
GRANT ALL ON regdb.* TO [email protected] IDENTIFIED BY "regadmin";
- Once you have finalized the permissions, reload all the privileges by executing the following command:
- 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 <
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:
- Shut down the server and remove all existing connectors from
- Download the connector JAR that is compatible with your current MySQL version.
- Copy the JAR file only to
<PRODUCT_HOME>/repository/components/lib. Files will be copied automatically to the dropins folder at the server startup.
- Start the server with the -
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.
Edit the default datasource configuration in the <
aster-datasources.xmlfile as shown below.
Do not change the datasource name
WSO2_CARBON_DBin the below configurations.
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.
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
master-datasources.xmlfile, see Tomcat JDBC Connection Pool.
- Add a new datasource with similar configurations as the
WSO2_CARBON_DBdatasource above to the <
.Change its elements with your custom values. For instructions, see Setting up datasource configurations.
If you are setting up a separate database to store registry-related data, update the following configurations in the <
If you are setting up a separate database to store user management data, update the following configurations in the <
Creating database tables
To create the database tables, connect to the database that you created earlier and run the following scripts
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.
If you are using MySQL version 5.7 or later, use the following script instead:
mysql -u regadmin -p -Dregdb < '<PRODUCT_HOME>/dbscripts/mysql5.7.sql';
If you prefer to populate MySQL 5.7 or later with the -Dsetup command, rename
Restart the server.
You can create database tables automatically when starting the product for the first time by using the
-Dsetupparameter as follows:
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.
- Add the datasource to the <
master-datasources.xmlfile . Change its elements with your custom values. For instructions, see Setting up datasource configurations.
Changing the identity/BPS/social databases
The topics above show how to change the
WSO2_CARBON_DB, which is used to store registry and user manager information. If you set up a separate database for identity, WSO2 Business Process Server (BPS), or social related data, the instructions are the same. In summary:
Add a new datasource configuration to the following files for each of the separate databases that you need to create.
For the identity database Add it to the <
For the BPS database Add it to the <
For the social database
Add it to the <
Create the database tables using the following scripts:
For the identity database Use
For the BPS database Use
For the social database
Update the following configurations, with the defined datasource name of the corresponding database configuration you added to the
If you are setting up a separate database to store identity related data, update the following configurations in the <