Click here to Skip to main content
13,351,050 members (54,230 online)
Click here to Skip to main content
Add your own
alternative version


40 bookmarked
Posted 22 Apr 2009

SQLDoc Sharp

, 23 Apr 2009
Rate this:
Please Sign up or sign in to vote.
SQLDoc Sharp, an interactive tool designed to generate the SQL Server 2005/2008 documentation.


SQLDoc Sharp is an interactive tool designed to generate the SQL Server 2005/2008 documentation.

It allows you to export documentation to CHM format (Microsoft Compiled HTML Help).
It is also easy and interactive, which allows multiple database documentation.
For more details, please refer to


Finding the answer to, "Is there any free tool for generating documentation from SQL 2005/2008".

Using the Code

After running the application, the initial UI looks like below:


Three steps required to generate the documentation.

Step # 1

In the top section, provide the details about the SQL Server. It includes:

  1. Source: Instance Name of the SQL Server 2005/2008 
  2. If want to connect with SQL authentication then:
    1. User Name: Name of the user whose credentials you want to use
    2. Password: Password of the user whose credentials you want to use
  3. In case, to connect with Windows authentication then, only check the checkbox   (Integrated Security) and your current Windows credentials would be used to connect with the specified SQL Server Instance.

Step # 2

Choose the database name from the Database dropdown list, whose documentation you want to generate and then click on the Fetch button.

Meanwhile you can choose/change the File Name of the CHM file which would be generated. And also if required, you then choose to export the metadata/documentation in the XML format too.

Step # 3

Click on the Generate button. And locate the CHM file at the path specified.

After making the selection the SQLDoc Sharp, the UI should look like:

SQLDocSharp Step 2.png

Screen Shots of the Documentation Generated



Instance Information

Instance Information.png

Date Source Information

DataSource Information.png

Data Types

List of DataTypes.png


List of Users.png



Table Details

table details.png









User Defined Data Types


Points of Interest

At the time of writing the application, I got the opportunity to explore the SQL Server Metadata functions, stored procedures, etc. I also explored ADO.NET GetSchema, MetaCollections, etc. 


This article, along with any associated source code and files, is licensed under The Common Public License Version 1.0 (CPL)


About the Author

Amit Chaudhary
India India
An engineer with approx. 8 years of excellent experience in middle tier applications, analysis, design, development, testing, and maintenance of various client server/web based applications. Has the ability to handle multiple task(s), work independently as well as in team. Motivated, energetic with demonstrated proficiency for learning new technologies and business environments to provide effective and efficient IT solution(s) that envisage a futuristic approach with distributed and object oriented technologies.

You may also be interested in...

Comments and Discussions

QuestionNice project! Question about sorting Pin
Yves Rausch20-Jun-12 6:24
memberYves Rausch20-Jun-12 6:24 
AnswerRe: Nice project! Question about sorting Pin
Yves Rausch20-Jun-12 22:27
memberYves Rausch20-Jun-12 22:27 
QuestionPre compiled version Pin
Member 885235719-Apr-12 8:12
memberMember 885235719-Apr-12 8:12 
QuestionWon't compile under VS2010 Pin
soulfiremage13-Mar-12 2:17
membersoulfiremage13-Mar-12 2:17 
AnswerRe: Won't compile under VS2010 Pin
bwtraz20-Mar-12 9:19
memberbwtraz20-Mar-12 9:19 
GeneralIt works Pin
99sayegh6-Mar-11 18:08
member99sayegh6-Mar-11 18:08 
GeneralCheck/Uncheck/Toggle buttons and Check boxes Pin
ScotDance12-Jan-10 5:02
memberScotDance12-Jan-10 5:02 
GeneralTested against Northwind (small db) Just hangs the machine, also have to set chm path to same as exe [modified] Pin
john blox29-Sep-09 4:01
memberjohn blox29-Sep-09 4:01 
It's a shame when devs spent a lot of time writing something that could be really useful but don't bother spending that last 5 minutes making it actually work properly.

OK if you type in just the filenames for chm/xml (but don't use browse button) it will default to create in the .exe folder and will work (though will show path as c:\northwind.chm even though it isn't), sloppy!

Update: No it crashes all the time, it doesn't matter what tables etc you select it just adds them all in anyway, description field is ignored for table fields, doesn't remember any of your settings so you need to re-enter them every time you run - yawn! totally unusable to be honest, shame as all it needed was a few hours testing by the dev instead its months of time down the drain as no one will use this - ho hum!

modified on Tuesday, September 29, 2009 9:22 AM

GeneralRe: Tested against Northwind (small db) Just hangs the machine, also have to set chm path to same as exe Pin
Hanant11-Oct-09 9:18
memberHanant11-Oct-09 9:18 
GeneralExcel, Pdf or XML Pin
Amit Chaudhary6-Aug-09 20:34
memberAmit Chaudhary6-Aug-09 20:34 
GeneralAgain it hangs Pin
sore_ron15-May-09 4:51
membersore_ron15-May-09 4:51 
AnswerRe: Again it hangs Pin
Amit Chaudhary17-May-09 21:01
memberAmit Chaudhary17-May-09 21:01 
QuestionUnable to read CHM page with non-English object name Pin
doggy_epaper.tw10-May-09 9:19
memberdoggy_epaper.tw10-May-09 9:19 
GeneralMy vote of 1 Pin
pita200922-Apr-09 8:14
memberpita200922-Apr-09 8:14 
AnswerRe: My vote of 1 Pin
Amit Chaudhary25-Apr-09 8:40
memberAmit Chaudhary25-Apr-09 8:40 
GeneralSQL Doc sharp Pin
wkww200422-Apr-09 5:08
memberwkww200422-Apr-09 5:08 
AnswerRe: SQL Doc sharp Pin
Amit Chaudhary25-Apr-09 8:41
memberAmit Chaudhary25-Apr-09 8:41 
Questionit didn't work Pin
mahmola22-Apr-09 4:42
membermahmola22-Apr-09 4:42 
AnswerRe: it didn't work Pin
smesser22-Apr-09 10:39
membersmesser22-Apr-09 10:39 
AnswerRe: it didn't work Pin
Amit Chaudhary25-Apr-09 8:41
memberAmit Chaudhary25-Apr-09 8:41 
GeneralRe: it didn't work Pin
smesser25-Apr-09 13:00
membersmesser25-Apr-09 13:00 
Questiongood but ... Pin
Member 461770122-Apr-09 4:16
memberMember 461770122-Apr-09 4:16 
AnswerRe: good but ... Pin
Amit Chaudhary25-Apr-09 8:42
memberAmit Chaudhary25-Apr-09 8:42 
GeneralGood, but ... Pin
Peni22-Apr-09 3:26
memberPeni22-Apr-09 3:26 
AnswerRe: Good, but ... Pin
Amit Chaudhary22-Apr-09 3:27
memberAmit Chaudhary22-Apr-09 3:27 

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

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

Permalink | Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.180111.1 | Last Updated 24 Apr 2009
Article Copyright 2009 by Amit Chaudhary
Everything else Copyright © CodeProject, 1999-2018
Layout: fixed | fluid