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

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

Follow the instructions below to set up an embedded H2 database.

Preparing the Embedded H2 Database

Download and install the H2 database in your computer, if it is not already done, using the installation guide at

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.


The configurations should be replaced with your own database name, username, and password.

    <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


Currently, H2 database version h2-1.2.140.* and the related H2 database driver are shipped with the product.

If you wish to use a new H2 database driver other than the version shipped with the product, follow the steps below.

1. Delete H2 database-related JARs shipped with the product. One could find them in the following locations.

  • <PRODUCT_HOME>/repository/components/plugins/h2-database-engine_1.2.140.wso2v3.jar

2. Copy the new H2 database driver (org.h2.Driver) to <PRODUCT_HOME>/repository/components/lib. One could find the required driver JAR in $H2_HOME/bin/h2-*.jar.


$H2_HOME is the installation directory of H2.

Create Database

Automatic Database Creation

Next, at the first time you start the server, run with the -Dsetup option. It will create the H2 database with all the underlying tables.

  • For Linux:
sh -Dsetup
  • For Windows:
wso2server.bat -Dsetup

Manual Table Creation using scripts

Tables can be manually created by logging into the created database and running and following script in H2 shell or Web Console.


After setting up the DB tables, start the server with the below commands.

  • For Linux:
  • For Windows:
  • No labels