Due to a known issue do not use JDK1.8.0_151 with WSO2 products. Use JDK 1.8.0_144 until JDK 1.8.0_162-ea is released.
This documentation is for WSO2 Message Broker version 3.2.0. For the latest documentation, see the documentation for WSO2 Enterprise Integrator.
Skip to end of metadata
Go to start of metadata

In addition to the Carbon database, WSO2 Message Broker (WSO2 MB) requires a separate database for storing data that is specific to WSO2 MB. By default, WSO2 MB is shipped with an embedded H2 database (WSO2MB_DB.ht.db) for this purpose. These databases are stored in the <MB_HOME>/repository/database directory.

For instructions on changing the default Carbon database, see Changing the Carbon Database in the WSO2 Product Administration Guide.

Given below are the steps you need to follow in order to change the default WSO2 MB database.


Setting up the database

You can set up one of the following databases for storing WSO2 MB data:

Creating the datasource connection

A datasource is used to establish the connection to a database. By default, the WSO2_MB_STORE_DB datasource is configured in the master-datasources.xml file for the purpose of connecting to the default  H2 database that stores MB-specific data. 

After setting up the MySQL database to replace the default H2 database, either change the default configurations of the WSO2_MB_STORE_DB datasource, or configure a new datasource to point it to the new database as explained below.

Follow the steps below.

  1. Open the <PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file and locate the <datasource> configuration element.

  2. You simply have to update the url pointing to your database, the username and password required to access the database and theM driver details as shown below. Further, be sure to disable auto committing by setting the <defaultAutoCommit> element to false for the MB database. When auto committing is disabled, multiple SQL statements will be committed to the database as one transaction, as opposed to committing each SQL statement as an individual transaction.

    Optionally, you can update the other elements for your database connection.

    <datasource>
           <name>WSO2_MB_STORE_DB</name>
           <description></description>
           <jndiConfig>
               <name>jdbc/WSO2MBStoreDB</name>
           </jndiConfig>
           <definition type="RDBMS">
               <configuration>
                   <url>jdbc:mysql://localhost:3306/wso2_mb</url>
                   <username>wso2carbon</username>
                   <password>wso2carbon</password>
                   <driverClassName>com.mysql.jdbc.Driver</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>
    <datasource>
       <name>WSO2_MB_STORE_DB</name>
       <description></description>
       <jndiConfig>
           <name>WSO2MBStoreDB</name>
       </jndiConfig>
       <definition type="RDBMS">
             <configuration>
                        <url>jdbc:jtds:sqlserver://localhost:1433/wso2_mb</url>
                        <username>sa</username>
                        <password>sa</password>
                        <driverClassName>com.microsoft.sqlserver.jdbc.SQLServerDriver</driverClassName>
                        <maxActive>200</maxActive>
                        <maxWait>60000</maxWait>
                        <minIdle>5</minIdle>
                        <testOnBorrow>true</testOnBorrow>
                        <validationQuery>SELECT 1</validationQuery>
                        <validationInterval>30000</validationInterval>
                        <defaultAutoCommit>false</defaultAutoCommit>
             </configuration>
         </definition>
    </datasource>         
    <datasource>
         <name>WSO2_MB_STORE_DB</name>
    	 <description></description>
         <jndiConfig>
             <name>WSO2MBStoreDB</name>
         </jndiConfig>
         <definition type="RDBMS">
             <configuration>
                <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
                <url>jdbc:oracle:thin:@localhost:1521/orcl</url>
                <maxActive>100</maxActive>
                <maxWait>60000</maxWait>
                <minIdle>5</minIdle>
                <testOnBorrow>true</testOnBorrow>
                <validationQuery>SELECT 1 FROM DUAL</validationQuery>
                <validationInterval>30000</validationInterval>
                <username>scott</username>
                <password>tiger</password>
                <defaultAutoCommit>false</defaultAutoCommit>
             </configuration>
         </definition>
    </datasource>

Optional DB configurations

ElementDescription
urlThe URL of the database. The default port for MySQL is 3306
username and passwordThe name and password of the database user
driverClassNameThe class name of the database driver
maxActiveThe 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.
maxWaitThe 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.
minIdleThe 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.
validationQueryThe SQL query that will be used to validate connections from this pool before returning them to the caller.
validationIntervalThe 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.

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.

Updating other configuration files

  1. Open the <MB_HOME>/repository/conf/broker.xml file. This is the root configuration file of WSO2 MB. The changes made to this file must be done in all the MB nodes.
  2. In the broker.xml file we need to use the Oracle message store and Andes context store. To do this, uncomment or add the following configuration.

    ...
    <messageStore class="org.wso2.andes.store.rdbms.RDBMSMessageStoreImpl">
               <property name="dataSource">WSO2MBStoreDB</property>
    </messageStore>
    
    <andescontextStore class="org.wso2.andes.store.rdbms.RDBMSAndesContextStoreImpl">
               <property name="dataSource">WSO2MBStoreDB</property>
    </andescontextStore>

    The elements in the above configuration are described below.

    • The fully qualified name of the respective implementation class should be defined under the class attributes of messageStore and andesContextStore elements. This implementation class will be used by MB to persist relevant information.

    • The <property> elements are used to define different properties for each store. The minimal property for starting each store is the dataSource property. Depending on the implementation, the required properties may differ.

Creating database tables

To create the database tables, connect to the database that you created earlier and run the following scripts: 

To create the database tables, connect to the database that you created earlier and run the following scripts.

  1. To create tables in the MB-specific database (WSO2_MB), use the below script:

     You may have to enter the password for each command when prompted.

    mysql -u root -p -DWSO2_MB < '<WSO2MB_HOME>/dbscripts/mb-store/mysql-mb.sql ';
  2. Restart the server.

    You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

    • For Windows: <MB_HOME>/bin/wso2server.bat -Dsetup

    • For Linux: <MB_HOME>/bin/wso2server.sh -Dsetup

To create the database tables, connect to the database that you created earlier and run the following scripts.

  1. To create tables in MB-specific database (wso2mb), use the below script:

    <WSO2MB_HOME>/dbscripts/mb-store/mssql-mb.sql
  2. Restart the server.

    You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

    • For Windows: <MB_HOME>/bin/wso2server.bat -Dsetup

    • For Linux: <MB_HOME>/bin/wso2server.sh -Dsetup

To create the database tables, connect to the database that you created earlier and run the following scripts in SQL*Plus:

  1. To create tables in the MB-specific database, use the below script:

    SQL> @$<MB_HOME>/dbscripts/mb-store/oracle-mb.sql
  2. Restart the server.

    You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

    • For Windows: <MB_HOME>/bin/wso2server.bat -Dsetup

    • For Linux: <MB_HOME>/bin/wso2server.sh -Dsetup

  • No labels