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

Generating Data Dictionary or Database Design Document using MS Word Macros

By , 31 Mar 2008
Rate this:
Please Sign up or sign in to vote.

Introduction

Manually preparing a data dictionary document will take ages in MS Word which contains 100's of tables, stored procedures, functions, triggers, views, indexes, etc. in a SQL Server database as you need to type each and every column of the table along with the associated dependencies. I need a data dictionary document which generates the database schema automatically in one click with nice formatting. For this I did a lot of research in Google to find the solution and finally I wrote my own code to do this functionality and I thought to share my experience with you all.

The main purpose of this article is to generate the data dictionary document automatically by simply running the macro code in MS Word within seconds.

I am not a VBA guru but I still started doing some kind of researching on VBA code in Google and I got ideas from different forums, many thanks to those people who posted their ideas.

I hope this solution will help you to prepare a data dictionary document. Here we start...

Basically, this code will prepare for you the following information in the document. The table name with the following dependent information:

  • Table Column Details
  • Indexes
  • Views
  • Stored Procedures
  • Functions
  • Triggers
  • Primary Keys
  • Foreign Keys
  • Default Constraints
  • Identity Columns

Using the code

Following are the steps to run this code:

  1. Simply open a blank Word document (it is mandatory).
  2. Go to menu Tools->Macro->Macros->Create, this will create a new Visual Basic module editor.
  3. Paste this code.
  4. Change the connection string as per your SQL Server credentials (it is mandatory).
  5. Add references to Microsoft ActiveX Data Objects Library from the menu Tools->References.
  6. Run the macro by pressing F5 from the VBA editor.

data_dictionary/document_template.jpg

Points of Interest

This code will generate the data dictionary document automatically with one click and it is simple to use this code.

License

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

About the Author

Shashidhar Rao Nellutla
Software Developer (Senior)
United Kingdom United Kingdom
Completed Masters in Computer Applications.

Comments and Discussions

 
QuestionNeed this for a oracle database PinmemberMember 1048363723-Dec-13 3:02 
Questionvery nice tool Pinmemberharsh.programmer22-Feb-12 0:35 
Questionfor non VB developers PinmemberMember 852727129-Dec-11 19:07 
GeneralThanks Pinmembersreelekhamenon8-Dec-10 14:07 
Generalthanks Pinmembervelpetit9-Dec-09 18:06 
thanks for this wonderful post.....It helped me a lot
and saved me junks of time
Generalole db PinmemberSvetlana Tipping18-Feb-09 22:38 
GeneralWord 2007 PinmemberMember 217100917-Jun-08 8:09 
GeneralMacro not working Pinmemberniranjan singh14-Apr-08 3:15 
GeneralRe: Macro not working Pinmembergrom_boy14-Apr-08 23:36 
GeneralRe: Macro not working [modified] PinmemberAndrewGail24-Apr-08 5:12 

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 | Mobile
Web03 | 2.8.140415.2 | Last Updated 31 Mar 2008
Article Copyright 2008 by Shashidhar Rao Nellutla
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid