Regular Expression Functions

Regular expression functions use RE2 as the regex engine. RE2 is fast, but supports only a subset of PCRE syntax and in particular does not support backtracking and associated features (e.g. back references). Java and RE2 regex output can diverage and users should be cautious that the patterns they are using perform similarly between RE2 and Java. For example, character class unions, intersections, and differences ([a[b]], [a&&[b]], [a&&[^b]]) are intepreted as a single character class that contain [, &, and ^ rather than union, intersection, or difference of the character classes.

See https://github.com/google/re2/wiki/Syntax for more information.

like(string, pattern) → boolean
like(string, pattern, escape) → boolean

Evaluates if the string matches the pattern. Patterns can contain regular characters as well as wildcards. Wildcard characters can be escaped using the single character specified for the escape parameter. Only ASCII characters are supported for the escape parameter. Matching is case sensitive.

Note: The wildcard ‘%’ represents 0, 1 or multiple characters and the wildcard ‘_’ represents exactly one character.

Note: Each function instance allow for a maximum of expression.max_compiled_regexes (default 100) regular expressions to be compiled per thread of execution. Not all patterns require compilation of regular expressions. Patterns ‘hello’, ‘hello%’, ‘_hello__%’, ‘%hello’, ‘%__hello_’, ‘%hello%’, where ‘hello’, ‘velox’ contains only regular characters and ‘_’ wildcards are evaluated without using regular expressions. Only those patterns that require the compilation of regular expressions are counted towards the limit.

SELECT like(‘abc’, ‘%b%’); – true SELECT like(‘a_c’, ‘%#_%’, ‘#’); – true

regexp_extract(string, pattern) → varchar

Returns the first substring matched by the regular expression pattern in string.

regexp_extract does not support column references for the pattern argument. Patterns must be constant values.

SELECT regexp_extract('1a 2b 14m', '\d+'); -- 1
regexp_extract(string, pattern, group) → varchar

Finds the first occurrence of the regular expression pattern in string and returns the capturing group number group.

regexp_extract does not support column references for the pattern argument. Patterns must be constant values.

SELECT regexp_extract('1a 2b 14m', '(\d+)([a-z]+)', 2); -- 'a'
regexp_extract_all(string, pattern) → array(varchar):

Returns the substring(s) matched by the regular expression pattern in string:

SELECT regexp_extract_all('1a 2b 14m', '\d+'); -- [1, 2, 14]
regexp_extract_all(string, pattern, group) → array(varchar):

Finds all occurrences of the regular expression pattern in string and returns the capturing group number group:

SELECT regexp_extract_all('1a 2b 14m', '(\d+)([a-z]+)', 2); -- ['a', 'b', 'm']
rlike(string, pattern) → boolean

Evaluates the regular expression pattern and determines if it is contained within string.

This function is similar to the LIKE operator, except that the pattern only needs to be contained within string, rather than needing to match all of string. In other words, this performs a contains operation rather than a match operation. You can match the entire string by anchoring the pattern using ^ and $.

rlike does not support column references for the pattern argument. Patterns must be constant values.

SELECT rlike('1a 2b 14m', '\d+b'); -- true
regexp_replace(string, pattern, overwrite) → varchar

Replaces all substrings in string that match the regular expression pattern with the string overwrite. If no match is found, the original string is returned as is. There is a limit to the number of unique regexes to be compiled per function call, which is 20. If this limit is exceeded the function will throw an exception. Capturing groups can be referenced in replacement using $g for a numbered group or ${name} for a named group. A dollar sign ($) may be included in the replacement by escaping it with a backslash (\$). If a backslash(\) is followed by any character other than a digit or another backslash(\) in the replacement, the preceding backslash(\) will be ignored.

Parameters:

  • string: The string to be searched.

  • pattern: The regular expression pattern that is searched for in the string.

  • overwrite: The string that replaces the substrings in string that match the pattern.

Examples:

SELECT regexp_replace('Hello, World!', 'l', 'L'); -- 'HeLLo, WorLd!'
SELECT regexp_replace('300-300', '(\\d+)-(\\d+)', '400'); -- '400'
SELECT regexp_replace('300-300', '(\\d+)', '400'); -- '400-400'
SELECT regexp_replace('[{}]', '\}\]', '\}'); -- '[{}'
regexp_replace(string, pattern, overwrite, position) → varchar

Replaces all substrings in string that match the regular expression pattern with the string overwrite starting from the specified position. If no match is found, the original string is returned as is. If the position is less than one, the function throws an exception. If position is greater than the length of string, the function returns the original string without any modifications. There is a limit to the number of unique regexes to be compiled per function call, which is 20. If this limit is exceeded the function will throw an exception. Capturing groups can be referenced in replacement using $g for a numbered group or ${name} for a named group. A dollar sign ($) may be included in the replacement by escaping it with a backslash (\$). If a backslash(\) is followed by any character other than a digit or another backslash(\) in the replacement, the preceding backslash(\) will be ignored.

This function is 1-indexed, meaning the position of the first character is 1. Parameters:

  • string: The string to be searched.

  • pattern: The regular expression pattern that is searched for in the string.

  • overwrite: The string that replaces the substrings in string that match the pattern.

  • position: The position to start from in terms of number of characters. 1 means to start from the beginning of the string. 3 means to start from the 3rd character. Positions less than one, the function will throw an error. If position is greater than the length of string, the function returns the original string without any modifications.

Examples:

SELECT regexp_replace('Hello, World!', 'l', 'L', 6); -- 'Hello, WorLd!'

SELECT regexp_replace('Hello, World!', 'l', 'L', 5); -- 'Hello, World!'

SELECT regexp_replace('Hello, World!', 'l', 'L', 100); -- 'Hello, World!'