This documentation is for WSO2 Message Broker 3.0.0. View documentation for the latest release.
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.
Skip to end of metadata
Go to start of metadata

The following sections describe how to replace the default H2 database with MS SQL.

Step 1: Setting up the MSSQL database and users

Follow the steps below to set up the Microsoft SQL database and users.

Enable TCP/IP

  1. In the start menu, click Programs and launch Microsoft SQL Server 2012.
  2. Click Configuration Tools, and then click SQL Server Configuration Manager.
  3. Enable TCP/IP and disable Named Pipes from protocols of your Microsoft SQL server.
  4. Double click TCP/IP to open the TCP/IP properties window, and set Listen All to Yes on the Protocol tab.
  5. On the IP Address tab, disable TCP Dynamic Ports by leaving it blank and give a valid TCP port, so that Microsoft SQL server will listen on that port.

    The best practice is to use port 1433, because you can use it in order processing services.

  6. Similarly, enable TCP/IP from SQL Native Client Configuration and disable Named Pipes. Also check whether the port is set correctly to 1433.
  7. Restart Microsoft SQL Server.
Create the database and user
  1. Open Microsoft SQL Management Studio to create a database and user.
  2. Click New Database from the Database menu, and specify all the options to create a new database.
  3. Click New Login from the Logins menu, and specify all the necessary options.
Grant permissions

Assign newly created users the required grants/permissions to log in, create tables, and insert, index, select, update, and delete data in tables in the newly created database, as the minimum set of SQL server permissions. 

Step 2: Connecting the server to the MSSQL database

Once you have setup the physical database as explained in the previous step, the next step is to enable the connectivity between your MB server and the database. This can be done by simply copying the relevant database drivers to your server, and then configuring the datasources in MB to link to the new database. See the instructions given below.

Copying the JDBC driver

Download and copy one of the following drivers to the <MB_HOME>/repository/components/lib/ directory. 

Once this is done, the driver class relevant to the driver you use should be updated in the master-datasources.xml file when you set up the datasource configurations. By default the master-datasources.xml file is configured with the driver class for the jtds-1.3.1.jar driver, which is net.sourceforge.jtds.jdbc.Driver. If you use the JDBC driver 6.0, 4.2, 4.1 or 4.0, you need to change the driver class configuration to

Setting up datasource configurations

The connection between physical databases and the server is established through datasources. The master-datasources.xml file (stored in the <MB_HOME>/repository/conf/datasources directory) is the default datasource configuration file that is shipped with WSO2 products. In the case of WSO2 MB, since we use two databases (Carbon database for registry/user management data and the MB-specific database for storing MB data), the master-datasources.xml file should contain two separate datasource configurations corresponding to the two databases.

If you check the default master-datasources.xml file in the product, you will see that the configurations point to the embedded H2 databases. The instructions given below explain how you can divert the default configurations to point to the external MySQL database you created in step 1.

Follow the steps given below to replace the MB-specific datasource configuration with a new connection to the MSSQL database:

  1. Open the <MB_HOME>/repository/conf/datasources/master-datasources.xml file. This is where datasources are configured to point to the databases used by WSO2 MB. This file consists of commented out configurations for datasources. The datasource configuration for MSSQL is among these. The changes made to this file must be done in both broker nodes.
  2. Uncomment or add the following configuration to the master-datasources.xml file. Update the JDBC URL to correctly point to your database and enter the username and password for the MSSQL database user with the proper permissions. The <driverClassName> element should be updated according to the driver you used.

       <definition type="RDBMS">
                        <validationQuery>SELECT 1</validationQuery>

    The elements in the above configuration are described below:

    urlThe URL of the database. The default port for a DB2 instance is 50000.
    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.


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


    Specifies whether each SQL statement should be automatically committed when it is completed. By default, this element is set to false.

    For more information on other parameters that can be defined in the <MB_HOME>/repository/conf/datasources/master-datasources.xml file, see Tomcat JDBC Connection Pool.

  3. 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.
  4. In the broker.xml file we need to use the MSSQL message store and Andes context store. To do this, uncomment or add the following configuration.

      <messageStore class="">
            <property name="dataSource">jdbc/MSSQLWSO2MBStoreDB</property>
      <andesContextStore    class="">
            <property name="dataSource">jdbc/MSSQLWSO2MBStoreDB</property>

    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.

Step 3: Creating the database tables

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:

  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/ -Dsetup

  • No labels