Click here to Skip to main content
15,881,424 members
Articles / Database Development / SQL Server

Document SQL Server 2000/2005 Database

Rate me:
Please Sign up or sign in to vote.
4.83/5 (103 votes)
17 Oct 2009CPOL1 min read 241.4K   27.2K   113   81
T-SQL script to generate the document of SQL 2000/2005 database

Introduction

Here is the script to generate the HTML document of your SQL Server 2000/2005 database. It is reverse engineering after the database is created. I hope it will be useful to many of you.

Background

While working as a part time DBA for some projects, I encountered difficulties in documenting and publishing my databases because I do not have any tool available to generate the document. I have written this script that gives the output in HTML that is easy to be modified/published/distributed.

Using the Code

Follow these steps to use this script:

  • Download the attached script file and open it in Management Studio (tested on version 9.00).
  • Select the database for which you want to generate document.
  • Select Result to File (Ctrl+Shift+F) from Query - Results To menu.
  • Execute (F5) the script.
  • In the Save Result dialogue box, type a file name (filename.htm/filename.html) in the File Name text box and select All Files (*.*) in Save As Type dropdown.
  • After successful execution of query, check the output file.

Note: For populating the description of table and columns, update the Description property of table and columns while creating database diagram or add extended property for them with name as MS_Description.

I hope this information will be helpful. I am planning to provide details of code in my next update.

Updates

  • Bug in getting index column is resolved
  • Bug in getting check constraints list is resolved
  • Definition of check constraints is added to document
  • Table Summary is changed to Table Description
  • Table and column description is populated from extended property

Download documentation application from here.

License

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


Written By
Database Developer
United Kingdom United Kingdom
With 10 years of experience of working on Microsoft platform, currently I am working as Database/BI expert.

Comments and Discussions

 
GeneralVersion en Español con Procedimientos Almacenados para SQL Srv 2005 Pin
Ronald Fallas Rojas17-Dec-09 9:49
Ronald Fallas Rojas17-Dec-09 9:49 
GeneralRe: Version en Español con Procedimientos Almacenados para SQL Srv 2005 Pin
Ronald Fallas Rojas17-Dec-09 10:32
Ronald Fallas Rojas17-Dec-09 10:32 
QuestionAdd code for table-valued and scalar functions, and stored procedures? Pin
TechVsLife21-Nov-09 17:06
TechVsLife21-Nov-09 17:06 
GeneralVery useful Pin
BrianCharles20-Oct-09 8:45
BrianCharles20-Oct-09 8:45 
Generalbug report - column length doubled when using nvarchar/nchar Pin
tsohr15-Sep-09 16:06
tsohr15-Sep-09 16:06 
GeneralExcellent!! Pin
sksisme23-Jul-09 11:33
sksisme23-Jul-09 11:33 
GeneralExcellent job (stored procedure lister added) Pin
gareth ashby23-Jun-09 23:02
gareth ashby23-Jun-09 23:02 
GeneralNice job! Pin
DaveNoderer8-Jun-09 20:43
professionalDaveNoderer8-Jun-09 20:43 
GeneralThanks a lot - worked on SQL 2008 as well Pin
emadm30-Apr-09 10:49
emadm30-Apr-09 10:49 
GeneralIs there any tool/utility which can generate the documentation from SQL Server 2005/2008 Pin
Amit Chaudhary17-Apr-09 4:35
Amit Chaudhary17-Apr-09 4:35 
GeneralGreat Work - Declare @Output nvarchar(4000) Pin
egphsharaf12-Apr-09 6:03
egphsharaf12-Apr-09 6:03 
GeneralRestore Sql 2005 database backup file in Sql server 2000 Pin
Parag Raibagkar30-Mar-09 0:13
Parag Raibagkar30-Mar-09 0:13 
QuestionWhat a time saver! Pin
Dusty_e13-Mar-09 7:19
Dusty_e13-Mar-09 7:19 
GeneralThanks a lot Pin
Member 476895525-Dec-08 10:02
Member 476895525-Dec-08 10:02 
GeneralGreat Work Pin
Mark Harby30-Nov-08 12:05
Mark Harby30-Nov-08 12:05 
GeneralThanks! Pin
Shiscle14-Oct-08 22:40
Shiscle14-Oct-08 22:40 
GeneralAppreciate Pin
adnawri28-Aug-08 18:11
adnawri28-Aug-08 18:11 
RantThanks Pin
SmartSrc24-Aug-08 23:26
SmartSrc24-Aug-08 23:26 
GeneralThanks! Pin
dr11020-Jul-08 11:29
dr11020-Jul-08 11:29 
GeneralExcellent script. Pin
Unserernst20-Jun-08 7:00
Unserernst20-Jun-08 7:00 
GeneralThanks.. Pin
james_davis_1210-Jun-08 10:07
james_davis_1210-Jun-08 10:07 
GeneralThank you, Pin
silverpilen2-May-08 4:37
silverpilen2-May-08 4:37 
Generalwow.. Pin
Okta Endy23-Apr-08 22:53
Okta Endy23-Apr-08 22:53 
GeneralExcelent!!! Pin
Member 24919606-Apr-08 7:23
Member 24919606-Apr-08 7:23 
GeneralThanks Pin
b minor6-Mar-08 3:40
b minor6-Mar-08 3:40 

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.