Documenting Databases 2

[BobJacksonNCI]

Thanks for assisting!

I used Advanced Search and didn't find any useful threads.

I'd like to see examples and/or blank forms that professionals use to document their databases.

My question arises because an important table was deleted and it occurred to me that it is very shortsighted that we don't have anything useful documenting our databases. As a minimum, there should be lists of tables indicating their purpose. For example, whether they are temporary work tables or primary ones.

Please post here as our firewall doesn't allow attachments in via e-mail.

Thanks!
Bob

 

[SQLSister]

Depends on the database you are using what is available for documenting. Access has a documentor that is handy for getting structure and definitions and code printed out. It has not way to add your own info to it that I know of.

SQL server allows you to create diagrams that show the relationships. It also allows you to script every object in the database. These scripts are just text documents, so if you wanted to go through and write up descritions of what something is for you could. I have a template I use for stored procedures that includes a comments section for what the purpose of the SP is and where it is called. That becomes part of the script. Most other large relational databases also allow scripting.

There are separate tools like Visio and Erwin that people use to document databases.

Of course you could also just create a plain old Word or Excel document that you add to as you create or change new objects.

'Course no documentation will get back the data that was in an important table that was deleted. Best to have a good backup procedure in place.

 

[jrbarnett]

Bob

I myself have written a documenter for Access 2K/XP called MDB Doc that writes basic information out to HTML files, which can be viewed on any PC with a web browser. More info and free download from

http://www.jrbarnett.freeserve.co.uk/

John

 

[BobJacksonNCI]

jrbarnett,

Thanks for your quick reply! I AM interested and will download from home as it would be blocked here.

For clarification to others reading this thread, I'm more interested in plain paper to provide ideas as to what should be included. My environment is Access 2000 front end with SQL 7 back end. The table that was deleted was on the SQL server. (Thank you, SQLSister, for your input. And there was/is a backup copy. Since restores are SO infrequent, it took our Tech department a bit to sort it out.)

The goal is to initiate something straight-forward that doesn't require a lot of maintenance. I.E., as detail grows, the odds of it being current diminish.

Again, thanks to all who participate in this great site!
Bob

 

[ceh4702]

Might try looking at Microsoft Visio.

If you do not like my post feel free to point out your opinion or my errors.