Returns |
STARTSWITH function is ideal for matching based on patterns for any data type. If you need to match strings using a fixed number of characters, you should use the LEFT function instead. See LEFT Function.String literal example:
startswith(FullName,'Mr.') |
Output: Returns true if the first three letters of the FullName column value are "Mr.".
example:
startswith(CustId,`{alpha-numeric}{6}`) |
Output: Returns true if the CustId column begins with a six-digit alpha-numeric sequence. Otherwise, the value is set to false.
Regular expression pattern example:
if(startswith(phone,/^(\+0?1\s)?\(?\d{3}\)?[\s.-]\d{3}[\s.-]\d{4}$/),'phone - ok','phone - error') |
Output: Returns phone - ok if the value of the phone column begins with a value that matches a 10-digit U.S. phone number. Otherwise, the output value is set to phone - error.
startswith(column_any,pattern[,ignore_case]) |
| Argument | Required? | Data Type | Description |
|---|---|---|---|
| column_any | Y | any | Name of the column to be applied to the function |
| pattern | Y | string | Pattern or literal expressed as a string describing the pattern to which to match. |
| ignore_case | N | string | When true, matching is case-insensitive. Default is false. |
Name of the column to be searched.
| Required? | Data Type | Example Value |
|---|---|---|
| Yes | Column reference | myColumn |
, regular expression, or string literal to locate in the values in the specified column.
| Required? | Data Type | Example Value |
|---|---|---|
| Yes | String | `{zip}` |
When true, matches are case-insensitive. Default is false.
NOTE: This argument is not required. By default, matches are case-sensitive. |
| Required? | Data Type | Example Value |
|---|---|---|
| No | String value | 'false'
|