question

zillabaug avatar image
zillabaug asked

what is the best practice on cataloging report queries for reuse?

I have been tasked to catalog all SQL scripts, routines and queries used to generate report for management within our organization. Is there a best practice out there to mimic or does anyone have suggestions or recommendation on how to accomplish the task at hand?
sqlarchivingdocumentation
10 |1200
Toggle Comment visibility. Current Visibility: Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

1 Answer

·
Grant Fritchey avatar image
Grant Fritchey answered
I would strongly suggest getting much better definitions of exactly what it is that they're looking for. Simply a catalogue of scripts is unlikely to tell anyone anything. You can easily generate this using a query against the objects list in your databases. For a detailed documentation of objects within SQL Server, I'd suggest looking [at this tool][1] from Red Gate. It'll help you lay things out, but it may still not be what you're looking for. Disclaimer: I work for Redgate. [1]: http://www.red-gate.com/products/sql-development/sql-doc/
1 comment
10 |1200
Toggle Comment visibility. Current Visibility: Viewable by all users

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.

Kev Riley avatar image Kev Riley ♦♦ commented ·
`+1` And I'd add that the minute you document any code, it's out of date. It's hard to keep a tight sync between actual code and a document that describes it. Automating the documentation using tools that Grant suggests will help - but you need a clear idea as to what this is for!
2 Likes 2 ·

Write an Answer

Hint: Notify or tag a user in this post by typing @username.

Up to 2 attachments (including images) can be used with a maximum of 512.0 KiB each and 1.0 MiB total.