Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Follow the below instructions to set up a MySQL database.The following sections describe how to replace the default H2 database with MySQL:

Table of Contents

Setup Database and the Database User

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

Code Block
sudo apt-get install mysql-server mysql-client

Image Removed

2. Start the MySQL service using the following command:

Code Block
sudo /etc/init.d/mysql start

Image Removed

3. Log in to the MySQL client as the root user (or any other user with database creation privileges).

Code Block
mysql -u root -p

Image Removed

4. You will be prompted to enter the password.


In most systems, the default root password is blank. Press "enter" without typing anything if you have not changed the default root password.

After that, you will see the MySQL command prompt.

Image Removed

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

Code Block
create database regdb;

6. Give authorization of the database to the user "regadmin."

Code Block
GRANT ALL ON regdb.* TO regadmin@localhost IDENTIFIED BY "regadmin"

7. Log out from the MySQL prompt by typing the "quit" command.

Code Block

Setup Configuration Files

1. Edit the default database configuration defined in

Include Page
Shared:Setting up MySQL (V1)
Shared:Setting up MySQL (V1)

Changing the product-specific/identity databases

The topics above show how to change the  WSO2CARBON_DB , which is used to store registry and user manager information. If you changed the product-specific database (WSO2_RSS_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


Image Removed


Replace these settings with your own custom values:

Code Block
       <description>The datasource used for registry and user manager</description>
       <definition type="RDBMS">
               <validationQuery>SELECT 1</validationQuery>
The database configuration options
  • 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 negative 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 or <= 0 to wait indefinitely.
  • minIdle - The minimum number of active connections that can remain idle in the pool without extra ones being created or 0 to create none.

Setup Drivers

Download the MySQL Java connector JAR from and place it in the $CARBON_HOME/repository/components/lib directory.


Here, $CARBON_HOME refers to the directory where you are running the WSO2 SS instance.

Create Database

Automatic Database Creation

1. When you start the server for the first time, use the -Dsetup option. It will create all the tables in the given MySQL database.

  • For Linux:
Code Block -Dsetup
  • For Windows:
Code Block
wso2server.bat -Dsetup

2. The WSO2 SS is configured to run with MySQL database.

Manual Database Creation

1. Run the MySQL scripts for both registry and user manager (embedded) databases, provided with the WSO2 SS, using the below commands (outside the MySQL prompt).

Code Block
mysql -u regadmin -p -Dregdb < 'CARBON_HOME/dbscripts/mysql.sql';

You will be prompted to enter the password for each command.

2. Start the WSO2 Carbon instance.

  • For Linux:
Code Block
  • For Windows:
Code Block




  1. . The datasource for the product-specific database is already there in the file by the name WSO2_RSS_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 <PRODUCT_HOME>/dbscripts/rss-manager/ folder

    For the identity database

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