biyuhao commented on a change in pull request #18251:
URL: https://github.com/apache/flink/pull/18251#discussion_r777551368
##########
File path: docs/data/sql_functions.yml
##########
@@ -357,8 +357,10 @@ string:
description: Returns the reversed string. Returns NULL if string is NULL.
- sql: SPLIT_INDEX(string1, string2, integer1)
description: Splits string1 by the delimiter string2, returns the
integerth (zero-based) string of the split strings. Returns NULL if integer is
negative. Returns NULL if any of arguments is NULL.
- - sql: STR_TO_MAP(string1[, string2, string3]])
- description: Returns a map after splitting the string1 into key/value
pairs using delimiters. string2 is the pair delimiter, default is ','. And
string3 is the key-value delimiter, default is '='.
+ - sql: STR_TO_MAP(string1[, string2, string3])
+ description: |
+ Returns a map after splitting the string1 into key/value pairs using
delimiters. string2 is the pair delimiter, default is ','. And string3 is the
key-value delimiter, default is '='.
+ Both pair delimiter and key-value delimiter are treated as regular
expressions.
Review comment:
Sure it would be helpful to mention it since this is a user-oriented
document.
I got the full list of the so-called metacharacters from [ORACLE The Java
Tutorials](https://docs.oracle.com/javase/tutorial/essential/regex/literals.html),
and what about the following description:
>Both pair delimiter and key-value delimiter are treated as regular
expressions. So special characters (e.g. `<([{\^-=$!|]})?*+.>`) need to be
properly escaped before using as a delimiter literally.
English is not my native language, any suggestions would be appreciated~
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
