Setting up MS SQL

The following sections describe how to replace the default H2 database with MS SQL:

Creating the database and users

Set up the Microsoft SQL database and users as explain in the following topics.

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.

   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, index, select, update, and delete data in tables in the newly created database, as the minimum set of SQL server permissions. 

Creating a datasource for the database

After creating the database, you create the datasource to point to it in the master-datasources.xml file, located in the <PRODUCT_HOME>/repository/conf/datasources directory.

1. Edit the default datasource configuration for storing user management and registry data as shown below. The database configurations in registry.xml and user-mgt.xml files refer to this datasource. 

   <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:postgresql://localhost:5432/gregdb</url>
                   <username>regadmin</username>
                   <password>regadmin</password>
                   <driverClassName>org.postgresql.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 database configuration options:

   url - The URL of the database.
   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.

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

2. Edit the default datasource configuration for storing RSS meta data as shown below. The RSS meta data specific configurations in the rss-config.xml file refers to this datasource. 

   <datasource>
   	<name>MetadataRepo</name>
   	<jndiConfig>
   		<name>MetadataRepoDS</name>
   	</jndiConfig>
   	<definition type="RDBMS">
   		<configuration>
   			<dataSourceClassName>com.microsoft.sqlserver.jdbc.SQLServerXADataSource</dataSourceClassName>
   			<dataSourceProps>
   				<property name="serverName">192.168.17.21</property>
   				<property name="portNumber">1433</property>
   				<property name="databaseName">rss_db</property>
   				<property name="user">RootUser</property>
   				<property name="password">RootPassword</property>
   			</dataSourceProps>
   		</configuration>
   	</definition>
   </datasource>

Setting up RSS meta data configurations

If you have changed the default database for storing RSS meta data as explained above, the following RSS meta data specific configurations should be updated. See Changing the Default RSS configuration for more details.

1. Open the rss-config.xml file stored in the <PRODUCT_HOME>/repository/conf/etc/ directory and do the following changes:

   <Provider>SQLSERVER</Provider>
   <Environments>
   		<Environment>
   			<Name>DEFAULT</Name>
   			<RSSInstances>
   				<RSSInstance>
   					<Name>WSO2RSS1</Name>
   					<InstanceType>SYSTEM</InstanceType>
   					<DbmsType>SQLSERVER</DbmsType>
   					<ServerCategory>LOCAL</ServerCategory>
   					<DataSourceConfiguration>
   						<Definition>
   							<Url>jdbc:sqlserver://192.168.17.21</Url>
   							<Username>RootUser</Username>
   							<Password>RootPassword</Password>
   							<DriverClassName>com.microsoft.sqlserver.jdbc.SQLServerDriver</DriverClassName>
   						</Definition>
   					</DataSourceConfiguration>
   				</RSSInstance>
   			</RSSInstances>
   		</Environment>
   </Environments>

2. Open the persistence.xml file stored in the <PRODUCT_HOME>/repository/conf/etc/ directory and change the properties as shown below.
   

   <property name="openjpa.ConnectionDriverName" value="com.microsoft.sqlserver.jdbc.SQLServerXADataSource" />
   <property name="dialect" value="org.apache.openjpa.jdbc.sql.SQLServerDictionary" />

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.

Using the script

You can create the database tables manually by logging into the created database and running the given scripts. 

• To create tables for the registry and user manager database, use the following script:
  

  <PRODUCT_HOME>/dbscripts/mssql.sql

   

• To create tables for the RSS meta data repository database, use the following script:
  

  <PRODUCT_HOME>/dbscripts/rss-manager/sqlserver/wso2_rss_sqlserver.sql

Using a startup parameter

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