[BP-1.17][FLINK-32706][table] Add built-in SPLIT_STRING function #23177
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
This is an implementation of SPLIT
Brief change log
Splits a string into an array of substrings based on a delimiter. If the delimiter is not found, then the original string is returned as the only element in the array. If the delimiter is empty, then all characters in the string are split. If either, string or delimiter, are NULL, then a NULL value is returned.
If the delimiter is found at the beginning or end of the string, or there are contiguous delimiters, then an empty space is added to the array.
Syntax
SPLIT(string, delimiter)Arguments
string: The string need to be split
delimiter: Splits a string into an array of substrings based on a delimiter
Returns
If the delimiter is not found, then the original string is returned as the only element in the array. If the delimiter is empty, then all characters in the string are split. If either, string or delimiter, are NULL, then a NULL value is returned.
Examples
ksqlDB Split function
ksqlDB provides a scalar function named SPLIT which splits a string into an array of substrings based on a delimiter.
Syntax: SPLIT(string, delimiter)
For example: SPLIT('a,b,c', ',') will return ['a', 'b', 'c'].
https://docs.ksqldb.io/en/0.8.1-ksqldb/developer-guide/ksqldb-reference/scalar-functions/#split
Apache Hive Split function
Hive offers a function named split which splits a string around a specified delimiter and returns an array of strings.
Syntax: array split(string str, string pat)
For example: split('a,b,c', ',') will return ["a", "b", "c"].
https://cwiki.apache.org/confluence/display/Hive/LanguageManual+UDF
Spark SQL Split function
Spark SQL also offers a function named split, similar to the one in Hive.
Syntax: split(str, pattern[, limit])
Here, limit is an optional parameter to specify the maximum length of the returned array.
For example: split('oneAtwoBthreeC', '[ABC]', 2) will return ["one", "twoBthreeC"].
https://spark.apache.org/docs/latest/api/sql/index.html#split
Presto Split function
Presto offers a function named split which splits a string around a regular expression and returns an array of strings.
Syntax: array split(string str, string regex)
For example: split('a.b.c', '.') will return ["a", "b", "c"].
https://prestodb.io/docs/current/functions/string.html
Verifying this change
This change added tests in CollectionFunctionsITCase.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (yes / no)Documentation