Removing Object Set for Spool File Data

This stored procedure will remove an object set for spool file data from a text search collection.

RMV_SPLF_OBJECT_SET

Authorization

This stored procedure is created with public authority *EXCLUDE and is owned by the creator of the text search collection.

The procedure will adopt the authority of the text search collection owner's profile. Authority can be granted to other users to allow them to execute the procedure.

Syntax

Remove a Spool File Object Set:

The following simplified versions of the remove spool file object set procedure may be used for convenience.

Select spool files by output queue only:

Select spool files by output queue, and user name only:

The schema qualifier is the name of the text search collection.

Parameters

output_queue_lib

A system name for the output queue library.

The data type for this parameter is VARCHAR(10)

output_queue_name

A system name for the output queue name.

The data type for this parameter is VARCHAR(10)

user_name

A system name for the user that owns the spool file.

The data type for this parameter is VARCHAR(10)

qual_job_name

Name of the job that created the spool file.

The data type for this parameter is VARCHAR(10)

qual_job_user

System name for the user profile name of the job associated with the spool file.

The data type for this parameter is VARCHAR(10)

A non-null, non-empty value for this parameter is required if QUALIFIED_JOB_NAME is specified.

If QUALIFIED_JOB_NAME is empty string or NULL, this parameter must also be NULL or empty string.

qual_job_number

A six character string representing the job number. (Must be digits 0-9)

The data type for this parameter is VARCHAR(6)

A non-null, non-empty value for this parameter is required if QUALIFIED_JOB_NAME is specified.

If QUALIFIED_JOB_NAME is empty string or NULL, this parameter must also be NULL or empty string.

user_data

A ten character string that the user associates with a spool file.

This string is not converted to uppercase, and must exactly match the user data associated with a spool file in order to be considered a match.

Note: A value of 'abc' is different than 'ABC'

The data type for this parameter is VARCHAR(10)

begin_timestamp

This timestamp value indicating the earliest creation time of the spool files added in the object set.

The data type for this parameter is TIMESTAMP

end_timestamp

This timestamp value indicating the latest creation time of the spool files added in the object set.

The data type for this parameter is TIMESTAMP

Note: For more detail meaning and restrictions of above parameters Please refer store procedure add_splf_object_set description.

Result Note

In following case remove will be failed due to object set not found:

>User inputs incorrect parameters

>Specifies parameters corresponding object set has been deleted previously User will get error message show that the object set doesn’t exist with the specific attribute.

QUERY_OBJECT_SET() returns the object set list and the input parameters. User can specify correct input parameters while invoking this stored procedure to remove the object set.

Examples

Remove an object set in collection nick789 for all spool files in output queue NTL/MYOUTQ.

> call nick789.rmv_splf_object_set('NTL', 'MYOUTQ');

Remove an object set in collection nick123 for all spool files owned by user NTL.

> call nick123.rmv_splf_object_set('', '', 'NTL');

Remove an object set in collection test_col for all spool files created in 2010

> call test_col.rmv_splf_object_set('', '', '', '', '', '', '', '2010-01-01T00:00:00', '2011-01-01T00:00:00');

Add an object set to collection default_search_col to index all spool files created in 2010 with user data 'MYAPP':

> call default_search_col.add_splf_object_set('', '', '', '', '', '', 'MYAPP', '2010-01-01T00:00:00', '2011-01-01T00:00:00');