SubString (PQL)

Returns a result string by extracting the characters between the two specified positions of a given string. 

  • Returned Output: Text
  • Library: PQL \ Granular \ String
  • Version: 2023.00.000
  • Compatibility: Pyramid Query Language (PQL) data sources

Syntax

SubString( <Column String> , <Start Integer> , <End Integer> )

* 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')
  • 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 with the 3 characters starting from position 2 of each string / text item in the FirstName column.

SubString( [Customer].[FirstName],2,3 )

You can see the effect from this example snippet in column #6, based on the source column in position #1.