Changing to Embedded Derby

The following sections describe how to replace the default H2 database with embedded Derby: 

Setting up datasource configurations

A datasource is used to establish the connection to a database. By default, WSO2_CARBON_DB datasource is used to connect to the default H2 database, which stores registry and user management data. After setting up the Embedded Derby database to replace the default H2 database, either change the default configurations of the WSO2_CARBON_DB datasource, or configure a new datasource and point it to the new database as explained below.

Changing the default WSO2_CARBON_DB datasource

Follow the steps below to change the type of the default WSO2_CARBON_DB datasource.

Edit the default datasourceconfigurationin the <PRODUCT_HOME>/repository/conf/datasources/m aster-datasources.xml file as shown below.

<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:derby://localhost:1527/db;create=true</url>
               <username>regadmin</username>
               <password>regadmin</password>
               <driverClassName>org.apache.derby.jdbc.EmbeddedDriver</driverClassName>
               <maxActive>80</maxActive>
               <maxWait>60000</maxWait>
               <minIdle>5</minIdle>
               <testOnBorrow>true</testOnBorrow>
               <validationQuery>SELECT 1</validationQuery>
               <validationInterval>30000</validationInterval>
			   <defaultAutoCommit>false</defaultAutoCommit>
         </configuration>
     </definition>
</datasource>

The elements in the above configuration are described below:

Configuring the connection pool behavior on return
When a database connection is returned to the pool, by default  the product rollsback the pending transactions if defaultAutoCommit=true . However, if required you can disable the latter mentioned default behavior by disabling the ConnectionRollbackOnReturnInterceptor, which is a JDBC-Pool JDBC interceptor, and setting the connection pool behavior on return via the datasource configurations by using the following options.

• Configure the connection pool to commit pending transactions on connection return
  
  1. Navigate to either one of the following locations based on your OS.
     • On Linux/Mac OS:  <PRODUCT_HOME>/bin/wso2server.sh/
     • On Windows:  <PRODUCT_HOME>\bin\wso2server.bat 

  2. Add the following JVM option:

     -Dndatasource.disable.rollbackOnReturn=true \

  3. Navigate to the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file.
  4. Disable the defaultAutoCommit by defining it as false.

  5. Add the commitOnReturn property and set it to true for all the datasources, including the custom datasources.

     <datasource>
          ...
          <definition type="RDBMS">
              <configuration>
                    ...
     			   <defaultAutoCommit>false</defaultAutoCommit>
     			   <commitOnReturn>true</commitOnReturn>	
     			   ...
              </configuration>
          </definition>
     </datasource>

• Configure the connection pool to rollback pending transactions on connection return

  1. Navigate to the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file.

  2. Disable the defaultAutoCommit by defining it as false.

  3. Add the rollbackOnReturn property to the datasources.

     <datasource>
          ...
          <definition type="RDBMS">
              <configuration>
                    ...
     			   <defaultAutoCommit>false</defaultAutoCommit>	
     			   <rollbackOnReturn>true</rollbackOnReturn>
     			   ...
              </configuration>
          </definition>
     </datasource>

Configuring new datasources to manage registry or user management data

Follow the steps below to configure new datasources to point to the new database(s) you create to manage registry and/or user management data separately.

1. Add a new datasource with similar configurations as the  WSO2_CARBON_DB datasource above to the <PRODUCT_HOME>/repository/conf/datasources/ master-datasources.xml file. Change its elements with your custom values. For instructions, see Setting up datasource configurations.

2. If you are setting up a separate database to store registry-related data, update the following configurations in the <PRODUCT_HOME>/repository/conf/ registry.xml file.

   <dbConfig name="wso2registry">
   	<dataSource>jdbc/MY_DATASOURCE_NAME</dataSource>
   </dbConfig>

3. If you are setting up a separate database to store user management data, update the following configurations in the <PRODUCT_HOME>/repository/conf/ user-mgt.xml file.

   <Configuration>
   	<Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property>
   </Configuration>

Creating database tables

You can create database tables by executing the database scripts as follows: 

1. Run the ij tool located in the <DERBY_HOME>/bin/ directory as illustrated below:
   
2. Create the database and connect to it using the following command inside the ij prompt:

   connect 'jdbc:derby:repository/database/WSO2CARBON_DB;create=true';

   Replace the database file path in the above command with the full path to your database.

3. Exit from the ij tool by typing the exit command.

   exit;

4. Log in to the ij tool with the username and password that you set in registry.xml and user-mgt.xml:
   connect 'jdbc:derby:repository/database/WSO2CARBON_DB' user 'regadmin' password 'regadmin';

5. Use the scripts given in the following locations to create the database tables:

   • To create tables for the registry and user manager database (WSO2CARBON_DB), run the below command:

     run '<PRODUCT_HOME>/dbscripts/derby.sql';

     Now the product is running using the embedded Apache Derby database.

6. Restart the server.