Project DescriptionAutomatic version control, database documentation and comparison tool for SQL Server. Also supports limited reporting of database size, connection counts and blocking.
About SQLAutoDoc
A basic install, screen snapshots of the SQLAutoDoc reports and documentation can be found here:
http://www.jlion.com/docs/SQLAutoDoc_v2.aspxSQLAutoDoc consists of these parts:
- A SQL Server (or SQL Server Express) database that contains metadata about the databases that are being monitored by SQLAutoDoc.
- A web-based reporting interface.
- A windows service that periodically polls monitored SQL Servers for new versions of stored procedures, functions and views, and retrieves updated statistics about connections, blocking, etc.
- An assembly that serves as the interface between the database and both the reporting app and the windows service.
Because setting up all this stuff can be somewhat involved, I have also created a windows setup application.
Why SQLAutoDoc
There are lots of good SQL documentation tools out there. The primary purpose of SQLAutoDoc is as a sort of parachute for small SQL shops that don't keep database code in version control.
SQLAutoDoc can help in these scenarios:
- A report stops working or returns strange results. Any changes to the database made recently?
- A change to a stored procedure appears to work correctly, but two weeks later critical problems are found. What was the source of the prior version?
- You return from vacation. Boss says "I had to fix some things while you were gone". What did the Boss change?
- Database size is growing quickly. Which table(s) are responsible?
History
The original idea for SQLAutoDoc originally arose back in about 1992 as a way to document Microsoft Access database schemas. It then, evolved into a way to compare the schema of two Access databases, then into a way to record and document SQL Server schemas, was updated to identify changes to stored procedures, views and functions, and finally to its present form, as a web interface/windows service combination with simple charting and reporting functionality.
I envision future versions of SQLAutoDoc having better reporting capabilities, particularly relating to the indentification and tracking of blocking issues. I would also like to improve the performance of searches and comparisons.
CreditsI'd like to thank Mark James of
http://famfamfam.com for making his excellent collection of icons available.