Page Comparison

Creating The Database

Follow the steps below to set up a Microsoft SQL databaseThe following sections describe how to replace the default H2 database with MS SQL:

...

You can create the database tables manually by logging into the created database and running the following scripts:

...

Setting up the database and users

Set up the Microsoft SQL database and users as follows:

Enable TCP/IP

1. In the start menu, click Programs and launch Microsoft SQL Server 2005.
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.

   Info
   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 data into tables in the newly created database.

Copying the JDBC driver

Download and copy the Microsoft SQL JDBC driver file jtds-1.2.2.jar to the WSO2 product's <PRODUCT_HOME>/repository/components/lib/ directory. 

Creating the database tables

Create the database tables either manually by running a script or automatically by using a startup parameter .

...

Changing the identity database

The topics above show how to change the WSO2_CARBON_DB, which is used to store registry and user manager information. If you set up a separate database for identity related data, the instructions are the same. In summary:

1. Add the datasource to the master-datasources.xml file. 

2. Create the database tables using the following scripts: 

   For the identity database

   Use <PRODUCT_HOME>/dbscripts/identity/mssql.sql

...

You can create database tables automatically when starting the product for the first time by using the -Dsetup parameter as follows:

• For Linux:
  

  sh wso2server.sh -Dsetup

• For Windows:
  

  wso2server.bat -Dsetup

Creating A Datasource For The Database

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

1. Edit the default datasource configuration defined in the master-datasources.xml file, located in the <PRODUCT_HOME>/repository/conf/datasources/ directory, as shown below. The database configurations in registry.xml and user-mgt.xml refer to this data source.

   Info
   Replace the url, username, password and driverClassName settings with your custom values and also the other values accordingly in the master-datasources.xml file as shown below.

   Code Block
   language html/xml
   <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:jtds:sqlserver://10.100.3.251:1433/wso2greg</url> <username>regadmin</username> <password>regadmin</password> <driverClassName>net.sourceforge.jtds.jdbc.Driver</driverClassName> <maxActive>80</maxActive> <maxWait>60000</maxWait> <minIdle>5</minIdle> <testOnBorrow>true</testOnBorrow> <validationQuery>SELECT 1</validationQuery> <validationInterval>30000</validationInterval> </configuration> </definition> </datasource>

   Following are the datasource configuration options:

   • url - The URL of the database.

     Info
     Default port for Microsoft SSQL is 1433.

   • username - The name of the database user.
   • password - The password of the database user.
   • driverClassName - The class name of the database driver.
   • maxActive - The maximum number of active connections that can be allocated from this pool at the same time, or enter a negative value for no limit.
   • 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 -  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. 

     Info
     For more information on other parameters that can be defined in the master-datasources.xml file, see Tomcat JDBC Connection Pool.

2. If you changed the databases used for identity, copy the WSO2_CARBON_DB datasource configuration for it in < PRODUCT_HOME>/repository/conf/datasources/master-datasources.xml file and replace its default values with your custom values.

3. Replace the default values in the datasource configurations of the following files with your custom values accordingly, to point to the created registry and user manager and identity databases.

4. <PRODUCT_HOME>/repository/conf/identity.xml
5. <PRODUCT_HOME>/repository/conf/user-mgt.xml
<PRODUCT_HOME>/repository/conf/registry.xml