Database schemas are very difficult to document well. There are no mechanisms for storing large amounts of descriptive information, and retrieving schema information can be tedious. When changes are made, updating the documentation can be a daunting task. Dbdesc to the rescue!

Upon starting dbdesc, you are prompted for connection parameters. Provide the usual information--server name or IP, user credentials (SQL Server security or Windows authentication) and database name. You are one-third of the way there.

Figure 1

 

On the Objects tab, select the objects you want to include in your documentation.

Figure 2

 

Expanding Tables allows you to select primary and foreign keys, indices, triggers and check constraints to be included in your documentation. You can choose specific tables by using the Advanced button (see Bonus Feature section below).

Figure 3

 

The Output tab lets you select the report format and output file names.

Figure 4

 

The name of the supplied XSL template is added to the XML file, so the documentation can be opened in a readable format and transformed by either a standard XSL or a custom one you make.

Figure 5

 

Click on the Generate button and in a few brief moments your database will be fully documented, in the format you selected. Documentation is very complete--the Northwind sample database generates a 45 page PDF.