DB2 Version 10.1 for Linux, UNIX, and Windows

ADMIN_REMOVE_MSGS procedure - Clean up messages generated by a data movement utility that is executed through the ADMIN_CMD procedure

The ADMIN_REMOVE_MSGS procedure is used to clean up messages generated by a single execution of a data movement utility command through the ADMIN_CMD procedure. The input parameter operation_id identifies the operation.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-ADMIN_REMOVE_MSGS--(--operation_id--)-----------------------><

The schema is SYSPROC.

Procedure parameter

operation_id
An input argument of type VARCHAR(139) that specifies the operation ID of the message file(s) produced by a data movement utility that was executed through the ADMIN_CMD procedure. The operation ID is generated by the ADMIN_CMD procedure.

Authorization

EXECUTE privilege on the ADMIN_REMOVE_MSGS procedure. The fenced user ID must be able to delete files under the directory indicated by registry variable DB2_UTIL_MSGPATH. If the registry variable is not set, then the fenced user ID must be able to delete the files in the tmp subdirectory of the instance directory.

Default PUBLIC privilege

In a non-restrictive database, EXECUTE privilege is granted to PUBLIC when the procedure is automatically created.

Example

Clean up messages with operation ID '24523_THERESAX'.
CALL SYSPROC.ADMIN_REMOVE_MSGS('24523_THERESAX')

Usage notes

The CALL statement that invokes this procedure with the appropriate operation_id can be found in the MSG_REMOVAL column of the first result set returned by ADMIN_CMD procedure.