Home
Function Reference
1010data Insights Platform offers a rich set of functions that may be used in value expressions when creating computed columns and in selection expressions when performing row selections.
String functions
String functions are vector functions that manipulate vectors of strings to provide information about a string or substring, concatenate and split strings, or transform strings based on specified criteria.
Comparison
rm(X;Y)
Returns a boolean value indicating whether a given string matches a standard regular expression. (Available as of version 12.33)

Function Reference
1010data Insights Platform offers a rich set of functions that may be used in value expressions when creating computed columns and in selection expressions when performing row selections.
- All 1010data Functions
  1010data provides a whole range of functions that can provide information and act on your data.
- Time/Date functions
  The time/date functions are vector functions that operate on columns containing time-related data and return specific information about the date/time for each row.
- Group functions (g_functions)
  Group functions, or g_functions, are used to perform operations, such as summarizations, on rows that have the same values in a set of given columns.
- Math functions
  Math functions are vector functions that perform mathematical operations on one or more columns and return a column of results based on the operation.
- Matrix functions
- Categorization functions
  Categorization functions are vector functions that organize data and determine logical groupings. These functions can be used for conditionalizing results and/or bucketing value ranges.
- String functions
  String functions are vector functions that manipulate vectors of strings to provide information about a string or substring, concatenate and split strings, or transform strings based on specified criteria.
  - Length
  - Position
  - Case
  - Substrings
  - Concatenation
  - Comparison
    - beginswith(X;L)
      Returns a boolean value indicating whether a given string begins with any of the substrings in a given list.
    - beginswith_ci(X;L)
      Returns a boolean value indicating whether a given string begins with any of the substrings in a given list and is case insensitive. (Available as of version 12.33)
    - between(X;Y;Z)
      Returns a boolean value indicating whether a given value is between two other values.
    - between_ci(X;Y;Z)
      Returns a boolean value indicating whether a given value is between two other values and is case insensitive. (Available as of version 12.34)
    - bstrclean(X)
      Returns a boolean value indicating whether the given string is plain (7-bit) ASCII (i.e., "8-bit clean").
    - contains(X;L)
      Returns a boolean value indicating whether a given string contains any of the substrings in a given list.
    - contains_ci(X;L)
      Returns a boolean value indicating whether a given string contains any of the substrings in a given list and is case insensitive. (Available as of version 12.33)
    - edistnorm(X;Y)
      Returns the normalized Levenshtein edit distance between two given strings.
    - editdist(X;Y)
      Returns the Levenshtein edit distance between two given strings.
    - endswith(X;L)
      Returns a boolean value indicating whether a given string ends with any of the substrings in a given list.
    - endswith_ci(X;L)
      Returns a boolean value indicating whether a given string ends with any of the substrings in a given list and is case insensitive. (Available as of version 12.33)
    - eq_ci(X;Y)
      Returns a boolean value indicating whether the value of the first argument is equal to the second and is case insensitive. (Available as of version 12.34)
    - eqlin_ci(X;Y)
      Returns a boolean value indicating whether the value of the first argument is equal to (one of the values of) the second and is case insensitive. (Available as of version 12.34)
    - gt_ci(X;Y)
      Returns a boolean value indicating whether the value of the first argument is greater than the value of the second argument and is case insensitive. (Available as of version 12.34)
    - lt_ci(X;Y)
      Returns a boolean value indicating whether the value of the first argument is less than the value of the second argument and is case insensitive. (Available as of version 12.34)
    - rm(X;Y)
      Returns a boolean value indicating whether a given string matches a standard regular expression. (Available as of version 12.33)
    - rm_ci(X;Y)
      Returns a boolean value indicating whether a given string matches a standard regular expression and is case insensitive. (Available as of version 12.33)
    - sm(X;Y)
      Returns a boolean value indicating whether a given string matches a particular template, and is case sensitive.
    - sm_ci(X;Y)
      Returns a boolean value indicating whether a given string matches a particular template and is case insensitive. (Available as of version 12.33)
    - strclean(X)
      Returns a boolean value indicating whether the given string is a legal UTF-8 (Unicode) string.
    - strcmp(X;Y;B)
      Returns an integer value that indicates the results of comparing two strings.
    - strfollow(X;Y;B)
      Returns the first position where two strings differ from one another, or 0 if they are equal.
  - Transformations
  - Regular expressions
- List functions
  List functions are scalar functions that return lists, subsets of lists, and combinations of lists, among other functionality. Lists, along with packages, are compound scalar data types that facilitate programmatic interaction with scalar data values and variables.
- Data-handling functions
  Data-handling functions are vector functions that return a hash value based on an input column or columns.
- Row functions
  Row functions are vector functions that return computational outputs for row inputs, as opposed to column outputs. Row inputs are defined as a space- or comma-separated list of column names.
- SQL compatibility functions
  SQL compatibility functions are functions that treat null values as SQL nulls.
- Financial functions
- System functions
  System functions are special functions in 1010data that return information about users, tables, and other system objects.
- Object functions
  The object functions can be used to check the existence, type, and accessibility of objects such as folders, tables, and queries on the 1010data Insights Platform.
- Miscellaneous functions
  This category of functions contains special functions that don't neatly fit into other categories of functions.

`rm(X;Y)`

Returns a boolean value indicating whether a given string matches a standard regular expression. (Available as of version 12.33)

Syntax

rm(X;Y)

Input

Argument	Type	Description
`X`	text	The string on which to apply the function A scalar value or the name of a column
`Y`	text	A regular expression with which to compare string `X`.

Return Value

Returns an integer value of 1 if X matches the regular expression Y. Otherwise, returns 0.

If X is N/A, the result is 0.

Sample Usage


`value`	`regular expression`	`rm(value;regular expression)`
'abcdefg'	'a(b\|c\|d)'	1
'abcdefg'	'A(b\|c\|d)'	0
'aefg'	'a(b\|c\|d)'	0

Example

In the "Monthly Statewide Seasonally Adjusted Unemployment Statistics" table (pub.fin.fred2.bls.smsa), you can find only those rows whose state abbreviations begin with the letter "N". To do this, create a computed column and apply the rm(X;Y) function to the state column, and specify "N?" as the pattern to match.

<base table="pub.fin.fred2.bls.smsa"/>
<willbe name="example" value="rm(state;'N?')" 
 label="States Beginning`With N"/>
<colord cols="state,example"/>

For those values in the state column that begin with "N", the result is 1. Otherwise, the result is 0.

Additional Information

rm(X;Y) is similar to sm(X;Y), except that in this function, Y is a regular expression, not a wildcard-containing pattern.
rm(X;Y) is equivalent to regex_count(Y;'pcre''first';X)>0.
This function does not work with Unicode (UTF-8) strings.
For a Unicode-compliant alternative, consider regex_match(X;L;Y;I).