This documentation is for WSO2 API Manager 1.8.0 View documentation for the latest release.
Setting up Embedded Derby - API Manager 1.8.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

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

Setting up the database

Follow the steps below to set up an embedded Derby database:

  1. Download Apache Derby.
  2. Install Apache Derby on your computer.

    For instructions on installing Apache Derby, see the Apache Derby documentation.

Setting up the drivers

Copy derby.jarderbyclient.jar, and derbynet.jar from the <DERBY_HOME>/lib/ directory to the <PRODUCT_HOME>/repository/components/extensions/ directory (the classpath of the WSO2 Carbon web application).

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 to 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.

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

         <description>The datasource used for registry and user manager</description>
         <definition type="RDBMS">
                   <validationQuery>SELECT 1</validationQuery>

    The elements in the above configuration are described below:

    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 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 (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.
    minIdleThe minimum number of active connections that can remain idle in the pool without extra ones being created, or enter zero to create none.


    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.

    This property is not applicable to the Carbon database in WSO2 products because auto committing is usually handled at the code level, i.e., the default auto commit configuration specified for the RDBMS driver will be effective instead of this property element. Typically, auto committingis enabled for an RDBMS drivers by default.

    When auto committing is enabled, each SQL statement will be committed to the database as an individual transaction, as opposed to committing multiple statements as a single transaction.

    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.

Configuring new datasources to manage registry or user management data

Follow the steps below to configure new datasources to point to the new databases 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">
  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.

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

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 the ij tool by typing the exit command.
  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.

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/ -Dsetup

The product is configured to run using an embedded Apache Derby database.

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.

Changing the product-specific/identity/storage 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 that come by default or set up a separate database for identity related data, the instructions are the same. In summary:

  1. Add the datasource to the master-datasources.xml file. The datasource for the product-specific database is already there in the master-datasources.xml file by the name WSO2AM_DB. Change its elements with your custom values.

  2. Create the database tables using the following scripts:

    For the product-specific database

    Use the scripts in <PRODUCT_HOME>/dbscripts/apimgt folder

    For the identity database

    Use the scripts in <PRODUCT_HOME>/dbscripts/identity folder

  • No labels