Generating Data Dictionary or Database Design Document using MS Word Macros

• Download Code - 2.98 KB

Introduction

Manually preparing data dictionary document will take ages in MS Word which contains 100's of tables, stored procedures, functions, triggers, views, indexes, etc. in the 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 nicely formatted. For this I did lot of research in Google to find the solution and finally I have 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 with in seconds.

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

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

Basically, this code will prepare you the following information in the document

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 then 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 the references of Microsoft Active X Data Objects Library from the menu Tools->References

6. Run the macro by pressing F5 from VBA editor.

Points of Interest

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

History

Keep a running update of any changes or improvements you've made here.

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