Setting up the database
Follow the steps below to set up a remote Derby database.
- Download Apache Derby.
Install Apache Derby on your computer.
For instructions on installing Apache Derby, see the Apache Derby documentation.
- Go to the
<DERBY_HOME>/bin/ directory and run the Derby network server start script. Usually it is named
Setting up the drivers
derbynet.jar from the <
DERBY_HOME>/lib/ directory to the <
PRODUCT_HOME>/repository/components/extensions/ directory (the classpath of the 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 Remote 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
Edit the default datasource configuration in the <
aster-datasources.xmlfile 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.ClientDriver</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:
Element Description url The URL of the database. The default port for a DB2 instance is 50000. username and password The name and password of the database user driverClassName The class name of the database driver maxActive The 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. 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. You can enter zero or a negative value to wait indefinitely. minIdle The 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. validationQuery The SQL query that will be used to validate connections from this pool before returning them to the caller. validationInterval The 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. defaultAutoCommit
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 committing is 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
master-datasources.xmlfile, see Tomcat JDBC Connection Pool.
In contrast to setting up with embedded Derby, in the remote registry you set the database driver name (the
driverNameelement) to the value
org.apache.derby.jdbc.ClientDriverand the database URL (the
urlelement) to the database remote location.
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.
- Add a new datasource with similar configurations as the
WSO2_CARBON_DBdatasource above to the <
master-datasources.xmlfile . Change its elements with your custom values. For instructions, see Setting up datasource configurations.
If you are setting up a separate database to store registry-related data, update the following configurations in the <
<dbConfig name="wso2registry"> <dataSource>jdbc/MY_DATASOURCE_NAME</dataSource> </dbConfig>
If you are setting up a separate database to store user management data, update the following configurations in the <
<Configuration> <Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property> </Configuration>
Creating database tables
You can create database tables by executing the following script(s):
- Run the
ijtool located in the
- Create the database and connect to it using the following command inside the
Replace the database file path, user name, and password in the above command to suit your requirements.
- Exit from the
ijtool by typing the
exitcommand as follows:
Log in to the
ijtool with the username and password you just used to create the database.
connect 'jdbc:derby://localhost:1527/db' user 'regadmin' password 'regadmin';
You can create database tables manually by executing the following scripts.
To create tables in the registry and user manager database (
WSO2CARBON_DB), use the below script:
Restart the server.
You can create database tables automatically when starting the product for the first time by using the
-Dsetupparameter as follows:
The product is now configured to run using a remote Apache Derby database.