SQL Server Team-based Development - Red Gate Software

57
Chapter 2: Documenting your Database
ALTER PROCEDURE ExtractDocumentation
/**
summary: >
Gets the source of every routine in the database and extracts the header
files from them, and then parses the YAML file to extract a relational table
with all the information.
Revisions:
– version : 1
Modification: Created the procedure
Author : Phil Factor
Date : 01/10/2010
example:
– code: >
returns: >
The documentation table
*/
AS
DECLARE @documentation TABLE
(
[object_type] VARCHAR(32) ,
[schema] SYSNAME ,
[object_name] SYSNAME ,
[sequence_ID] INT ,
[path] VARCHAR(255) ,
[attribute] VARCHAR(255) ,
[sequence] VARCHAR(255) ,
[value] VARCHAR(MAX)
)--the table to take the documentation items
DECLARE @allObjects TABLE
(
TheID INT IDENTITY(1, 1) ,
[object_type] VARCHAR(32) ,
[schema] SYSNAME ,
[object_name] SYSNAME ,
[definition] VARCHAR(MAX)
)- – the table containing all the objects
DECLARE @Definition VARCHAR(MAX) ,
@Header VARCHAR(MAX) ,--what is in the header information
@Object_name SYSNAME ,--the object name
@schema SYSNAME ,--the schema
@Object_type VARCHAR(32) ,--the type of object
@ii INT ,--iteration counter
@iiMax INT – -max value of iteration counter
INSERT INTO @AllObjects