SQLHelp - Features

The SQLHelp system contains a large number of features to assist development staff in producing production quality SQL documentation. Providing the current development practice entails placing all SQL into stored procedures, SQLHelp can produce documentation of queries running on a database.

Documentation items include the ability to:

Improved handling of result set column aliases built with delimited identifiers
Procedures executing other procedures are highlighted
Globally override the SQL parser allowing for all documentation to be generated prior to a single SQL command being developed.
Define functional groupings for the SQL that is in the project.
Read all parameters of a stored procedure, including the name, data type, direction of data transfer (input vs. output), and default values.
Include the source of the procedure in the compiled help. This allows users to view the SQL without having access to either the database or the source SQL.
Determine if the procedure modifies data in the database.
Determine if the procedure makes use of cursors.
Determine if the procedure makes use of transactions.
Determine if the procedure uses return values, and what those values might be.
Determine if the procedure returns data via one or more result sets, and what the columns present in the result sets might be. Up to 9 result sets can be determined.
Define project specific copyright notices.
Define project specific project file descriptions.
Define stored procedure purpose.
Optionally, provide examples for the use of a given stored procedure.
Override the SQL parser for result sets and return values when those items might be dynamically generated, or be defined by complex queries.
Document SQL without having any connection to the database.