Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Table of Contents
maxLevel3
minLevel3

...

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 to  and point it to the new database as explained below.

...

  1. Edit the default datasource configuration in the <PRODUCT_HOME>/repository/conf/datasources/m aster-datasources.xml file as shown below.

    Code Block
    languagehtml/xml
    <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>
             </configuration>
         </definition>
    </datasource>

    The elements in the above configuration are described below:

    ElementDescription
    urlThe URL of the database. The default port for a DB2 instance is 50000.
    username and passwordThe name and password of the database user.
    driverClassNameThe class name of the database driver.
    maxActiveThe maximum number of active connections that can be allocated  at allocated at the same time from this pool. Enter any negative value to denote an unlimited number of active connections.
    maxWaitThe maximum number of milliseconds that the pool will wait should elapse (when there are no available connections ) for a connection to be returned before throwing in the pool) before the system throws an exception. You can enter zero or a negative value to wait indefinitely.
    minIdleThe minimum number of active connections that can remain idle in the pool without extra ones being created, or enter . 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.
    validationQueryThe SQL query that will be used to validate connections from this pool before returning them to the caller.
    validationIntervalThe 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.
    Info

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

...

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

...

  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';
    Info

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

  3. Exit from the 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:

      Code Block
      languagepowershell
      run '<PRODUCT_HOME>/dbscripts/derby.sql';
      Info

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

  6. Restart the server.

...

Info

In contrast to setting up with remote Derby, when setting up with the embedded mode, set the database driver name (the driverClassName element) to the value org.apache.derby.jdbc.EmbeddedDriver and the database URL (the url element) to the database directory location relative to the installation. In the above sample configuration, it is inside the <DERBY_HOME>/WSO2_CARBON_DB/ directory.