How do I...Verify my database schema using CheckDb?

Overview

mindtouch.deki.checkdb.exe is a tool to check the integrity of a Deki database.  CheckDb runs a series of tests to verify the database table schema, indexes, character set, etc.  As Deki evolves, we will continue to add new tests to CheckDb.  CheckDb is an executable that can be run on it's own but each test is also an NUnit test which can be run from the NUnit GUI or console.

Configuration

CheckDb requires an xml configuration file named mindtouch.deki.checkdb.config.xml to be located in the same directory as the mindtouch.deki.checkdb.exe binary.  Here is an example of the mindtouch.deki.checkdb.config.xml

<config>
  <db-catalog>wikidb</db-catalog>
  <db-user>someuser</db-user>
  <db-password>somepassword</db-password>
  <db-options>pooling=true; Connection Timeout=5; Connection Lifetime=30; Protocol=socket; Min Pool Size=2; Max Pool Size=50; Connection Reset=false;character set=utf8;ProcedureCacheSize=25;Use Procedure Bodies=true;</db-options>
  <db-server>dekidev</db-server>
  <db-port>3306</db-port>
</config>

CheckDb also relies on an xml file (mindtouch.deki.checkdb.schema.xml) which defines what the Deki database schema should look like.  This file is auto-generated based on a clean Deki installation and shouldn't need to be modified.

Running CheckDb

To run checkdb from the command line, do the following:

cd /var/www/dekiwiki/bin
mono mindtouch.deki.checkdb.exe

Running CheckDb from NUnit

To run the checkdb unit tests with nunit-console2 execute:

nunit-console2 mindtouch.deki.checkdb.exe 

Tor run the checkdb tests from nunit-gui, you'll want to get the mindtouch.deki.checkdb.nunit file from our SVN repository

curl https://svn.mindtouch.com/source/public/dekiwiki/trunk/src/tests/CheckDb/mindtouch.deki.checkdb.nunit -o mindtouch.deki.checkdb.nunit

Edit this file in a text editor and change the appbase to:

appbase="."

Then load the mindtouch.deki.checkdb.nunit file and run the tests

Tests