If the directory/file paths specified in this guide do not exist in your WSO2 product, see Directory Structure of WSO2 Products to locate the paths applicable to your product.

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added a note that -DSetup option has been deprecated


  1. Run the ./h2.sh command to start the Web console.
  2. Copy the script text from the SQL file.
  3. Paste it into the console.
  4. Click Run.
  5. 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

    Multiexcerpt include
    PageWithExcerptChanging to Embedded Derby

Note to writers: Add this content at the end of the page if any of the additional databases is relevant to your product.

Changing the identity/storage/product-specific databases

The topics above show how to change the WSO2_CARBON_DB, which is used to store registry and user manager information. If you changed the product-specific database thatcome by default or set up a separate database for identity or storage related data, the instructions are the same. In summary:

  1. Add a newdatasourceconfiguration to the following files for each of the separate databases that you need to create.

    For the identity databaseAdd it to the <PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)>
    For the storage databaseAdd it to the  <PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)
    For the product-specific databaseAdd it to the  <PRODUCT_HOME>/repository/conf/<check the correct path and add file name (something like api-manager.xml)
  2. Create the database tables using the following scripts:

    For the identity databaseUse  <PRODUCT_HOME>/dbscripts/identity/<check the correct path and add file name (something like mysql.sql)>
    For the storage databaseUse  <PRODUCT_HOME>/dbscripts/storage/<check the correct path and add file name (something like /mysql/resoucre.sql)>
    For the product-specific databaseUse  <PRODUCT_HOME>/dbscripts/<check the correct path and add file name (something like /apimgt/mysql.sql)> 
  3. Update the following configurations, with the defined datasourcename of the corresponding database configuration you added to the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file.

    • If you are setting up a separate database to store identity relateddata, update the following configurations in the <PRODUCT_HOME>/repository/conf/identity.xml file.

      Code Block
      		<!-- Include a data source name (jndiConfigName) from the set of datasources defined in master-datasources.xml -->

      Note to writers: For step 3, add content on the XML files which include references on any of the additional databases and require edits that are relevant to your product similar to the given example.