IndexOf (PQL)
Returns a the position of a string in a given string.
- Returned Output: Numeric
- Library: PQL \ Granular \ String
- Version: 2023.00.000
- Compatibility: Pyramid Query Language (PQL) data sources
Syntax
IndexOf( <Column String> , <Search Text> )
* Click on the function's arguments above for more details on the input values.
Comments
- The column needs to be an attribute with string / text values in the model. (The data type needs to be 'string')
- The search text should be a string in double quotes.
- The function returns the FIRST index of the search string. If the function cannot find the string, it returns the value "-1"
- For details on how to employ and use this function see the custom column overview.
Different Function types
- This function is similar to the PQL semantic and common functions of the same name. However, it operates on a column directly at the grain.
- As a granular function, it is used in the base SQL query itself.
Examples
This example returns a column of index positions if the firstname column contains with the string "a".
IndexOf([customers].[FirstName],"A")
You can see the effect from this example snippet in column #7 below, based on the source column in positions #1.