Setting up Embedded H2

The following sections describe how to set up an embedded H2 database.

Install H2

Download and install the H2 database engine on your computer.

Setting up configuration files

The default datasource configuration is defined in the master-datasources.xml file, located in the <EMM_SOURCE_HOME>/repository/conf/datasources/ directory. The database configurations in registry.xml and user-mgt.xml refer to the WSO2_CARBON_DB datasource.

<datasource>
    <name>WSO2_CARBON_DB</name>
    <description>The datasource used for registry and user manager</description>
    <jndiConfig>
         <name>jdbc/WSO2CarbonDB</name>
    </jndiConfig>
    <definition type="RDBMS">
         <configuration>
             <url>jdbc:h2:repository/database/WSO2CARBON_DB;DB_CLOSE_ON_EXIT=FALSE;LOCK_TIMEOUT=60000</url>
             <username>wso2carbon</username>
             <password>wso2carbon</password>
             <driverClassName>org.h2.Driver</driverClassName>
             <maxActive>50</maxActive>
             <maxWait>60000</maxWait>
             <minIdle>5</minIdle>
             <testOnBorrow>true</testOnBorrow>
             <validationQuery>SELECT 1</validationQuery>
             <validationInterval>30000</validationInterval>
         </configuration>
    </definition>
</datasource>

<datasource>
   <name>WSO2_EMM_DB</name>
   <description>The datasource used for EMM</description>
   <jndiConfig>
      <name>jdbc/WSO2EMMDB</name>
   </jndiConfig>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:h2:repository/database/WSO2EMM_DB;DB_CLOSE_ON_EXIT=FALSE</url>
         <username>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>org.h2.Driver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
      </configuration>
   </definition>
</datasource>

<datasource>
   <name>WSO2AM_DB</name>
   <description>The datasource used for API Manager database</description>
   <jndiConfig>
      <name>jdbc/WSO2AM_DB</name>
   </jndiConfig>
   <definition type="RDBMS">
      <configuration>
         <url>jdbc:h2:repository/database/WSO2AM_DB;DB_CLOSE_ON_EXIT=FALSE</url>
         <username>wso2carbon</username>
         <password>wso2carbon</password>
         <driverClassName>org.h2.Driver</driverClassName>
         <maxActive>50</maxActive>
         <maxWait>60000</maxWait>
         <testOnBorrow>true</testOnBorrow>
         <validationQuery>SELECT 1</validationQuery>
         <validationInterval>30000</validationInterval>
      </configuration>
   </definition>
</datasource>

Following are the datasource 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 enter a negative value 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. 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.
• testOnBorrow -  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. 

  For more information on other parameters that can be defined in the master-datasources.xml file, see Tomcat JDBC Connection Pool.

Setting up drivers

WSO2 currently ships H2 database engine version h2-1.2.140.* and its related H2 database driver. If you want to use a different H2 database driver, take the following steps:

1. Delete the following H2 database-related JAR file, which is shipped with WSO2 products:
   <EMM_SOURCE_HOME>/repository/components/plugins/h2-database-engine_1.2.140.wso2v3.jar

2. Find the JAR file of the new H2 database driver (<H2_HOME>/bin/h2-*.jar, where <H2_HOME> is the H2 installation directory) and copy it to your WSO2 product's <EMM_SOURCE_HOME>/repository/components/lib/ directory.

Creating database tables

Create the database tables either manually by running a script or automatically by using a startup parameter as described below.

Using the script

You can create the database tables manually by executing the H2 script in the shell or web console:

Follow the steps below to run the H2 script in web console: 

1. Navigate to the folder with the respective dbscripts.
2. Run the ./h2.sh command to start the web console.
3. Copy the script text from the SQL file.
4. Paste it into the console.
5. Click Run.

After setting up all the database tables, start the server by executing one of the following commands:

• For Linux:
  

  sh wso2server.sh

• For Windows:
  

  wso2server.bat

Using a startup parameter

You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

• For Linux:
  

  sh wso2server.sh -Dsetup

• For Windows:
  

  wso2server.bat -Dsetup