MSSQL Installation

Version 10.2 by Philipp Roessler on 2010/09/03

Microsoft SQL Server Installation

This has been tested on MSSQL 2000 and MSSQL 2005 (text types are only deprecated in MSSQL 2005, this tutorial won't work when they'll be dropped)

Case-insensitive search does not work with this database; see below for more info. You may want to use the the Lucene search

Create the xwiki user and database

  • Use the Enterprise Manager to create a database named 'XWiki' and a user named 'xwiki'.
  • Set xwiki's password to 'xwiki'.
  • Give database ownership of the database XWiki to the user xwiki.

Install the JDBC driver

  • Download the jtds jdbc driver and install the jar file into your servers lib directory (for JBoss this could be server
    , for Tomcat this might be common

The connection was successfully tested with version 1.2.1 of the driver and version 1.5 of XWiki. Some problems occurred when using drivers > 1.2.1 so it might be better to use the old one. 

XWiki configuration

  • Tell XWiki to use MSSQL. To do this, edit the WEB-INF/hibernate.cfg.xml file. Replace the matching properties with the following ones (or uncomment them if they are present):
<property name="connection.url">jdbc:jtds:sqlserver://<server-url>:1433/XWiki;tds=8.0;lastupdatecount=true</property>
    <property name="connection.username">xwiki</property>
    <property name="connection.password">xwiki</property>
    <property name="connection.driver_class">net.sourceforge.jtds.jdbc.Driver</property>
    <property name="dialect">org.hibernate.dialect.SQLServerDialect</property>
    <property name="connection.provider_class"></property>
    <property name="connection.pool_size">2</property>
    <property name="statement_cache.size">2</property>
    <mapping resource="xwiki.mssql.hbm.xml"/>
    <mapping resource="feeds.hbm.xml"/>
    <mapping resource="activitystream.hbm.xml"/>


Fix search function

If you try to do a search, via WebSearch, you will get an error. This is because the UPPER() function doesn not work on TEXT or NTEXT as used by MSSQL 2000 for blobs. The only solution I have found is to remove all the calls to upper() in WebSearch. This is however not very practical, because it makes search case-sensitive.

Alternatively, you may want to use the Lucene search instead of the default search.

Hints for upgrading to MS SQL 2005

In MS SQL 2005 the standard schema in all databases is dbo by default. However, if you upgrade your server with the standard Microsoft software, all tables in your xwiki database will be configured to use a schema whichs name is equivalent to the database name. (If your database name is "xwiki", the schema name will also be "xwiki" and the full qualified tablenames will be "xwiki.xwikidoc", and so on)

Since the standard schema in is configured to be "dbo", xwiki will not find any tables (since it searches for "dbo.xwikidoc", ...). This will result in an exception when calling the xwiki webapp (in the logfiles you will see an "object not found" - exception for xwikidoc, because xwikidoc is the first table to be mapped via hibernate)\ \
There are 2 possible solutions to this problem:

  • Reconfigure your server to use "xwiki" as standard scheme inside the xwiki-database.
  • Adopt the hibernate file (xwiki.mssql.hbm.xml). Look for the table definitions, eg. table="xwikidoc" and set it to table="xwiki.xwikidoc", or to whatever your schema/database is called. Do this for all tables you can find in the file.

Get Connected