Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

When you use the Message Broker profile in WSO2 EI, a separate database is required for storing data specific to the broker. This is in addition to the default /wiki/spaces/ADMIN5xx/pages/22151545Carbon database. By default, the EI Message Broker is shipped with an embedded H2 database (WSO2MB_DB.ht.db) for this purpose. These databases are stored in the <EI_HOME>/wso2/broker/repository/database directory.

Info

For instructions on changing the default Carbon database, see /wiki/spaces/ADMIN5xx/pages/22151545 Changing the Carbon Database in the WSO2 Product Administration Guide.

...

A datasource is used to establish the connection to a database. By default,  the WSO2_MB_CARBONSTORE_DB datasource is configured in the master-datasources.xml file for the purpose of connecting to the default  H2 database , which stores registry and user management 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_CARBONSTORE_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.

  1. Open the <EI_HOME>/wso2/broker/conf/datasources/m aster-datasources.xml file and locate the <datasource> configuration element.

  2. You You simply have to update the the url pointing  pointing to your MySQL database, the the username and  and password required  required to access the database and the MySQL driver details  driver details as shown below. Further, be sure to set the <defaultAutoCommit> element to false for the MB database. 

    Localtabgroup
    Localtab
    titleMySQL
    Code Block
    languagehtml/xml
    <datasource>
        
           <name>WSO2_MB_STORE_DB</name>
                <description>The datasource used for message broker database</description>
        <description></description>
           <jndiConfig>
                    <name>WSO2MBStoreDB<<name>jdbc/WSO2MBStoreDB</name>
    
               </jndiConfig>
       
            <definition type="RDBMS">
        
               <configuration>
        
                   <url>jdbc:h2mysql:repository//databaselocalhost:3306/WSO2MB_DB;DB_CLOSE_ON_EXIT=FALSE;LOCK_TIMEOUT=60000<wso2_mb</url>
                        <username>wso2carbon<<username>regadmin</username>
                        <password>wso2carbon<<password>regadmin</password>
                        <driverClassName>org.h2<driverClassName>com.mysql.jdbc.Driver</driverClassName>
                   <maxActive>80</maxActive>
         <maxActive>50</maxActive>          <maxWait>60000</maxWait>
              <maxWait>60000</maxWait>     <minIdle>5</minIdle>
                   <testOnBorrow>true</testOnBorrow>
                        <validationQuery>SELECT 1</validationQuery>
    
                       <validationInterval>30000</validationInterval>
                    			    <defaultAutoCommit>false</defaultAutoCommit>
        
               </configuration>
                </definition>
    </datasource>
    Localtab
    titleMS SQL
    Code Block
    languagexml
    <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>         
    Localtab
    titleOracle
    Code Block
    languagexml
    <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>
  3. Optionally, you can update the configuration elements given below for your database connection.

    The name and password of the database user
    ElementDescription
    urlThe URL of the database. The default port for MySQL is 3306
    username and password
    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.
    Anchor
    default_auto_commit
    default_auto_commit
    defaultAutoCommit

    It is required to disable auto committing by setting this property to false for the MB database. This means that multiple SQL statements will be committed to the database as one transaction, as opposed to committing each SQL statement as an individual transaction.

    Info

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

...

Excerpt
hiddentrue

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 comes by default or set up a separate database for identity or storage related data, the instructions are the same. In summary:

  1. For the identity databaseAdd it to the <PRODUCT_HOME>/repository/conf/datasources/<check the correct path and add file name (something like master-datasources.xml)>
    For the storage databaseAdd 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 databaseAdd it to the <PRODUCT_HOME>/repository/conf/<check the correct path and add file name (something like api-manager.xml)
  2. Create the database tables using the following scripts:

    For the identity databaseUse <PRODUCT_HOME>/dbscripts/identity/<check the correct path and add file name (something like mysql.sql)>
    For the storage databaseUse  <PRODUCT_HOME>/dbscripts/storage/<check the correct path and add file name (something like /mysql/resoucre.sql)>
    For the product-specific databaseUse  <PRODUCT_HOME>/dbscripts/<check the correct path and add file name (something like /apimgt/mysql.sql)> 
  3. 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
      languagexml
      <JDBCPersistenceManager>
      	<DataSource>
      		<!-- Include a data source name (jndiConfigName) from the set of datasources defined in master-datasources.xml -->
      		<Name>jdbc/WSO2CarbonDB</Name>
      	</DataSource>
      </JDBCPersistenceManager>

      Note to writers: For step 3, add content on the XML files which include references on any of the additional databases and require edits that are relevant to your product similar to the given example.