These are reports for MS SQL Management Studio and MS SQL Reporting Services for creation of database documentation with the use of descriptions from Extended Properties
Reports contain the detailed information on tables, views and stored procedures etc. Use of reports engine allows exporting generated reports into Excel, Word, PDF etc. formats easily.Versions supported:
SQL Server Management Studio 2005/2008 and SQL Server Reporting Services 2005/2008Use these reports if you want to:
The following features are available in this version (DbDocReports, version 0.9 Beta):
- Quick view/print information about database’s objects in Management Studio or Reporting Services.
- Create database documentation for your project in Word/Excel/PDF-format using export from these reports.
- Use reports in Reporting Services as a web site where database structure should always be up-to-date.
Sample reportsAdditional: Procedures for simplification of documenting of database objects.
- Database Objects Report - common information about database objects (their amount and detailed list). By selecting one of the objects you will see corresponding detailed report.
- Table Details Report - detail table information:
- Table Description.
- Columns’ names, types, length, nullable attribute.
- Constraints description.
- Index description.
- Tables which are referenced by foreign key.
- View Details Report - detail view information:
- View Description.
- Columns’ names, type, length.
- Definition of a view
- Stored Procedure Details Report - detailed stored procedure’s information:
- Stored procedure description.
- Parameters’ name, type, length.
- Definition of a stored procedure.
For convenient manipulation of "MS Description" property for database objects documentation from TSQL you can user procedures from SQL script sp_addDescXXX_install.sql
Current release contains sp-procedures for the following objects:
- Table (columns, constraints, indexes);
- Views (columns) ;
- Functions (parameters) ;
- Procedures (parameters) ;
These procedures add declaration to your objects or update if they already exist. It was done to simplify the usage of complex constructions like sp
I.e. instead of sp
XXXextendedproperty_ you can use: