Project Description

MSSqlSchemaDoc extracts schema information from a SQL Server database and saves it as xml files - one per object. It also creates separate xml files loosely resembling the structure of each object but with placeholders where you can add comments to document your database schema. Finally, it can combine the schema information and documentation texts into HTML documentation.

The main benefit of using MSSqlSchemaDoc is that the generated xml files can easily be placed under version control, allowing you to track changes to both your database schema and database documentation separately. It also allows easy browsing of the database documentation through the HTML files. From version 4.1 onwards, HHP (project) and HHK (index) files are also generated to assist with the creation of CHM files using Microsoft's Html Help Workshop - effectively making it a one-step process.

Technical

The application works by defining classes which represent database objects, like tables, views, etc. These classes are decorated with attributes which control how the objects get serialized to XML. XSD schemas specify the expected structure of the XML and are used to validate each serialized object.

Due to performance problems with SMO, custom queries are used to extract the desired data from the database.

Note: Only SQL2005 and SQL2008 is currently supported - SQL2000 support may be added later.

As I am not working with MSSQL at the moment, I am not actively working on the application, if anyone is interested in adding to it, feel free to contact me.

Last edited Sep 23, 2009 at 6:46 AM by henkoberholzer, version 11