This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Setting up with Oracle RAC

The following sections describe how to replace the default H2 databases with Oracle RAC.

Oracle Real Application Clusters (RAC) is an option for the Oracle Database for clustering and high availability in Oracle database environments. In the Oracle RAC environment, some of the commands used in oracle.sql are considered inefficient. Therefore, the product has a separate SQL script oracle_rac.sql for Oracle RAC. The Oracle RAC-friendly script is located in the dbscripts folder together with other .sql scripts.

To test products on Oracle RAC, rename oracle_rac.sql to oracle.sql before running -Dsetup.

Step 1: Setting up the Oracle RAC database and user

Follow the steps below to set up an Oracle RAC database.

  1. Set environment variables <ORACLE_HOME>, PATH, and ORACLE_SID with the corresponding values /oracle/app/oracle/product/11.2.0/dbhome_1, $PATH:<ORACLE_HOME>/bin, and orcl1 as follows:
  2. Connect to Oracle using SQL*Plus as SYSDBA.
  3. Create a database user and grant privileges to the user as shown below:

    Create user <USER_NAME> identified by password account unlock;
    grant connect to <USER_NAME>;
    grant create session, create table, create sequence, create trigger to <USER_NAME>;
    alter user <USER_NAME> quota <SPACE_QUOTA_SIZE_IN_MEGABYTES> on '<TABLE_SPACE_NAME>';
    commit;
  4. Exit from the SQL*Plus session by executing the quit command.

Step 2: Copying the JDBC driver

Copy the Oracle JDBC libraries (for example, the <ORACLE_HOME>/jdbc/lib/ojdbc14.jar file) to the <MB_HOME>/repository/components/lib/ directory. 

Remove the old database driver from the <MB_HOME>/repository/components/dropins/ directory when you upgrade the database driver.

Step 3: Connecting the server to an Oracle 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.

Setting up datasource configurations

After creating the database, you create a datasource to point to it in the following files:

  1. Edit the default datasource configuration in the <MB_HOME>/repository/conf/datasources/m aster-datasources.xml file. Replace the url, username, password and driverClassName settings with your custom values and also the other values accordingly as shown below:

    <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:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=on)
       			       (ADDRESS=(PROTOCOL=TCP)(HOST=racnode1) (PORT=1521))
       			       (ADDRESS=(PROTOCOL=TCP)(HOST=racnode2) (PORT=1521))
       			       (CONNECT_DATA=(SERVICE_NAME=rac)))</url>
                <username>regadmin</username>
                <password>regadmin</password>
                <driverClassName>oracle.jdbc.driver.OracleDriver</driverClassName>
                <maxActive>80</maxActive>
                <maxWait>60000</maxWait>
                <minIdle>5</minIdle>
                <testOnBorrow>true</testOnBorrow>
                <validationQuery>SELECT 1 FROM DUAL</validationQuery>
                <validationInterval>30000</validationInterval>
              </configuration>
         </definition>
    </datasource>

    The elements in the above configuration are described below:

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

    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.

    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.

  2. Similarly, edit the database configurations in <MB_HOME>/repository/conf/registry.xml, <MB_HOME>/repository/conf/ user-mgt.xml and <MB_HOME>/repository/conf/identity.xml files as well.

Step 4: Creating the database tables

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 registry and user manager database (WSO2CARBON_DB), use the below script:

    SQL> @$<MB_HOME>/dbscripts/oracle.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