The following sections describe how to replace the default H2 database with MS SQL:
Setting up the database and users
Follow the steps below to set up the Microsoft SQL database and users.
- In the start menu, click Programs and launch Microsoft SQL Server 2005.
- Click Configuration Tools, and then click SQL Server Configuration Manager.
- Enable TCP/IP and disable Named Pipes from protocols of your Microsoft SQL server.
- Double click TCP/IP to open the TCP/IP properties window, and set Listen All to
Yeson the Protocol tab.
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.
- Similarly, enable TCP/IP from SQL Native Client Configuration and disable Named Pipes. Also check whether the port is set correctly to 1433.
- Restart Microsoft SQL Server.
Create the database and user
- Open Microsoft SQL Management Studio to create a database and user.
- Click New Database from the Database menu, and specify all the options to create a new database.
- Click New Login from the Logins menu, and specify all the necessary options.
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.
Setting up the JDBC driver
Download and copy the sqljdbc4 Microsoft SQL JDBC driver file to the WSO2 product's
<PRODUCT_HOME>/repository/components/lib/ directory. Use
com.microsoft.sqlserver.jdbc.SQLServerDriver as the
<driverClassName> in your datasource configuration in
Setting up datasource configurations
A datasource is used to establish the connection to a database. By default,
WSO2_CARBON_DB datasource is used to connect to the default H2 database, which stores registry and user management data. After setting up the Microsoft SQL database to replace the default H2 database, either change the default configurations of the
WSO2_CARBON_DB datasource, or configure a new datasource to point it to the new database as explained below.
Edit the default datasource configuration in the <
aster-datasources.xmlfile as shown below.
The elements in the above configuration are described below:
Element Description url
Give the URL to connect to the Microsoft SQL database. Shown below is the most simple form of the database connection URL. It includes the URL and two parameters:
Change <IP> to the IP of the server. The best practice is to use port 1433 because you can use it in order processing services.
SendStringParametersAsUnicodeto ‘false’ in order to overcome a limitation in the Microsoft SQL client driver. Without this parameter, the database driver will erroneously convert
NVARCHARand lower the database's performance.
username and password The name and password of the database user driverClassName The class name of the database driver 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.
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. 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 an 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.
For more information on other parameters that can be defined in the
master-datasources.xmlfile, see Tomcat JDBC Connection Pool.
- Add a new datasource with similar configurations as the
WSO2_CARBON_DBdatasource above to the <
master-datasources.xmlfile. Change its elements with your custom values. For instructions, see Setting up datasource configurations.
If you are setting up a separate database to store registry-related data, update the following configurations in the <
If you are setting up a separate database to store user management data, update the following configurations in the <
Creating the database tables
To create the database tables, connect to the database that you created earlier and run the following scripts.
To create tables in the registry and user manager database (
WSO2CARBON_DB), use the below script:
Restart the server.
You can create database tables automatically when starting the product for the first time by using the
-Dsetupparameter as follows:
Changing the database for identity-related data
The topics above show how to change the
WSO2_CARBON_DB, which is used to store registry and user manager information. However, If you set up a separate database for identity-related data, the instructions are the same. In summary:
Add the new datasource configuration to the
master-datasources.xmlfile. Change its elements with your custom values as shown above.
Create the database tables using the following scripts.
For the identity data Use
For data related to identity management (like service provider and identity provider data) Use