Follow the instructions below to set up an embedded Derby database.
Preparing the Derby Database
1. Download Apache Derby from http://apache.mesi.com.ar/db/derby/db-derby-10.8.2.2/ and save it to your computer.
2. Install Apache Derby on your computer by following the instructions at: http://db.apache.org/derby/manuals
Setup Configuration Files
1. Edit the default database configuration defined in the
master-datasources.xml file located at
$CARBON_HOME/repository/conf/datasources directory as below. Both the database configurations in
user-mgt.xml refer this data source.
The configurations should be replaced with your own database name, username, and password.
The database 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 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.
In contrast to the remote Derby, in embedded mode, 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 ESB installation. In the above sample configuration, it is inside the
$DERBY_HOME/lib in to
$CARBON_HOME/repository/components/extensions directory (to the class path of the WSO2 Carbon web application).
Automatic Database Creation
1. The first time you start the server, run with the
-Dsetup option so it will create the Derby database.
- For Linux:
- For Windows:
2. The WSO2 ESB is configured to run using an embedded Apache Derby database.
Manual Database Creation
1. Run the
ij tool located in the
2. Create the database and connect to it using the following command inside the
Replace the database file path in the below command to suit your requirements.
Here you need to give the full path to your database in place of
3. Exit from the the
ij tool by typing the
4. Login to the
ij tool with the username and password you set in the
5. Run the derby scripts for both the registry and user manager (embedded) databases, provided with the WSO2 ESB using the below command.
6. Restart the server. Now WSO2 ESB is running using a remote Apache Derby database.