This documentation is for WSO2 API Manager 1.7.0 View documentation for the latest release.
Setting up with MySQL - API Manager 1.7.0 - WSO2 Documentation

All docs This doc
Skip to end of metadata
Go to start of metadata

Follow the below instructions to set up a MySQL database.

Setup Database and the Database User

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

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

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

create database regdb;

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

GRANT ALL ON regdb.* TO [email protected] IDENTIFIED BY "regadmin"

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


Setup Configuration Files

1. Edit the default database configuration defined in the  master-datasources.xml  file located at  $CARBON_HOME/repository/conf/datasources  directory as below. Both the database configurations in  registry.xml  and  user-mgt.xml  refer this data source.


Replace these settings with your own custom values:

       <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 product 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: -Dsetup
  • For Windows:
wso2server.bat -Dsetup

2. The product 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 product, using the below commands (outside the MySQL prompt).

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:
  • For Windows:
  • No labels