

Changing to Oracle RAC¶

By default, WSO2 Identity Server uses the embedded H2 database as the database for storing user management and registry data. Given below are the steps you need to follow in order to use Oracle RAC for this purpose.

Datasource configurations¶

A datasource is used to establish the connection to a database. By default, WSO2_IDENTITY_DB and WSO2_SHARED_DB datasources are used to connect to the default H2 database.

WSO2_SHARED_DB - The datasource which stores registry and user management data.
WSO2_IDENTITY_DB - The datasource specific for the identity server which stores identity related data

After setting up the Oracle RAC database. You can point the WSO2_IDENTITY_DB or WSO2_SHARED_DB or both to that Oracle RAC database by following below instructions.

Changing the default datasource¶

Minimum Configurations for changing default datasource to Oracle RAC

You can configure the datasource by editing the default configurations in <IS_HOME>/repository/conf/deployment.toml.

Following are the basic configurations and their descriptions.

Element	Description
username and password	The name and password of the database user.
driver	The jdbc driver of the database.
url	The url of the database.

A sample configuration is given below.

WSO2_IDENTITY_DB

Configure the deployment.toml file.

 [database.identity_db]
 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)))"
 username = "regadmin"
 password = "regadmin"
 driver = "oracle.jdbc.OracleDriver"
 [database.identity_db.pool_options]
 maxActive = "80"
 maxWait = "60000"
 minIdle = "5"
 testOnBorrow = true
 validationQuery="SELECT 1 FROM DUAL"
 validationInterval="30000"
 defaultAutoCommit=false

Execute database scripts.

Navigate to <IS_HOME>/dbscripts. Execute the scripts in the following files, against the database created.
- <IS_HOME>/dbscripts/identity/oracle_rac.sql
- <IS_HOME>/dbscripts/identity/uma/oracle_rac.sql
- <IS_HOME>/dbscripts/consent/oracle_rac.sql

WSO2_SHARED_DB

Configure the deployment.toml file.

 [database.shared_db]
 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)))"
 username = "regadmin"
 password = "regadmin"
 driver = "oracle.jdbc.OracleDriver"
 [database.shared_db.pool_options]
 maxActive = "80"
 maxWait = "60000"
 minIdle = "5"
 testOnBorrow = true
 validationQuery="SELECT 1 FROM DUAL"
 validationInterval="30000"
 defaultAutoCommit=false

Execute database scripts.

Navigate to <IS_HOME>/dbscripts. Execute the scripts in the following file, against the database created.
- <IS_HOME>/dbscripts/oracle_rac.sql

If you have a requirement in using workflow feature follow, Changing the default database of BPS database
Download the Oracle RAC JDBC driver for the version, you are using and copy it to the <IS_HOME>/repository/components/lib folder

Note

In earlier versions WSO2 Identity Server had the option to create databases automatically using the -DSetup option from January 2018 onwards WSO2 Identity Server has deprecated the -DSetup option Note that the proper practice is for the DBA to run the DDL statements manually so that the DBA can examine and optimize any DDL statement (if necessary) based on the DBA best practices that are in place within the organization.

Advanced Database Configurations.

Apart from the basic configurations specified above, WSO2 Identity Server supports some advanced database configurations as well.

WSO2_IDENTITY_DB deployment.toml configurations:

[database.identity_db.pool_options]
 maxActive = "80"
 maxWait = "60000"
 minIdle = "5"
 testOnBorrow = true
 validationQuery="SELECT 1 FROM DUAL"
 validationInterval="30000"
 defaultAutoCommit=false

WSO2_SHARED_DB deployment.toml configurations:

[database.shared_db.pool_options]
 maxActive = "80"
 maxWait = "60000"
 minIdle = "5"
 testOnBorrow = true
 validationQuery="SELECT 1 FROM DUAL"
 validationInterval="30000"
 defaultAutoCommit=false

The elements in the above configuration are described below:

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	Indicates 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.
defaultAutoCommit	Indicates Whether to commit database changes automatically or not.
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.
defaultAutoCommit	This property is not applicable to the Carbon database in WSO2 products because auto committing is usually handled at the code level, i.e., the default auto commit configuration specified for the RDBMS driver will be effective instead of this property element. Typically, auto committing is enabled for RDBMS drivers by default. When auto committing is enabled, each SQL statement will be committed to the database as an individual transaction, as opposed to committing multiple statements as a single transaction.

Info

For more information on other parameters that can be defined in the <IS_HOME>/repository/conf/deployment.toml file, see Tomcat JDBC Connection Pool.

Driver-Level Timeouts (Recommended for Production)¶

If the database becomes unresponsive, WSO2 Identity Server threads can get stuck waiting for a JDBC connection. This happens because the Tomcat JDBC Pool can't abort connection creation by itself (source{: target="_blank"}).

To prevent this, configure driver-level timeouts in the JDBC URL:

connectTimeout → Maximum time to wait while establishing a database connection.
socketTimeout (or driver-specific equivalent) → Maximum time to wait for responses on an active connection.
tcpKeepAlive=true (if supported) → Helps detect unresponsive database servers.

Also note the distinction:

maxWait (Tomcat pool) controls how long to wait for a free connection from the pool.
connectTimeout / socketTimeout (driver) → how long to connect/read at the DB level.

Note: The PoolExhaustedException warning log is logged only when maxWait expires (source{: target="_blank"}). It does not cover delays inside the driver’s connection or read operations. Driver-level timeouts are required to handle those cases.

Example: Oracle RAC database¶

[database.identity_db]
url = "jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=DB_HOST1)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=DB_HOST2)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=WSO2_IDENTITY_DB)))?oracle.net.CONNECT_TIMEOUT=10000&oracle.jdbc.ReadTimeout=60000"
username = "..."
password = "..."
driver = "oracle.jdbc.OracleDriver"

Learn more in Oracle JDBC RAC URLs{: target="_blank"}.

Top