Page Comparison

The following sections describe how to set up a remote H2 database to replace the default H2 databases with Remote H2database in your WSO2 product:

Table of Contents

maxLevel	3
minLevel	3

NOTES TO WRITERS: Include this intro sentence and TOC at the beginning of your hosting page:

The following sections describe how to replace the default H2 databases with Remote H2: 3

Excerptwarning

hidden	true

Table of Contents

maxLevel

3

minLevel

title	When to use the embedded H2 database?

The embedded H2 database is NOT recommended in enterprise testing and production environments. It has lower performance, clustering limitations, and can cause file corruption failures. Please use an industry-standard RDBMS such as Oracle, PostgreSQL, MySQL, or MS SQL instead.

However, you can use the embedded H2 database as the local registry in a registry mount even in enterprise testing and production environments.

Setting up the remote H2 database

Follow the steps below to set up a Remote H2 : databasedatabase.

Download and install the H2 database engine on your computer as follows. :
Info
For instructions on installing, see the H2 installation guide.
Go to the <H2_HOME>/bin/ directory 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:
```
$ ./h2.sh
```
- For Windows:
```
$ h2.bat
```
Info
The script starts the database engine and opens a pop-up window.
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.

...

Delete the following H2 database-related JAR file, which is shipped with WSO2 products:
<PRODUCT_HOME>/repository/components/plugins/h2-database-engine_1.2.140.wso2v3.jar
Find the JAR file of the new H2 database driver (<H2_HOME>/bin/h2-*.jar, where <H2_HOME> is the H2 installation directory) and copy it to your WSO2 product's <PRODUCT_HOME>/repository/components/lib/ directory directory.

...

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.

...

Follow the steps below to change the type of the default WSO2_CARBON_DB datasource.

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

Code Block

language	html/xml

<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:h2:tcp://localhost/~/registryDB;create=true</url>
               <username>regadmin</username>
               <password>regadmin</password>
               <driverClassName>org.h2.Driver</driverClassName>
               <maxActive>80</maxActive>
               <maxWait>60000</maxWait>
               <minIdle>5</minIdle>
               <testOnBorrow>true</testOnBorrow>
               <validationQuery>SELECT 1</validationQuery>
               <validationInterval>30000</validationInterval>
           </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.
testOnBorrow	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.

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

...

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_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.
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.
Code Block
language xml
<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 <PRODUCT_HOME>/repository/conf/ user-mgt.xml file.
Code Block
language xml
<Configuration> <Property name="dataSource">jdbc/MY_DATASOURCE_NAME</Property> </Configuration>

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:
Code Block
<PRODUCT_HOME>/dbscripts/h2.sql

Follow the steps below to run the script in Web console:

Run the ./h2.sh command to start the Web console.
Copy the script text from the SQL file.
Paste it into the console.
Click Run.
Image Removed

Restart the server.

Info

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/wso2server.sh -Dsetup

...

hidden	true

Note to writers: Add this content at the end of the page if any of the additional databases is relevant to your product.

Changing the identity/storage/product-specific 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 or storage related data, the instructions are the same. In summary:

...

Add a new datasource configuration to the following files for each of the separate databases that you need to create.

For the identity database	Add it to the `<PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)>`
For the storage database	Add it to the <`PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)`
For the product-specific database	Add it to the <`PRODUCT_HOME>/repository/conf/<check the correct path and add file name (something like api-manager.xml)`

...

Create the database tables using the following scripts:

For the identity database	Use `<PRODUCT_HOME>/dbscripts/identity/<check the correct path and add file name (something like mysql.sql)>`
For the storage database	Use `<PRODUCT_HOME>/dbscripts/storage/<check the correct path and add file name (something like /mysql/resoucre.sql)>`
For the product-specific database	Use `<PRODUCT_HOME>/dbscripts/<check the correct path and add file name (something like /apimgt/mysql.sql)>`

Update the following configurations, with the defined datasource name of the corresponding database configuration you added to the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file.

If you are setting up a separate database to store identity related data, update the following configurations in the <PRODUCT_HOME>/repository/conf/identity.xml file.

Code Block

language	xml

<JDBCPersistenceManager>
	<DataSource>
		<!-- Include a data source name (jndiConfigName) from the set of datasources defined in master-datasources.xml -->
		<Name>jdbc/WSO2CarbonDB</Name>
	</DataSource>
</JDBCPersistenceManager>

...

What's next

Next, you need to configure your product with Embedded H2 database. For more information, see Changing to Remote H2.

Versions Compared

Old Version 1

New Version Current

Key

Setting up the remote H2 database

Creating database tables

Note to writers: Add this content at the end of the page if any of the additional databases is relevant to your product.

Changing the identity/storage/product-specific databases

What's next