Argument Types and Rules - Analytics Database - Teradata Vantage

SQL Functions, Expressions, and Predicates

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2024-01-12
dita:mapPath
obm1628111499646.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
kby1472250656485
lifecycle
latest
Product Category
Teradata Vantageā„¢
Expressions passed to this function must have the following data types:
  • source_string = CHAR, VARCHAR, or CLOB
  • regexp_string = CHAR or VARCHAR
  • replace_string = CHAR, VARCHAR CLOB
  • position_arg = NUMBER
  • occurrence_arg = NUMBER
  • match_arg = VARCHAR
The source_string maximum size is:
  • For parameters that are Latin CHAR or VARCHAR, the maximum source size is 32000 bytes.
  • For parameters that are Unicode CHAR or VARCHAR, the maximum source size is 64000 bytes.
  • For parameters that are Latin or Unicode CLOBs, the maximum source size is 16 MB.
The regexp_string maximum pattern string size is:
  • For parameters that are Latin CHAR or VARCHAR, the maximum regexp_string size is 16000 bytes.
  • For parameters that are Unicode CHAR or VARCHAR, the maximum regexp_string size is 16000 bytes.
  • For parameters that are Latin or Unicode CLOBs, the maximum regexp_string size is 30000 bytes.
The maximum replace string size is:
  • For parameters that are Latin CHAR or VARCHAR, the maximum replace string size is 16000 bytes.
  • For parameters that are Unicode CHAR or VARCHAR, the maximum replace string size is 16000 bytes.
  • For parameters that are Latin or Unicode CLOBs, the maximum replace string size is 30000 bytes.
The maximum return string size is:
  • For parameters that are Latin CHAR or VARCHAR, the maximum return string size is 16000 bytes.
  • For parameters that are Unicode CHAR or VARCHAR, the maximum return string size is 16000 bytes.
  • For parameters that are Latin or Unicode CLOBs, the maximum return string size is 16 MB.

The function returns an error if this size is exceeded unless match_arg = 'l', in which case, it returns the original string.

If position_arg is omitted, the default value (1) is used.

The maximum backreference number in a replace string is 9 (for example, \9). Any backreference in the replace string that is higher than 9 is not considered a backreference.

The x match option ignores whitespace characters in the pattern/regexp_string. By default, whitespace characters match themselves.

You can also pass arguments with data types that can be converted to the preceding types using the implicit data type conversion rules that apply to UDFs.

The UDF implicit type conversion rules are more restrictive than the implicit type conversion rules normally used by Vantage. If an argument cannot be converted to the required data type following the UDF implicit conversion rules, it must be explicitly cast.