Member List (MBRLIST) UDTF

Index

Schema IQUERY

MBRLIST( library_name => '*LIBL', 
         file_name => 'file-name', 
         mbr => 'member0name'
         mbr_text=> 'member-text' )

The Member List (MBRLIST) User Defined Table Function returns one row for each member name that matches the input criteria. It is intended as an alternative interface to the DSPFD TYPE(*MBRLIST) CL command. To that end, the resulting column names match those from DSPFD OUTPUT(*OUTFILE) TYPE(*MBRLIST) for the most part. Not all values returned by DSPFD are returned and the Member Creation and Last Date/Time Changed values are returned as actual timestamp data-types. The MBRLIST UDTF uses the System Partition interface to produce the list of member names; it does not actually use DSPFD. The MBRLIST UDTF is an alternative to using DSPFD, so instead of dumping the output from DSPFD into an output file and then reading it using SQL in your RPG IV application, you can simply evoke the MBRLIST UDTF and directly get the results you need--no output file necessary.

Parameters

LIBRARY_NAME

Default: *LIBL

Special Values: *ALL, *LIBL, *CURLIB, *CURRENT

The library name of the file whose members are to be returned. The Library Name may be generic (using either the asterisk or the percent symbol) as in 'OE*' or 'INV%'. If unspecified, *LIBL is used. The special values *ALL, *ALLUSR, *LIBL, and *CURLIB (or *CURRENT) may be specified to control which set of libraries are searched. 

FILE_NAME

Special Values: *ALL, *

The name of the file whose members are to be listed. This is a required parameter. This name may be generic, full or unspecified to indicate all files with members that match the member criteria are returned. Note it can take a long time to return all member names in all files, so choose wisely. If this parameter is not specified or is set to '*' the File name is not used to filter the member list.

MBR

Default: *

Special Values: *ALL, *

The name of the member(s) that are returned. This is usually either unspecified, a full name, or a partial name using the generic name notation (iQuery supports % and * as generic symbols on input parameters. If this parameter is not specified or is set to '*' or '*ALL' then the member name is not used to filter the member list.

MBR_TEXT

Default: *

The text to be used to filter the returned member list. Only member names that match the MBR_TEXT value are returned. Generic support is enabled via the SQL LIKE predicate. Any pattern supported by LIKE is allowed. If this parameter is not specified, or is set to a single asterisk, then the Member's text description is not used to filter the member list.

SRCONLY

Default: *NO

Use this parameter to restrict the search and results to Source Files Only. *YES, or 1 means Source Files Only, '0' or *NO means all files. Typically this parameter is unnecessary because users tend to specify the file name, such as "QRPGLESRC" when doing the member list. However, if a Member name search is being performed or yours shop uses unconventional source file names, then specifying SRCONLY =>'1' may be useful to optimize the search. The special values for *YES are, '1', '*TRUE', '*SI', '*ONLY', '*DA' the leading asterisk is optional. Any other value implies *NO.

Examples

select mlLib,mlFile,mlname,mlseu,mlmtxt 
   FROM TABLE( iQuery.MBRLIST( file_name=>>'QRPGLESRC', mbr=>'ORD*')) ml;

select * from table(iQuery.mbrlist(file_name=>'*all', library_name=>'DEVLIB', mbr=>'ORD%', srconly=>'true')) mbrlist;

The first example returns a list of members whose name begins with 'ORD' for the QRPGLESRC source file. All QRPGLESRC files on the library list are searched and returned.

The second example searches for all source member whose name begins with 'ORD'. The file name is specified as *ALL but a single asterisk is also valid to indicate all file names, so all files on the library list are searched. However, the SRCONLY (source file only) parameter is set to TRUE, so only source files are actually searched; standard database files are not included in the search for matching member names.

ResultSet Columns