SQLHelp - Benefits

The SQLHelp system offers numerous benefits to developers, database administrators, professional services firms, and those generally interested in documenting the queries running on their database.

SQLHelp is designed to document the stored procedures contained in batch scripts. To minimize the impact on a database, SQLHelp is intended to run offline from the actual database by parsing the batch scripts used to define the stored procedures in the system. If your application requires documenting procedures where no batch script currently exists, please contact Pikauba software.

The use of the SQLHelp documentation tool, and its output offer several benefits including:

The ability to document procedures in raw form. Raw form documentation refers to the parsing of a procedure where no comment tags currently exist. In this mode, developers are given the ability to see what the external interface to the procedure is, but lacks any description of its purpose.
Isolation of non-SQL developers from any requirement to read the SQL of a procedure to determine what the required inputs and expected outputs might be.
The ability to provide rich descriptions of the purpose behind procedures, their parameters, and output.
The ability to provide database administrators with a listing of procedures, that return data, modify data, use cursors or are transactional. With this information, administrators can better evaluate database performance.
The ability to determine if SQL coding conventions are being followed. E.g. if a project must use transactions, but a data modification procedure exists that isn't transactional.
The ability to determine if multiple result sets are being used in a query.
The ability to provide examples of the intended use behind a procedure.
Providing a method to isolate the query development from the critical path for projects. In object oriented design an interface contract is defined between clients and servers. By allowing the database interface to be defined, actual database query development can occur in parallel with other aspects of a project.
No need to have SQL Server running on the same machine as SQLHelp.
No need to have connectivity to a SQL Server machine.