Comment on a stored procedure

As a best practice, add some descriptive comments on stored procedures by using the COMMENT ON command capability.

For example:

COMMENT ON PROCEDURE customer() IS 'A procedure that displays a 
customer name.';
COMMENT

A Netezza Performance Server SQL query user can display these comments by using the nzsql \dd <name> command switch, or the \dd switch shows all comments for all procedures. Consider using a comment template that includes information about the author, version, and description in the following format:

COMMENT ON PROCEDURE <procedure name> (<argument type list>) IS
'Author: <name>
Version: <version>
Description: <description>';

For example:

COMMENT ON PROCEDURE customer() IS 'Author: bsmith 
Version: 1.0 Description: A procedure that writes a customer name to 
the database log file.';

To comment on a stored procedure, you must either be the Netezza Performance Server admin user, the owner of the procedure, or you must have Alter permissions for procedure objects. For more information about COMMENT ON, see the IBM® Netezza® Database User’s Guide.

Make sure that you specify a full procedure name and argument list, including correct sizes for numeric and string data types. Otherwise, you receive an error similar to the following example:

Error: CommentProcedure: existing procedure name(argument type list) 
differs in size of string/numeric arguments