Skip to main content

Search for a string in IFS using SQL - IBM i

Search for a string in IFS

IFS (Integrated File System) Stream files are major part of any (or most of) IBM i applications. 

Sometimes it becomes essential to scan through the IFS directory to identify the stream files with particular string. 

We can do this from SQL by writing a simple function using functions* IFS_OBJECT_STATISTICS (to retrieve the stream files present in directory) and IFS_READ (to read through the stream file and query for a specific string). Click on each of these functions to know more. 

Let's have a look at how new function (SCAN_IFS_FOR_STRING) returns the search results. 

Scan IFS directory for a string

Function 'SCAN_IFS_FOR_STRING' accepts two parameters.
  1. Input IFS Directory - IFS Directory that is to be scanned. Please note that all the Sub directories would be scanned as well.
  2. Scan String - String that is to be scanned for.
This query should return the stream files that contains the scan string in the specified Input directory. 

Scan for a string in IFS using SQL

This function returns three columns.
  • STMF_NAME - Stream file name (with full path) 
  • LINE_NUMBER - Line number with in stream file where the string is found. 
  • LINE - Line from the stream file where the the string is found. 
Below is the source for the function 'SCAN_IFS_FOR_STRING', same can be found in the Git Hub Repository

Scan for a string in IFS using SQL Functions - IBM i

Below is the brief description on what the above function would do.
  • Lines 5 - 7: Create (or Replace) function with two Input parameters (Input IFS directory & Scan string).
  • Lines 9 - 11: Format of the data to be returned. Scan results would be returned in three columns (Stream file name, Line number and Line).
  • Lines 19-22: Create (or Replace) temporary table with the three columns to be returned and to clear the data from the temporary table if the table already exist.
  • Lines 27-30: Retrieve the list of stream files present in the Input directory using 'IFS_OBJECT_STATISTICS' by passing Input directory and Object type as '*ALLSTMF' and to repeat the loop for all the files present.
  • Lines 34-38: Read stream files using function IFS_READ and select the records with only matching records by specifying where condition on LINE. Using UPPER() for both LINE and Scan string would convert the string to upper case for comparison and returns the matching records.
  • Line 43: Return the contents of temporary table.

*SQL Functions IFS_OBJECT_STATISTICS and IFS_READ are only supported since IBM i 7.3 (TR9) and 7.4 (TR3).

If you have any Suggestions or Feedback, Please leave a comment below or use Contact Form.


Popular posts from this blog

All about READ in RPGLE & Why we use it with SETLL/SETGT?

READ READ is one of the most used Opcodes in RPGLE. As the name suggests main purpose of this Opcode is to read a record from Database file. What are the different READ Opcodes? To list, Below are the five Opcodes.  READ - Read a Record READC - Read Next Changed Record READE - Read Equal Key Record READP - Read Prior Record READPE - Read Prior Equal Record We will see more about each of these later in this article. Before that, We will see a bit about SETLL/SETGT .  SETLL (Set Lower Limit) SETLL accepts Key Fields or Relative Record Number (RRN) as Search Arguments and positions the file at the Corresponding Record (or Next Record if exact match isn't found).  SETGT (Set Greater Than) SETGT accepts Key Fields or Relative Record Number (RRN) as Search Arguments and positions the file at the Next Record (Greater Than the Key value). Syntax: SETLL SEARCH-ARGUMENTS/KEYFIELDS FILENAME SETGT  SEARCH-ARGUMENTS/KEYFIELDS FILENAME One of the below can be passed as Search Arguments. Key Fiel

What we need to know about CHAIN (RPGLE) & How is it different from READ?

CHAIN READ & CHAIN, These are one of the most used (& useful) Opcodes by any RPG developer. These Opcodes are used to read a record from file. So, What's the difference between CHAIN & READ?   CHAIN operation retrieves a record based on the Key specified. It's more like Retrieving Random record from a Database file based on the Key fields.  READ operation reads the record currently pointed to from a Database file. There are multiple Opcodes that start with READ and all are used to read a record but with slight difference. We will see more about different Opcodes and How they are different from each other (and CHAIN) in another article. Few differences to note.  CHAIN requires Key fields to read a record where as READ would read the record currently pointed to (SETLL or SETGT are used to point a Record).  If there are multiple records with the same Key data, CHAIN would return the same record every time. READE can be used to read all the records with the specified Ke

Extract a portion of a Date/Time/Timestamp in RPGLE - IBM i

%SUBDT Extracting Year, Month, Day, Hour, Minutes, Seconds or Milli seconds of a given Date/Time/Timestamp is required most of the times.  This can be extracted easily by using %SUBDT. BIF name looks more similar to %SUBST which is used to extract a portion of string by passing from and two positions of the original string. Instead, We would need to pass a value (i.e., Date, Time or Timestamp ) and Unit (i.e., *YEARS, *MONTHS, *DAYS, *HOURS, *MINUTES, *SECONDS or *MSECONDS) to %SUBDT.  Valid unit should be passed for the type of the value passed. Below are the valid values for each type. Date - *DAYS, *MONTHS, *YEARS Time - *HOURS, *MINUTES, *SECONDS Timestamp - *DAYS, *MONTHS, *YEARS, *HOURS, *MINUTES, *SECONDS, *MSECONDS Syntax: %SUBDT(value : unit { : digits { : decpos} }) Value and Unit are the mandatory arguments.  Digits and Decimal positions are optional and can only be used with *SECONDS for Timestamp. We can either pass the full form for the unit or use the short form. Below i