Updated on 2024-10-14 GMT+08:00

Pattern Matching Operators

The database provides three independent methods for implementing pattern matching: SQL LIKE operator, SIMILAR TO operator, and POSIX-style regular expressions. Besides these basic operators, functions can be used to extract or replace matching substrings and to split a string at matching locations.

  • LIKE

    Description: Specifies whether the string matches the pattern string following LIKE. The LIKE expression returns true if the string matches the supplied pattern. (As expected, the NOT LIKE expression returns false if LIKE returns true, and vice versa.)

    Matching rules:
    1. This operator can succeed only when its pattern matches the entire string. If you want to match a sequence in any position within the string, the pattern must begin and end with a percent sign.
    2. The underscore (_) represents (matching) any single character. Percentage (%) indicates the wildcard character of any string.
    3. To match a literal underscore or percent sign, the respective character in pattern must be preceded by the escape character. The default escape character is one backslash but a different one can be selected by using the ESCAPE clause.
    4. To match with escape characters, enter two escape characters. For example, to write a pattern constant containing a backslash (\), you need to enter two backslashes in SQL statements.

      When standard_conforming_strings is set to off, any backslashes you write in literal string constants will need to be doubled. Therefore, writing a pattern matching a single backslash is actually going to write four backslashes in the statement. You can avoid this by selecting a different escape character by using ESCAPE, so that the backslash is no longer a special character of LIKE. But the backslash is still the special character of the character text analyzer, so you still need two backslashes. You can also select no escape character by writing ESCAPE ''. This effectively disables the escape mechanism, but it does not eliminate the special meaning of underscore and percent signs in the pattern.

    5. The keyword ILIKE can be used instead of LIKE to make the match case-insensitive.
    6. Operator ~~ is equivalent to LIKE, and operator ~~* corresponds to ILIKE.

    Example:

    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' LIKE 'abc' AS RESULT;
     result
    -----------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' LIKE 'a%' AS RESULT;
     result
    -----------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' LIKE '_b_' AS RESULT;
     result
    -----------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' LIKE 'c' AS RESULT;
     result
    -----------
     f
    (1 row)
    
  • SIMILAR TO

    Description: Returns true or false depending on whether the pattern matches the given string. It is similar to LIKE, but differs in that SIMILAR TO uses the regular expression understanding pattern defined by the SQL standard.

    Matching rules:
    1. Similar to LIKE, this operator succeeds only when its pattern matches the entire string. If you want to match a sequence in any position within the string, the pattern must begin and end with a percent sign.
    2. The underscore (_) represents (matching) any single character. Percentage (%) indicates the wildcard character of any string.
    3. SIMILAR TO supports these pattern-matching metacharacters borrowed from POSIX-style regular expressions:

      Metacharacter

      Description

      |

      Specifies alternation (either of two alternatives).

      *

      Specifies repetition of the previous item zero or more times.

      +

      Specifies repetition of the previous item one or more times.

      ?

      Specifies repetition of the previous item zero or one time.

      {m}

      Specifies repetition of the previous item exactly m times.

      {m,}

      Specifies repetition of the previous item m or more times.

      {m,n}

      Specifies repetition of the previous item at least m times and does not exceed n times.

      ()

      Specifies that parentheses () can be used to group items into a single logical item.

      [...]

      Specifies a character class, just as in POSIX-style regular expressions.

    4. A preamble escape character disables the special meaning of any of these metacharacters. The rules for using escape characters are the same as those for LIKE.

    Regular expressions:

    The substring(stringfrompatternforescape) function extracts a substring that matches an SQL regular expression pattern.

    Example:

    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' SIMILAR TO 'abc' AS RESULT;
     result
    -----------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' SIMILAR TO 'a' AS RESULT;
     result
    -----------
     f
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' SIMILAR TO '%(b|d)%' AS RESULT;
     result
    -----------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' SIMILAR TO '(b|c)%'  AS RESULT;
     result
    -----------
     f
    (1 row)
    
  • POSIX-style regular expressions

    Description: A regular expression is a character sequence that is an abbreviated definition of a set of strings (a regular set). If a string is a member of a regular expression described by a regular expression, the string matches the regular expression. POSIX-style regular expressions provide a more powerful means for pattern matching than the LIKE and SIMILAR TO operators. Table 1 Regular expression match operators lists all available operators for pattern matching using POSIX-style regular expressions.

    Table 1 Regular expression match operators

    Operator

    Description

    Example

    ~

    Matches a regular expression, which is case-sensitive.

    'thomas' ~ '.*thomas.*'

    ~*

    Matches a regular expression, which is case-insensitive.

    'thomas' ~* '.*Thomas.*'

    ! ~

    Does not match a regular expression, which is case-sensitive.

    'thomas' !~ '.*Thomas.*'

    ! ~*

    Does not match a regular expression, which is case-insensitive.

    'thomas' !~* '.*vadim.*'

    Matching rules:
    1. Unlike LIKE patterns, a regular expression is allowed to match anywhere within a string, unless the regular expression is explicitly anchored to the beginning or end of the string.
    2. Besides the metacharacters mentioned above, POSIX-style regular expressions also support the following pattern matching metacharacters:

      Metacharacter

      Description

      ^

      Specifies the match starting with a string.

      $

      Specifies the match at the end of a string.

      .

      Matches any single character.

    Regular expressions:

    POSIX-style regular expressions support the following functions:

    Example:

    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' ~ 'Abc' AS RESULT;
    result 
    --------
     f
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' ~* 'Abc' AS RESULT;
     result 
    --------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' !~ 'Abc' AS RESULT;
     result 
    --------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc'!~* 'Abc' AS RESULT;
     result 
    --------
     f
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' ~ '^a' AS RESULT;
     result 
    --------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' ~ '(b|d)'AS RESULT;
     result 
    --------
     t
    (1 row)
    
    1
    2
    3
    4
    5
    openGauss=# SELECT 'abc' ~ '^(b|c)'AS RESULT;
     result 
    --------
     f
    (1 row)
    

    Although most regular expression searches can be executed quickly, regular expressions can still be artificially made up of memory that takes a long time and any amount of memory. It is not recommended that you accept the regular expression search pattern from the non-security pattern source. If you must do this, you are advised to add the statement timeout limit. The search with the SIMILAR TO pattern has the same security risks as the SIMILAR TO provides many capabilities that are the same as those of the POSIX-style regular expression. The LIKE search is much simpler than the other two options. Therefore, it is more secure to accept the non-secure pattern source search.