Click here to Skip to main content
Click here to Skip to main content

Microsoft SQL Server Database Documentor

, 17 Aug 2006 CPOL
Rate this:
Please Sign up or sign in to vote.
A Microsoft SQL Server database documentor, using Crystal Reports.

Sample Image - dt2.jpg


This project uses Crystal Reports to generate a database schema listing on a Microsoft SQL Server database. The listing includes extended column information including column descriptions. This project requires Visual Studio 2003 or 2005, .NET Framework 1.1, and the Crystal Reports for Visual Studio component.

The generated report lists column names, data types, size, description, etc. Primary key columns are preceded by an asterisk. Columns names are italicized when the column is allowed to be NULL in the table.


One day I set out to document a database that I had been studying. Using the Table Designer in Enterprise Manager, I began entering descriptions of the columns of each table. Later on, I discovered that there is no way to print out the column descriptions using EM. I did a little research and discovered how to get the descriptions out of the sysobjects table.

Using the Code

The project can be built and run with just a little setup. To install the project, unzip it to a directory of your choosing, for instance c:\projects\dbadoc. Create a virtual directory in IIS and set the path to c:\projects\dbadoc\client.

Open Visual Studio and build the project. If you are using VS 2005, the project should convert with no problems. That's it!

Points of Interest

  • Don't ask me why I used VB for the code-behind and C# for the data classes. No, really, don't ask.
  • I don't know the configuration steps or failure characteristics when Crystal Reports is not installed and configured with Visual Studio. If you go through this setup, kindly email me and I'll update with those directions.


This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


About the Author


United States United States
No Biography provided

Comments and Discussions

GeneralError Loading in VS2005 PinmemberMarcEleazar30-Apr-08 16:43 
GeneralErrors while loading on VS 2005 PinmemberMarcEleazar21-Apr-08 21:29 
GeneraldbaDoc - Error in loading the Solution PinmemberMarcEleazar5-Mar-08 18:41 
GeneralRe: dbaDoc - Error in loading the Solution Pinmembergogglin7-Mar-08 21:25 
QuestionGreat Concept, But Nothing Shows? PinmemberMember 199949326-Feb-08 6:11 
GeneralRe: Great Concept, But Nothing Shows? Pinmembergogglin7-Mar-08 21:22 
GeneralRunning into errors on compile Pinmembere4thenf423-Jun-07 12:28 
GeneralRe: Running into errors on compile Pinmembergogglin28-Jun-07 5:10 
GeneralReporting Services PinmemberRogerMCT23-Aug-06 6:13 
AnswerRe: Reporting Services Pinmembergogglin23-Aug-06 12:51 
GeneralNeat! Pinmemberamarie22-Aug-06 5:53 
GeneralRe: Neat! Pinmembergogglin23-Aug-06 12:42 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.150129.1 | Last Updated 17 Aug 2006
Article Copyright 2006 by gogglin
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid