Adding an Object Set for Multiple Members Source Physical File

The stored procedure is in the DB2® schema to remove an object set for multi-member source physical file.

ADD_SRCPF_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 add an object set of multi-member source physical file (MMPF).

Add an object set for multi-member source physical file:

>>-ADD_SRCPF_OBJECT-SET -(---SRCPF_LIB----------->
>-------- SRCPF_NAME ------)-------------------------------------><

>--+------------------+--)-------------------------------------><
   '-,-- OUT_SETID -'   

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

Parameter

SRCPF_LIB
This parameter means an absolute library which contains the source physical files that will be indexed.
This must be a valid library name in the system. Multiple members source physical file object within this library will be indexed. The library name should be absolute and should not contain any regular expressions.
The data type for this parameter is VARCHAR(10)
SRCPF_NAME
This parameter means an absolute source physical file which can have one or more members, all the members in the source physical file will be indexed. The file name should be absolute and should not contain any regular expressions.
Note: If the source physical file is deleted after adding the object set to the text search collection, the subsequent call to the UPDATE stored procedure will detect it, then the search result will not contains the members of that source physical file.
*ALLSRCPF
If *ALLSRCPF was specified as source physical name, it means all the source physical files in SRCPF_LIB will be indexed while updating index.
Note: If user specify *ALLSRCPF as source physical name while adding an object set, it’s also allowed that adding another specific PF under the same library as an object set. This will NOT lead to duplicate error.
The data type for this parameter is VARCHAR(10)
OUT_SETID
Output Integer value that returns the set id for the object set that was added. This value can be used to remove the object set at a later time.
This parameter is optional.
The data type for this parameter is INTEGER.

Additional Restrictions

  • A check will be performed when adding the object set to verify that a duplicate set does not already exist in the text search collection.
  • While adding a source physical file object set to a text search collection, OmniFind verifies that the source physical file exists. If the source physical file does not exist, an error message is returned and the object set is not added.
  • If the file specified is not a source physical file, the procedure call fails with an error.

Authorities to Indexed Objects

When adding a Multiple members source physical file object set, consider the authority requirements to read the files carefully. Adopted authorities are not honored when accessing the source physical file's data. In addition, scheduled updates run under the user profile that owns the index. See the update stored procedure documentation for information on the authority requirements to indexed objects.

Examples

Add an object set to MYCOLLECTION to index the multi-member source physical file QCSRC in library ISVSQLLP:
> CALL MYCOLLECTION.ADD_SRCPF_OBJECT_SET('ISVSQLLP','QCSRC');
Add an object set to MYCOLLECTION to index the multiple members source physical file QCSRC in a library ISVSQLLP, and expect to get the setid.
> create variable setid int default 0;
> CALL MYCOLLECTION.ADD_SRCPF_OBJECT_SET('ISVSQLLP','QCSRC',setid);
Add an object set to MYCOLLECTION to index all the multi-member source physical files library ISVSQLLP:
> CALL MYCOLLECTION.ADD_SRCPF_OBJECT_SET('ISVSQLLP','*ALLSRCPF');

To add source physical file object set to a collection from IBM® Navigator for i, follow these steps.

  1. From IBM Navigator for i, expand IBM i Management > System > All Tasks >OmniFind > Collection List.
  2. Right click the collection and select Properties. On the Object tab, press pull-down menu, choose Add Source physical file, then press ADD.