The following sections describe how to replace the default H2 databases with Remote H2:
Setting up the remote H2 database
Follow the steps below to set up a Remote H2: database.
Download and install the H2 database engine on your computer as follows.
For instructions on installing, see the H2 installation guide.
- Go to the <
H2_HOME>/bin/directory and run the H2 network server starting script as follows, where <
H2_HOME>is the H2 installation directory:
- Run the H2 database server with the following commands:
- For Linux:
- For Windows:
The script starts the database engine and opens a pop-up window.
- For Linux:
Click Start Browser to open a web browser containing a client application, which you use to connect to a database. If a database does not already exist by the name you provided in the JDBC URL text box, H2 will automatically create a database.
Setting up the drivers
WSO2 currently ships H2 database engine version h2-1.2.140.* and its related H2 database driver. If you want to use a different H2 database driver, take the following steps:
- Delete the following H2 database-related JAR file, which is shipped with WSO2 products:
Find the JAR file of the new H2 database driver (
<H2_HOME>is the H2 installation directory) and copy it to your WSO2 product's
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 H2 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.
Edit the default datasource configuration in the <
aster-datasources.xmlfile as shown below.
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.
- 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 <
If you are setting up a separate database to store user management data, update the following configurations in the <
Creating database tables
To create the database tables, connect to the database that you created earlier and run the following scripts in H2 shell or web console:
To create tables in the registry and user manager database (
WSO2CARBON_DB), use the below script:
Follow the steps below to run the script in Web console:
- Run the
./h2.shcommand to start the Web console.
- Copy the script text from the SQL file.
- Paste it into the console.
- Click Run.
Restart the server.
You can create database tables automatically when starting the product for the first time by using the
-Dsetupparameter as follows:
Changing the product-specific/identity 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 (
WSO2AM_DB) that comes by default or set up a separate database for identity related data, the instructions are the same. In summary:
Add the datasource to the
master-datasources.xmlfile. The datasource for the product-specific database is already there in the file by the name
WSO2AM_DB.Change its elements with your custom values.
Create the database tables using the following scripts:
For the product-specific database
Use the scripts in
For the identity database
Use the scripts in