This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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

Preparing the Derby Database

1. Use the wget command to download and save Apache Derby on your computer.

2. Install Apache Derby on your computer.

Tip

You can find installation instructions here.

Setup Configuration Files

1. Edit the registry.xml file located in the $GREG_HOME/repository/conf directory of the deployed registry instance as shown below.

Note

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

<currentDBConfig>derby-db</currentDBConfig>
    <dbConfig name="derby-db">
        <url>jdbc:derby:repository/database/WSO2CARBON_DB;create=true</url>
        <userName>regadmin</userName>
        <password>regadmin</password>
        <driverName>org.apache.derby.jdbc.EmbeddedDriver</driverName>
        <maxActive>80</maxActive>
        <maxWait>60000</maxWait>
        <minIdle>5</minIdle>
    </dbConfig>
The database configuration options
  • url - The URL of the database.
  • userName - The name of the database user.
  • password - The password of the database user.
  • driverName - 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.

Note

In contrast to the remote registry, in embedded registry you will set the database driver name ( the driverName element) to the value org.apache.derby.jdbc.EmbeddedDriver and the database URL (the url element) to the database directory location relative to the registry installation. In the above sample configuration, it is inside the database/WSO2CARBON_DB directory.

2. Edit the user-mgt.xml file located in the $GREG_HOME/repository/conf directory of the deployed instance as below.

Note

You have to replace these settings with your custom values.

<Configuration>
        ...
        <Property name="url">jdbc:derby:repository/database/WSO2CARBON_DB;create=true</Property>
        <Property name="userName">regadmin</Property>
        <Property name="password">regadmin</Property>
        <Property name="driverName">org.apache.derby.jdbc.EmbeddedDriver</Property>
        <Property name="maxActive">50</Property>
        <Property name="maxWait">60000</Property>
        <Property name="minIdle">5</Property>
    </Configuration>

Setup Drivers

Place derby.jar, derbyclient.jar and derbynet.jar in the $GREG_HOME/repository/components/extensions directory (to the class path of the WSO2 Governance Registry web application).

Create Database

Automatic Database Creation

1. The first time you start the registry, run with the -Dsetup option so it will create the Derby database.

  • For Linux:
wso2server.sh -Dsetup

  • For Windows:
wso2server.bat -Dsetup

2. The WSO2 Governance Registry is configured to run using an embedded Apache Derby database.

Manual Database Creation

1. Run the ij tool located in the <derby-installation-directory>/bin directory.

2. Create the registry database and connect to it using the following command inside the ij prompt.

Note

Replace the database file path in the below command to suit your requirements.

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

Note

Here you need to give the full path to your registry database in place of /WSO2CARBON_DB.

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

exit;

4. Login to the ij tool with the username and password you set in the registry.xml and user-mgt.xml.

connect 'jdbc:derby:repository/database/WSO2CARBON_DB' user 'regadmin' password 'regadmin';

5. Run the derby scripts for both the registry and user manager (embedded inside the Registry) databases, provided with the WSO2 Governance Registry using the below command.

run 'GREG_HOME/dbscripts/derby.sql';

6. Restart the WSO2 Registry instance. Now WSO2 Governance Registry is running using a remote Apache Derby database.

  • No labels