16.20 - REGEXP_SPLIT_TO_TABLE - Teradata Vantage NewSQL Engine

Teradata Vantageā„¢ SQL Functions, Expressions, and Predicates

prodname
Teradata Database
Teradata Vantage NewSQL Engine
vrm_release
16.20
category
Programming Reference
featnum
B035-1145-162K

Purpose

Splits source_string into a table of strings using regexp_string as the delimiter.

Syntax



TD_SYSFNLIB.
Name of the database where the function is located.
inkey
A numeric or character argument that uniquely identifies the source_string in the output result set.
If the inkey is NULL, an empty string is returned.
source_string
A character argument.
If source_string is NULL, 0 rows are returned. Zero rows are also returned if the source_string is the empty string.
regexp_string
A character argument.
If regexp_string is NULL, the original source_string is returned.
match_arg

A character argument.

Valid values are:
  • 'i' = case-insensitive matching.
  • 'c' = case sensitive matching.
  • 'n' = the period character (match any character) can match the newline character.
  • 'm' = source_string is treated as multiple lines instead of as a single line. With this option, the '^' and '$' characters apply to each line in source_string instead of the entire source_string.
  • 'l' = if source_string exceeds the current maximum allowed source_string size (currently 16 MB), a NULL is returned instead of an error. This is useful for long-running queries where you do not want long strings causing an error that would make the query fail. Although the maximum source_string size is 16 MB, the resulting token can only be VARCHAR, and has a maximum return token size of 64000 bytes.
If match_arg is not specified, an error is returned.
If there is no match, the original source_string is returned.
outkey
The value of inkey.
token_ndx
The ordinal position of the token in the input string.
token
A character argument.
The token from the input string in the same character set as instring.
REGEXP_SPLIT_TO_TABLE does not support the output type of CLOB in the token section.