SQL Clone
SQLServerCentral is supported by Redgate
 
Log in  ::  Register  ::  Not logged in
 
 
 


Auto Generate Your Database Documentation


Auto Generate Your Database Documentation

Author
Message
Andy Jones, DBA
Andy Jones, DBA
SSCommitted
SSCommitted (2K reputation)SSCommitted (2K reputation)SSCommitted (2K reputation)SSCommitted (2K reputation)SSCommitted (2K reputation)SSCommitted (2K reputation)SSCommitted (2K reputation)SSCommitted (2K reputation)

Group: General Forum Members
Points: 1993 Visits: 574
Comments posted to this topic are about the item Auto Generate Your Database Documentation

.
roger.plowman
roger.plowman
Hall of Fame
Hall of Fame (3.9K reputation)Hall of Fame (3.9K reputation)Hall of Fame (3.9K reputation)Hall of Fame (3.9K reputation)Hall of Fame (3.9K reputation)Hall of Fame (3.9K reputation)Hall of Fame (3.9K reputation)Hall of Fame (3.9K reputation)

Group: General Forum Members
Points: 3928 Visits: 1500
Extended properties are essential for good documentation, yes, but if you're adding them to the database itself (after the fact) you have a world of hurt just waiting for you.

Why in the world wouldn't you add this information to the database modelling tool used to design the database and create the build script for it?

That way the extended properties are A) properly maintained in a central "golden authority" and B) ALWAYS placed in the database as part of the creation script/alter scripts.

Much safer, much more consistent, and never subject to "accidents" from hasty editing decisions.
robert.sterbal 56890
robert.sterbal 56890
SSCarpal Tunnel
SSCarpal Tunnel (4.5K reputation)SSCarpal Tunnel (4.5K reputation)SSCarpal Tunnel (4.5K reputation)SSCarpal Tunnel (4.5K reputation)SSCarpal Tunnel (4.5K reputation)SSCarpal Tunnel (4.5K reputation)SSCarpal Tunnel (4.5K reputation)SSCarpal Tunnel (4.5K reputation)

Group: General Forum Members
Points: 4453 Visits: 1326
The single most helpful tool I don't see regularly used is a table count and date on all the tables, followed by a periodic grab of the data.

Obviously a trace is going to tell you a lot of about what is going on, but the volume of the data is much more extensive.
facemann
facemann
SSC Veteran
SSC Veteran (272 reputation)SSC Veteran (272 reputation)SSC Veteran (272 reputation)SSC Veteran (272 reputation)SSC Veteran (272 reputation)SSC Veteran (272 reputation)SSC Veteran (272 reputation)SSC Veteran (272 reputation)

Group: General Forum Members
Points: 272 Visits: 289
This makes documentation as easy as it can be and stores it in a logical place that anyone can find.

Thanks!
Tim Toennies
Tim Toennies
SSC-Enthusiastic
SSC-Enthusiastic (129 reputation)SSC-Enthusiastic (129 reputation)SSC-Enthusiastic (129 reputation)SSC-Enthusiastic (129 reputation)SSC-Enthusiastic (129 reputation)SSC-Enthusiastic (129 reputation)SSC-Enthusiastic (129 reputation)SSC-Enthusiastic (129 reputation)

Group: General Forum Members
Points: 129 Visits: 643
This is very useful information, thanks for posting this. One item that I have always struggled with documenting is the owner of logins, not users. But extended properties can't be created on logins. Do you have any suggestion for an elegant way to address this?

Thanks



GPO
GPO
SSCrazy
SSCrazy (2.4K reputation)SSCrazy (2.4K reputation)SSCrazy (2.4K reputation)SSCrazy (2.4K reputation)SSCrazy (2.4K reputation)SSCrazy (2.4K reputation)SSCrazy (2.4K reputation)SSCrazy (2.4K reputation)

Group: General Forum Members
Points: 2438 Visits: 1954
Why in the world wouldn't you add this information to the database modelling tool used to design the database and create the build script for it?


Obviously that's the ideal situation, but when it doesn't happen, and you inherit the laziness of others, you have to start somewhere. Andy's suggestion is excellent but even it won't solve the problem of those who take shortcuts and leave others with a mess. That is an organisational culture problem, not a technical problem.

There's a special place in hell for people who take credit/bonuses/promotions for passing off undocumented software as if it were a finished product. There is possibly no lower form of programmer.Exclamation Mark

:-)

One of the symptoms of an approaching nervous breakdown is the belief that one's work is terribly important.
Bertrand Russell

Ricky Lively
Ricky Lively
SSC Journeyman
SSC Journeyman (97 reputation)SSC Journeyman (97 reputation)SSC Journeyman (97 reputation)SSC Journeyman (97 reputation)SSC Journeyman (97 reputation)SSC Journeyman (97 reputation)SSC Journeyman (97 reputation)SSC Journeyman (97 reputation)

Group: General Forum Members
Points: 97 Visits: 1851
Last I heard, Azure does not support extended properties. So this may only be an on-premises solution.
robert_verell
robert_verell
SSC-Addicted
SSC-Addicted (411 reputation)SSC-Addicted (411 reputation)SSC-Addicted (411 reputation)SSC-Addicted (411 reputation)SSC-Addicted (411 reputation)SSC-Addicted (411 reputation)SSC-Addicted (411 reputation)SSC-Addicted (411 reputation)

Group: General Forum Members
Points: 411 Visits: 368
thanks for listening Andy! Appreciate the reference as well. great article!
Iwas Bornready
Iwas Bornready
SSC-Dedicated
SSC-Dedicated (34K reputation)SSC-Dedicated (34K reputation)SSC-Dedicated (34K reputation)SSC-Dedicated (34K reputation)SSC-Dedicated (34K reputation)SSC-Dedicated (34K reputation)SSC-Dedicated (34K reputation)SSC-Dedicated (34K reputation)

Group: General Forum Members
Points: 34942 Visits: 886
Thanks for the good article.
MMartin1
MMartin1
SSChampion
SSChampion (13K reputation)SSChampion (13K reputation)SSChampion (13K reputation)SSChampion (13K reputation)SSChampion (13K reputation)SSChampion (13K reputation)SSChampion (13K reputation)SSChampion (13K reputation)

Group: General Forum Members
Points: 13663 Visits: 2065
Thanks for the article. Very creative approach to make use of this hidden and under utilised tool. Documentation is among the last thing people think of when creating their objects and columns, if at all. Any documentation that may exist I find is lost in heaps of folders on some remote share. Here, the information is at the forefront.

----------------------------------------------------
How to post forum questions to get the best help
Go


Permissions

You can't post new topics.
You can't post topic replies.
You can't post new polls.
You can't post replies to polls.
You can't edit your own topics.
You can't delete your own topics.
You can't edit other topics.
You can't delete other topics.
You can't edit your own posts.
You can't edit other posts.
You can't delete your own posts.
You can't delete other posts.
You can't post events.
You can't edit your own events.
You can't edit other events.
You can't delete your own events.
You can't delete other events.
You can't send private messages.
You can't send emails.
You can read topics.
You can't vote in polls.
You can't upload attachments.
You can download attachments.
You can't post HTML code.
You can't edit HTML code.
You can't post IFCode.
You can't post JavaScript.
You can post emoticons.
You can't post or upload images.

Select a forum







































































































































































SQLServerCentral


Search