Removing Object Set for Stream File Data

The stored procedure is in the DB2® schema to remove an object set for stream file data.

RMV_IFS_STMF_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

This procedure allows a user to remove an object set of stream files (STMF) in the Integrated File System (IFS).

Remove an object set for stream file data (stream files in IFS):

Read syntax diagramSkip visual syntax diagram>>-RMV_IFS_STMF_OBJECT_SET -(--stmf_expression_string-----------><

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

Parameters

stmf_expression_string
This parameter is an absolute path to a directory which is the object set attribute.

It’s no need to be a valid directory on a file system that is accessible since the path could be deleted by user, but object set still exist. The path name should be absolute and should not contain any regular expressions.

The data type for this parameter is VARCHAR(32000)

Note: Note for the specified directory path name:
  • Path names must not be delimited, characters such as '*', '?', etc do not have any special meaning and should not be escaped.
  • Path names may or may not be case sensitive, depending on the attribute of the file system.

Since RMV_IFS_STMF_OBJECT_SET does not consider equivalent paths to be duplicate object set, user should indicate exactly the same path as ADD_IFS_STMF_OBJECT_SET added when try to remove the specific object set.

In other words the following paths could all represent the same directory, but will be considered as different object sets.

/dir1/DIR2
/dir1//DIR2//
/DIR1/DIR2/  (if file system is case insensitive)
/dir1/DIR2/../DIR2
etc.

RMV_IFS_STMF_OBJECT_SET_WITH_SUBDIR

This stored procedure can remove an object set which include sub directory IFS files. Such object set could be added by procedure

ADD_IFS_STMF_OBJECT_SET_WITH_SUBDIR.

The syntax 、authority requirement and parameters of this stored procedure are similar as RMV_IFS_STMF_OBJECT_SET. If user add an IFS path to both with sub-dir object set and without sub-dir object set, use this procedure will only remove the one object set with sub-dir.

Result Note

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

>User inputs incorrect IFS path

>Specifies IFS path 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 MYCOLLECTION which IFS directory is '/home/ntl/stmf':
> CALL MYCOLLECTION.RMV_IFS_STMF_OBJECT_SET('/home/ntl/stmf');
Remove an object set in MYCOLLECTION which include all stream files and subdirectories in an IFS directory '/home/ntl/stmf':
> CALL MYCOLLECTION.RMV_IFS_STMF_OBJECT_SET_WITH_SUBDIR('/home/ntl/stmf');